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 ee30acc23f Merge pull request #11235 from Calinou/internationalizing-games-link-pseudolocalization 19 tuntia sitten
.github 5200c0c99d Bump actions/checkout from 4 to 5 (#11197) 2 viikkoa sitten
_extensions 7a7ac7dc2d GDScript: Document abstract and variadic functions 2 kuukautta sitten
_static 6792402014 Add custom Sphinx roles for editor UI 4 kuukautta sitten
_styleguides 88970e5daa Add German style guide 1 vuosi sitten
_templates f6879c1bc4 Add navigation buttons before user-submitted comments on all pages. 7 kuukautta sitten
_tools 3946ede7aa Replace remaining uses of shorthand codeblock syntax, add CI check 1 kuukausi sitten
about 7e5f70664e Merge pull request #11140 from skyace65/VisionOSSupport 3 viikkoa sitten
classes 0588ed74d6 classref: Sync with current master branch (3defc85) 3 päivää sitten
community a15f86bc03 Merge branch 'master' into patch-1 4 kuukautta sitten
contributing f086648f3b Add pages on exporting and compiling for visionOS 1 viikko sitten
getting_started 37bbf2bc41 Merge pull request #11149 from Piralein/MeMeDontLike3D 1 viikko sitten
img a82ed18d3d Add FoldableContainer to the Control node gallery page 1 kuukausi sitten
tutorials 2f26289f47 Link to Pseudolocalization page in Internationalizing games 1 päivä sitten
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 vuotta sitten
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 vuotta sitten
.gitignore 965685e247 Add more Python-related files to gitignore 6 kuukautta sitten
.lycheeignore bf27bf2c96 Fix URL check errors 5 kuukautta sitten
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 vuosi sitten
.pre-commit-config.yaml 20d9f0d9b1 CI: Remove EOF fixer from pre-commit hook 9 kuukautta sitten
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 vuotta sitten
404.rst 2bfc2f04cf Hide user notes on 404 page 4 kuukautta sitten
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 vuosi sitten
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 vuotta sitten
Makefile 31204023b6 Makefile: use sphinx-build -M 2 vuotta sitten
README.md d4b2a69cf6 Fix broken link in README to Contributing section 10 kuukautta sitten
conf.py 69d69dad2c Update Godot docs version to 4.5 3 viikkoa sitten
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute 1 vuosi sitten
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 vuotta sitten
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks 9 kuukautta sitten
requirements.txt b943c8014c Bump sphinxext-opengraph from 0.11.0 to 0.12.0 3 viikkoa sitten
robots.txt fd5f6f4909 Appease our great search engine overlords 5 vuotta sitten

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 download an HTML copy (updated every Monday): stable, latest, 3.6. 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, 3.6. 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

With 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.