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.

Godot Organization 268c60257a classref: Sync with current master branch (ebc36a7) 1 nedēļu atpakaļ
.github 5bf9ef3aa6 CI: Check URLs on schedule only to reduce false positives 3 mēneši atpakaļ
_extensions d610bfdf23 GDScript: Document `@warning_ignore_start` and `@warning_ignore_restore` 6 mēneši atpakaļ
_static 049b42989e Revert "Fix video alignment after dependency update" 5 mēneši atpakaļ
_styleguides 88970e5daa Add German style guide 1 gadu atpakaļ
_templates f6879c1bc4 Add navigation buttons before user-submitted comments on all pages. 6 mēneši atpakaļ
_tools 6ad8b84835 Bump requests from 2.32.0 to 2.32.4 in /_tools/redirects 3 nedēļas atpakaļ
about 2dfadeb141 Update system requirements to Windows 10. 1 mēnesi atpakaļ
classes 268c60257a classref: Sync with current master branch (ebc36a7) 1 nedēļu atpakaļ
community a15f86bc03 Merge branch 'master' into patch-1 2 mēneši atpakaļ
contributing 89eaa1f590 Merge pull request #10825 from douglaslassance/contribute-vscode-macos 1 nedēļu atpakaļ
getting_started 1fbfaf5509 Document Flameshot being cross-platform in Learning new features 1 nedēļu atpakaļ
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) 10 mēneši atpakaļ
tutorials 7e591554a2 Merge pull request #10823 from Calinou/gdscript-exports-tool-button-icon 1 nedēļu atpakaļ
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 gadi atpakaļ
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 gadi atpakaļ
.gitignore 965685e247 Add more Python-related files to gitignore 5 mēneši atpakaļ
.lycheeignore bf27bf2c96 Fix URL check errors 3 mēneši atpakaļ
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 10 mēneši atpakaļ
.pre-commit-config.yaml 20d9f0d9b1 CI: Remove EOF fixer from pre-commit hook 7 mēneši atpakaļ
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 gadi atpakaļ
404.rst 2bfc2f04cf Hide user notes on 404 page 2 mēneši atpakaļ
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 10 mēneši atpakaļ
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 gadi atpakaļ
Makefile 31204023b6 Makefile: use sphinx-build -M 2 gadi atpakaļ
README.md d4b2a69cf6 Fix broken link in README to Contributing section 8 mēneši atpakaļ
conf.py 2bfc2f04cf Hide user notes on 404 page 2 mēneši atpakaļ
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute 11 mēneši atpakaļ
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 gadi atpakaļ
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks 7 mēneši atpakaļ
requirements.txt 64e4c1d715 Bump pygments from 2.19.1 to 2.19.2 1 nedēļu atpakaļ
robots.txt fd5f6f4909 Appease our great search engine overlords 5 gadi atpakaļ

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.