Godot Docs – master branch

Welcome to the mirror of 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 introduction page to get an overview of what this documentation has to offer.

Note

This repository is managed and maintained by Godot Community and is not affiliated with the official Godot Engine project. This repository serves as an alternative source in case the official site experiences downtime or other connectivity issues. For issues specific to the mirrored documentation, please use the issues section in our Github repo.

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

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!

Translation status

Offline documentation

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.

For mobile devices or e-readers, you can also download an ePub copy for offline reading (updated every Monday). Extract the ZIP archive then open the GodotEngine.epub file in an e-book reader application.