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.

pizzafaceopossum b313607fd7 Added separate links to stable/latest/3.6 copies of the offline documentation 8 месяцев назад
.github 3a9355cd94 Fix the 4.0 branch CI 1 год назад
_extensions 7d5fb4e6a2 Various fixups 1 год назад
_static a11e0d78c0 Merge pull request #7409 from Calinou/abbr-add-mobile-display 1 год назад
_templates ca94970356 Less intrusive 4.0 update state info (#7100) 1 год назад
_tools 3a9355cd94 Fix the 4.0 branch CI 1 год назад
about faa3cd1573 Merge pull request #7733 from YuriSizov/about-type-in-releases 1 год назад
classes 727b754530 classref: Sync with current 4.0 branch (6c99b77) 7 месяцев назад
community 61969c1bfc Merge pull request #7649 from sainthDE/patch-1 1 год назад
contributing a14cf32e08 Merge pull request #7614 from Calinou/update-tscn-file-format 1 год назад
getting_started a605d21719 Merge pull request #7700 from MohsenHNSJ/master 1 год назад
img 3dfbfbf381 Add links to demo projects where relevant (#6874) 1 год назад
tutorials 7c761a8d59 4.0 spelling fixes 7 месяцев назад
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 3 лет назад
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 3 лет назад
.gitignore 4c08b7e4c8 Added configuring ide for rider (#7420) 1 год назад
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 4 лет назад
.readthedocs.yml d9e0d8386e Add tools definition for RTD 1 год назад
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 2 лет назад
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 лет назад
Makefile 31204023b6 Makefile: use sphinx-build -M 1 год назад
README.md 9d1dd80374 Build ePubs of the documentation for offline reading 1 год назад
conf.py 20e2417231 Merge branch 'master' into 4.0 1 год назад
index.rst b313607fd7 Added separate links to stable/latest/3.6 copies of the offline documentation 6 месяцев назад
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 1 год назад
requirements.txt eff516f385 Merge pull request #8763 from mhilbrunner/sphinx-5-contrib-fix 7 месяцев назад
robots.txt fd5f6f4909 Appease our great search engine overlords 4 лет назад

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.