Official EU-hosted mirror of the Godot Engine GitHub documentation repository, provided as backup and for anyone who cannot access GitHub due to US trade restrictions. Please only use the issue tracker if you are restricted from using GitHub.

Max Hilbrunner a22c312b8f Merge pull request #9148 from Calinou/ssl-certificates-update 12 hours ago
.github b08b23d19b Build offline version of stable branch 1 month ago
_extensions 0a01baec10 Fix epub-related failures (#8207) 4 months ago
_static ac92bfb47a Merge pull request #9015 from adamscott/fix-website-highlight 1 month ago
_styleguides 88970e5daa Add German style guide 4 months ago
_templates bedd304160 Remove Giscus from search page (#8777) 2 months ago
_tools 643001f9b1 Merge pull request #8450 from Cerno-b/reorganise-about-headers 4 months ago
about 661fa2501a Update faq's directx12 question 1 week ago
classes 968bf7fda1 classref: Sync with current master branch (fe01776) 6 days ago
community 1c09d6a704 Add note for hosting asset icons on GitHub (#9125) 3 days ago
contributing cf54259ff0 Add intellisense configuration for VSCode 6 days ago
getting_started 477e40184f Merge pull request #9016 from walerian777/ctrl-click-on-macos 2 days ago
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) 9 months ago
tutorials a22c312b8f Merge pull request #9148 from Calinou/ssl-certificates-update 12 hours ago
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 3 years ago
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 3 years ago
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 10 months ago
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 3 years ago
.readthedocs.yml d9e0d8386e Add tools definition for RTD 10 months ago
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 1 year ago
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 5 years ago
Makefile 31204023b6 Makefile: use sphinx-build -M 1 year ago
README.md 9d1dd80374 Build ePubs of the documentation for offline reading 11 months ago
conf.py e1a71ea7a1 Add table of contents to epub of docs 6 days ago
index.rst 9b9a06cdb3 Remove reference to DevDocs copy of documentation 1 month ago
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 11 months ago
requirements.txt f7e0df5783 Pin more sphinx-contrib packages 2 months ago
robots.txt fd5f6f4909 Appease our great search engine overlords 3 years ago

README.md

Godot Engine documentation

This repository contains the source files of Godot Engine's documentation, in reStructuredText markup language (reST).

They are meant to be parsed with the Sphinx documentation builder to build the HTML documentation on Godot's website.

Download for offline use

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.

Theming

The Godot documentation uses the default sphinx_rtd_theme with many customizations applied on top. It will automatically switch between the light and dark theme depending on your browser/OS' theming preference.

If you use Firefox and wish to use the dark theme regardless of your OS configuration, you can install the Dark Website Forcer add-on.

Contributing

All contributors are welcome to help on the Godot documentation.

To get started, head to the Contributing section of the online manual. There, you will find all the information you need to write and submit changes.

Here are some quick links to the areas you might be interested in:

  1. Contributing to the online manual
  2. Contributing to the class reference
  3. Content guidelines
  4. Writing guidelines
  5. Building the manual
  6. Translating the documentation

License

At the exception of the classes/ folder, all the content of this repository is licensed under the Creative Commons Attribution 3.0 Unported license (CC BY 3.0) and is to be attributed to "Juan Linietsky, Ariel Manzur and the Godot community". See LICENSE.txt for details.

The files in the classes/ folder are derived from Godot's main source repository and are distributed under the MIT license, with the same authors as above.