Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Redot.
Checking the stable version of the documentation...
Redot Docs – master branch¶
Welcome to the official documentation of Redot 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 introduction page to get an overview of what this documentation has to offer.
The table of contents 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.
Get involved¶
Redot 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,
or talk to us on the #documentation
channel on the
Redot Contributors Chat!
Offline documentation¶
To browse the documentation offline, you can download an HTML copy (updated every Monday): stable, latest. Extract the ZIP archive then open
the top-level index.html
in a web browser.
For mobile devices or e-readers, you can also download an ePub copy (updated every Monday): stable, latest. Extract the ZIP archive then open
the RedotEngine.epub
file in an e-book reader application.