2015-12-12 16:58:18 +01:00
|
|
|
|
.. Godot Engine documentation master file, created by
|
|
|
|
|
sphinx-quickstart on Sat Dec 12 16:57:47 2015.
|
|
|
|
|
You can adapt this file completely to your liking, but it should at least
|
|
|
|
|
contain the root `toctree` directive.
|
|
|
|
|
|
2017-04-03 23:20:56 +02:00
|
|
|
|
Godot Docs – *master* branch
|
|
|
|
|
============================
|
|
|
|
|
|
|
|
|
|
.. attention:: This is the documentation for the unstable (master) branch.
|
|
|
|
|
Looking for the documentation of the current **stable** branch?
|
|
|
|
|
`Have a look here <http://docs.godotengine.org/en/stable>`_.
|
|
|
|
|
|
|
|
|
|
Welcome to the official documentation of Godot Engine, the free and open source
|
|
|
|
|
community-driven 2D and 3D game engine! If you are new to this documentation,
|
|
|
|
|
we recommend that you read the :ref:`introduction page <doc_about_intro>` to
|
|
|
|
|
get an overview of what this documentation has to offer.
|
|
|
|
|
|
|
|
|
|
The table of contents below and in the sidebar should let you easily access the
|
|
|
|
|
documentation for your topic of interest. You can also use the search function
|
|
|
|
|
in the top left corner.
|
|
|
|
|
|
|
|
|
|
.. note:: Godot Engine is an open source project developed by a community of
|
2018-05-06 17:49:37 +02:00
|
|
|
|
volunteers. The documentation team can always use your
|
2017-04-03 23:20:56 +02:00
|
|
|
|
feedback and help to improve the tutorials and class reference. If
|
2018-05-06 17:49:37 +02:00
|
|
|
|
you don't understand something, or cannot find what you
|
2017-04-03 23:20:56 +02:00
|
|
|
|
are looking for in the docs, help us make the documentation better
|
|
|
|
|
by letting us know!
|
|
|
|
|
|
|
|
|
|
Submit an issue or pull request on the `GitHub repository
|
2018-05-05 23:17:56 +02:00
|
|
|
|
<https://github.com/godotengine/godot-docs/issues>`_,
|
2018-05-06 17:49:37 +02:00
|
|
|
|
help us `translate the documentation
|
2018-05-05 23:17:56 +02:00
|
|
|
|
<https://hosted.weblate.org/engage/godot-engine/>`_ into your
|
|
|
|
|
language, or discuss with us on either the ``#documentation``
|
|
|
|
|
channel on `Discord <https://discord.gg/zH7NUgz>`_, or the
|
|
|
|
|
``#godotengine-doc`` channel on `irc.freenode.net
|
2018-05-06 17:56:17 +02:00
|
|
|
|
<http://webchat.freenode.net/?channels=#godotengine-doc>`_!
|
2017-04-03 23:20:56 +02:00
|
|
|
|
|
2018-05-05 18:27:41 +02:00
|
|
|
|
.. image:: https://hosted.weblate.org/widgets/godot-engine/-/godot-docs/287x66-white.png
|
|
|
|
|
:alt: Translation state
|
|
|
|
|
:align: center
|
|
|
|
|
:target: https://hosted.weblate.org/engage/godot-engine/?utm_source=widget
|
|
|
|
|
|
2017-04-03 23:20:56 +02:00
|
|
|
|
The main documentation for the site is organized into the following sections:
|
2015-12-12 16:58:18 +01:00
|
|
|
|
|
2015-12-12 17:57:44 +01:00
|
|
|
|
.. toctree::
|
2016-02-06 17:42:13 +01:00
|
|
|
|
:maxdepth: 1
|
2017-03-29 20:18:10 +02:00
|
|
|
|
:caption: General
|
|
|
|
|
:name: sec-general
|
|
|
|
|
|
|
|
|
|
about/index
|
|
|
|
|
|
2016-02-07 22:54:52 +01:00
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
2018-01-24 11:38:34 +01:00
|
|
|
|
:caption: Getting started
|
2017-03-29 20:18:10 +02:00
|
|
|
|
:name: sec-learn
|
|
|
|
|
|
2018-01-24 11:38:34 +01:00
|
|
|
|
getting_started/step_by_step/index
|
|
|
|
|
getting_started/editor/index
|
|
|
|
|
getting_started/scripting/index
|
|
|
|
|
getting_started/workflow/index
|
2017-03-29 20:18:10 +02:00
|
|
|
|
|
|
|
|
|
|
2018-01-24 11:38:34 +01:00
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: Tutorials
|
|
|
|
|
:name: sec-tutorials
|
|
|
|
|
|
|
|
|
|
tutorials/2d/index
|
|
|
|
|
tutorials/3d/index
|
|
|
|
|
tutorials/audio/index
|
|
|
|
|
tutorials/physics/index
|
|
|
|
|
tutorials/math/index
|
|
|
|
|
tutorials/animation/index
|
|
|
|
|
tutorials/inputs/index
|
2018-04-05 05:10:03 +02:00
|
|
|
|
tutorials/io/index
|
|
|
|
|
tutorials/i18n/index
|
2018-01-24 11:38:34 +01:00
|
|
|
|
tutorials/gui/index
|
|
|
|
|
tutorials/viewports/index
|
|
|
|
|
tutorials/shading/index
|
|
|
|
|
tutorials/networking/index
|
|
|
|
|
tutorials/assetlib/index
|
2018-01-26 14:07:48 +01:00
|
|
|
|
tutorials/vr/index
|
2018-01-26 17:29:41 +01:00
|
|
|
|
tutorials/plugins/index
|
2018-01-24 11:38:34 +01:00
|
|
|
|
tutorials/platform/index
|
2018-01-26 14:07:48 +01:00
|
|
|
|
tutorials/misc/index
|
2018-03-20 15:30:04 +01:00
|
|
|
|
tutorials/debug/index
|
2018-01-24 11:38:34 +01:00
|
|
|
|
|
2017-03-29 20:18:10 +02:00
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: Development
|
|
|
|
|
:name: sec-devel
|
|
|
|
|
|
|
|
|
|
development/compiling/index
|
|
|
|
|
development/cpp/index
|
2018-03-09 10:25:59 +01:00
|
|
|
|
development/file_formats/index
|
2016-02-07 22:54:52 +01:00
|
|
|
|
|
2016-02-06 01:54:33 +01:00
|
|
|
|
|
2016-02-07 22:54:52 +01:00
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
2016-02-07 23:49:34 +01:00
|
|
|
|
:caption: Community
|
|
|
|
|
:name: sec-community
|
2016-02-07 22:54:52 +01:00
|
|
|
|
|
2018-01-26 14:07:48 +01:00
|
|
|
|
community/index
|
2017-03-29 20:18:10 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: Class reference
|
|
|
|
|
:name: sec-class-ref
|
|
|
|
|
|
|
|
|
|
classes/index
|
|
|
|
|
|
2016-02-07 22:54:52 +01:00
|
|
|
|
|
2015-12-12 17:57:44 +01:00
|
|
|
|
.. Indices and tables
|
|
|
|
|
.. ------------------
|
2018-01-24 11:38:34 +01:00
|
|
|
|
..
|
2015-12-12 17:57:44 +01:00
|
|
|
|
.. * :ref:`genindex`
|
|
|
|
|
.. * :ref:`modindex`
|
|
|
|
|
.. * :ref:`search`
|