mirror of
https://github.com/antopilo/Nuake.git
synced 2026-09-09 20:08:57 +03:00
Added docs
This commit is contained in:
1
.gitignore
vendored
1
.gitignore
vendored
@@ -831,6 +831,7 @@ FodyWeavers.xsd
|
||||
!freetype.lib
|
||||
|
||||
./docs/_build/
|
||||
docs/_build
|
||||
Nuake/dependencies/assimp.vcxproj
|
||||
Nuake/dependencies/assimp.vcxproj.filters
|
||||
DemoModule/DemoModule.vcxproj
|
||||
|
||||
15
docs/General/building.rst
Normal file
15
docs/General/building.rst
Normal file
@@ -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.
|
||||
4
docs/General/contribution.rst
Normal file
4
docs/General/contribution.rst
Normal file
@@ -0,0 +1,4 @@
|
||||
How do I contribute?
|
||||
============
|
||||
You can simply fork the current github `repository <https://github.com/antopilo/Nuake>`_ and create pull requests,
|
||||
I will look over them personally.
|
||||
16
docs/General/index.rst
Normal file
16
docs/General/index.rst
Normal file
@@ -0,0 +1,16 @@
|
||||
About
|
||||
=====
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:name: toc-tutorial
|
||||
|
||||
introduction
|
||||
building
|
||||
contribution
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
20
docs/General/introduction.rst
Normal file
20
docs/General/introduction.rst
Normal file
@@ -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.
|
||||
3
docs/Scripting/engine.rst
Normal file
3
docs/Scripting/engine.rst
Normal file
@@ -0,0 +1,3 @@
|
||||
|
||||
Engine module API
|
||||
==============
|
||||
2
docs/Scripting/entity_scripts.rst
Normal file
2
docs/Scripting/entity_scripts.rst
Normal file
@@ -0,0 +1,2 @@
|
||||
Entity scripts
|
||||
==============
|
||||
14
docs/Scripting/index.rst
Normal file
14
docs/Scripting/index.rst
Normal file
@@ -0,0 +1,14 @@
|
||||
|
||||
Scripting
|
||||
========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:name: toc-scripting
|
||||
|
||||
entity_scripts
|
||||
interface_scripts
|
||||
engine
|
||||
math
|
||||
scene
|
||||
|
||||
2
docs/Scripting/interface_scripts.rst
Normal file
2
docs/Scripting/interface_scripts.rst
Normal file
@@ -0,0 +1,2 @@
|
||||
Interface scripts
|
||||
=================
|
||||
2
docs/Scripting/math.rst
Normal file
2
docs/Scripting/math.rst
Normal file
@@ -0,0 +1,2 @@
|
||||
Math module API
|
||||
==============
|
||||
2
docs/Scripting/scene.rst
Normal file
2
docs/Scripting/scene.rst
Normal file
@@ -0,0 +1,2 @@
|
||||
Scene module API
|
||||
==============
|
||||
9
docs/Tutorial/index.rst
Normal file
9
docs/Tutorial/index.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
About
|
||||
=====
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:name: toc-tutorial
|
||||
|
||||
project
|
||||
scene
|
||||
2
docs/Tutorial/project.rst
Normal file
2
docs/Tutorial/project.rst
Normal file
@@ -0,0 +1,2 @@
|
||||
Project tutorial
|
||||
================
|
||||
2
docs/Tutorial/scene.rst
Normal file
2
docs/Tutorial/scene.rst
Normal file
@@ -0,0 +1,2 @@
|
||||
Scene tutorial
|
||||
==============
|
||||
@@ -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
|
||||
Reference in New Issue
Block a user