diff --git a/.gitignore b/.gitignore index ba31f4c5..091636c0 100644 --- a/.gitignore +++ b/.gitignore @@ -831,6 +831,7 @@ FodyWeavers.xsd !freetype.lib ./docs/_build/ +docs/_build Nuake/dependencies/assimp.vcxproj Nuake/dependencies/assimp.vcxproj.filters DemoModule/DemoModule.vcxproj diff --git a/docs/General/building.rst b/docs/General/building.rst new file mode 100644 index 00000000..7fdfc82a --- /dev/null +++ b/docs/General/building.rst @@ -0,0 +1,15 @@ +How to build +================== +Building Nuake is currently the only supported way to get Nuake. +This means that you will need to build the projects file, build, then launch the project. + +The following step should help you get Nuake running on your computer: + #. Clone the git repo and the submodules recursivly. + This can be done using the following command:: + + git clone --recurse-submodules https://github.com/antopilo/Nuake.git + + #. Launch the cmd file called `generate.bat`. + This should generate a visual studio solution for you. + + #. Build the project, everything should build in the right order and launch the editor. \ No newline at end of file diff --git a/docs/General/contribution.rst b/docs/General/contribution.rst new file mode 100644 index 00000000..061b22db --- /dev/null +++ b/docs/General/contribution.rst @@ -0,0 +1,4 @@ +How do I contribute? +============ +You can simply fork the current github `repository `_ and create pull requests, +I will look over them personally. \ No newline at end of file diff --git a/docs/General/index.rst b/docs/General/index.rst new file mode 100644 index 00000000..93588dbc --- /dev/null +++ b/docs/General/index.rst @@ -0,0 +1,16 @@ +About +===== + +.. toctree:: + :maxdepth: 1 + :name: toc-tutorial + + introduction + building + contribution + + + + + + diff --git a/docs/General/introduction.rst b/docs/General/introduction.rst new file mode 100644 index 00000000..9fa6785b --- /dev/null +++ b/docs/General/introduction.rst @@ -0,0 +1,20 @@ +.. note:: Nuake is a work-in-progress project and is not suited for profesionnal game development. + Use at your own risk. + +Welcome to the offical documentation of Nuake, an open-source 3D game engine! +Nuake is a 3D game engine aimed to create games similar to quake with modern technologies. +The recent resurgence of quake-like games gave me the initial ideas to create an engine designed +to make those types of games. This means that integration of tools like trenchbroom and quake-based tools +will be a priority during the development of Nuake. + + + +What is Nuake? +============ +Nuake is a work-in-progress game engine aimed to give a simple but flexible tool to create quake-type games. + + +What type of game is it for? +============ +You can create any type of game using Nuake, but it is mostly designed to create 3D games. +You should be able to create FPS or TPS games without problems, although it was originally designed to create first person games. \ No newline at end of file diff --git a/docs/Scripting/engine.rst b/docs/Scripting/engine.rst new file mode 100644 index 00000000..c4e5083c --- /dev/null +++ b/docs/Scripting/engine.rst @@ -0,0 +1,3 @@ + +Engine module API +============== diff --git a/docs/Scripting/entity_scripts.rst b/docs/Scripting/entity_scripts.rst new file mode 100644 index 00000000..70493696 --- /dev/null +++ b/docs/Scripting/entity_scripts.rst @@ -0,0 +1,2 @@ +Entity scripts +============== \ No newline at end of file diff --git a/docs/Scripting/index.rst b/docs/Scripting/index.rst new file mode 100644 index 00000000..f60801b6 --- /dev/null +++ b/docs/Scripting/index.rst @@ -0,0 +1,14 @@ + +Scripting +======== + +.. toctree:: + :maxdepth: 1 + :name: toc-scripting + + entity_scripts + interface_scripts + engine + math + scene + diff --git a/docs/Scripting/interface_scripts.rst b/docs/Scripting/interface_scripts.rst new file mode 100644 index 00000000..f55dcc61 --- /dev/null +++ b/docs/Scripting/interface_scripts.rst @@ -0,0 +1,2 @@ +Interface scripts +================= \ No newline at end of file diff --git a/docs/Scripting/math.rst b/docs/Scripting/math.rst new file mode 100644 index 00000000..aca0cbf9 --- /dev/null +++ b/docs/Scripting/math.rst @@ -0,0 +1,2 @@ +Math module API +============== \ No newline at end of file diff --git a/docs/Scripting/scene.rst b/docs/Scripting/scene.rst new file mode 100644 index 00000000..3b6f3010 --- /dev/null +++ b/docs/Scripting/scene.rst @@ -0,0 +1,2 @@ +Scene module API +============== \ No newline at end of file diff --git a/docs/Tutorial/index.rst b/docs/Tutorial/index.rst new file mode 100644 index 00000000..bee15e58 --- /dev/null +++ b/docs/Tutorial/index.rst @@ -0,0 +1,9 @@ +About +===== + +.. toctree:: + :maxdepth: 1 + :name: toc-tutorial + + project + scene diff --git a/docs/Tutorial/project.rst b/docs/Tutorial/project.rst new file mode 100644 index 00000000..9b34b877 --- /dev/null +++ b/docs/Tutorial/project.rst @@ -0,0 +1,2 @@ +Project tutorial +================ \ No newline at end of file diff --git a/docs/Tutorial/scene.rst b/docs/Tutorial/scene.rst new file mode 100644 index 00000000..bbe58154 --- /dev/null +++ b/docs/Tutorial/scene.rst @@ -0,0 +1,2 @@ +Scene tutorial +============== \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 0446be59..ad517cbe 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,15 +7,22 @@ Welcome to Nuake's documentation! ================================= .. toctree:: - :maxdepth: 2 - :caption: Contents: + :maxdepth: 1 + :caption: General + :name: sec-general + General/index +.. toctree:: + :maxdepth: 1 + :caption: Scripting + :name: sec-scripting -Indices and tables -================== + Scripting/index -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` -======= +.. toctree:: + :maxdepth: 1 + :caption: Tutorial + :name: sec-tutorial + + Tutorial/index \ No newline at end of file