Skip to content
Permalink
master
Switch branches/tags
Go to file
Add missing Navigation category
16 contributors

Users who have contributed to this file

@NathanLovato @akien-mga @Calinou @reduz @Omicron666 @YeldhamDev @mhilbrunner @Dar13 @pycbouh @Xrayez @sdfgeoff @m4gr3d

Godot Docs – master branch

.. only:: not i18n

  .. note:: Godot's documentation is available in various languages and versions.
            Expand the "Read the Docs" panel at the bottom of the sidebar to see
            the list.

.. only:: i18n

  .. note:: This documentation is translated from the `original English one
            <https://docs.godotengine.org/en/latest>`_ by community members
            on `Weblate <https://hosted.weblate.org/projects/godot-engine/godot-docs>`_.

            Depending on the translation effort's completion level, you may
            find paragraphs or whole pages which are still in English. You can
            help the community by providing new translations or reviewing existing
            ones on Weblate.

            For the time being, localized translations are only available for
            the "latest" (development) branch, but should be suitable to learn
            how to use stable Godot releases nevertheless.

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.

To browse the documentation offline, you can use the mirror of the documentation hosted on DevDocs. To enable offline browsing on DevDocs, you need to:

  • Click the three dots in the top-left corner, choose Preferences.
  • Enable the desired version of the Godot documentation by checking the box next to it in the sidebar.
  • Click the three dots in the top-left corner, choose Offline data.
  • Click the Install link next to the Godot documentation.

You can also download an HTML copy for offline reading (updated every Monday). Extract the ZIP archive then open the top-level index.html in a web browser.

Note

Godot Engine is an open source project developed by a community of volunteers. The documentation team can always use your feedback and help to improve the tutorials and class reference. If you don't understand something, or cannot find what you 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, help us translate the documentation into your language, or talk to us on the #documentation channel on the Godot Contributors Chat!

.. centered:: |weblate_widget|

The main documentation for the site is organized into the following sections:

.. toctree::
   :maxdepth: 1
   :caption: General
   :name: sec-general

   about/index


.. toctree::
   :maxdepth: 1
   :caption: Getting started
   :name: sec-learn

   getting_started/introduction/index
   getting_started/step_by_step/index
   getting_started/first_2d_game/index
   getting_started/first_3d_game/index


.. toctree::
   :maxdepth: 1
   :caption: Tutorials
   :name: sec-tutorials

   tutorials/2d/index
   tutorials/3d/index
   tutorials/animation/index
   tutorials/assets_pipeline/index
   tutorials/audio/index
   tutorials/best_practices/index
   tutorials/editor/index
   tutorials/export/index
   tutorials/i18n/index
   tutorials/inputs/index
   tutorials/io/index
   tutorials/math/index
   tutorials/navigation/index
   tutorials/networking/index
   tutorials/performance/index
   tutorials/physics/index
   tutorials/platform/index
   tutorials/plugins/index
   tutorials/rendering/index
   tutorials/scripting/index
   tutorials/shaders/index
   tutorials/ui/index
   tutorials/xr/index


.. toctree::
   :maxdepth: 1
   :caption: Development
   :name: sec-devel

   development/compiling/index
   development/cpp/index
   development/editor/index
   development/file_formats/index


.. toctree::
   :maxdepth: 1
   :caption: Community
   :name: sec-community

   community/contributing/index
   community/asset_library/index
   community/channels
   community/tutorials


.. toctree::
   :maxdepth: 1
   :caption: Class reference
   :name: sec-class-ref

   classes/index