Introduction

    This page gives a broad presentation of the engine and of the contents of this documentation, so that you know where to start if you are a beginner or where to look if you need info on a specific feature.

    The page lists video tutorials contributed by the community. If you prefer video to text, those may be worth a look.

    In case you have trouble with one of the tutorials or your project, you can find help on the various Community channels, especially the Godot Discord community, Q&A, and IRC.

    A game engine is a complex tool, and it is therefore difficult to present Godot in a few words. Here’s a quick synopsis, which you are free to reuse if you need a quick writeup about Godot Engine.

    This documentation is continuously written, corrected, edited, and revamped by members of the Godot Engine community. It is edited via text files in the markup language and then compiled into a static website/offline document using the open source Sphinx and tools.

    Note

    You can contribute to Godot’s documentation by opening issue tickets or sending patches via pull requests on its GitHub source repository, or translating it into your language on .

    All the contents are under the permissive Creative Commons Attribution 3.0 (CC-BY 3.0) license, with attribution to “Juan Linietsky, Ariel Manzur and the Godot Engine community”.

    This documentation is organized in five sections with an impressively unbalanced distribution of contents – but the way it is split up should be relatively intuitive:

    • The General section contains this introduction as well as information about the engine, its history, its licensing, authors, etc. It also contains the .

    • The Tutorials section can be read as needed, in any order. It contains feature-specific tutorials and documentation.

    • The section is intended for advanced users and contributors to the engine development, with information on compiling the engine, developing C++ modules or editor plugins.

    • Finally, the Class reference is the documentation of the Godot API, which is also available directly within the engine’s script editor. It is generated automatically from a file in the main source repository, therefore the generated files of the documentation are not meant to be modified. See for details.

    In addition to this documentation you may also want to take a look at the various Godot demo projects.

    Have fun reading and making games with Godot Engine!