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.

Rinevard 78d2ddb14c Update screenshots and descriptions in Asset Library docs (#10665) преди 23 часа
.github 2d30a6940c Merge pull request #10583 from mhilbrunner/gh-2404-imagemagick преди 2 седмици
_extensions d610bfdf23 GDScript: Document `@warning_ignore_start` and `@warning_ignore_restore` преди 1 месец
_static 049b42989e Revert "Fix video alignment after dependency update" преди 1 седмица
_styleguides 88970e5daa Add German style guide преди 1 година
_templates f6879c1bc4 Add navigation buttons before user-submitted comments on all pages. преди 1 месец
_tools f70686cdbe CI: Integrate `pre-commit` for style checks преди 3 месеца
about 9ffbae745e Improve links to Step by step преди 4 дни
classes 06119cd6c3 classref: Sync with current master branch (36d90c7) преди 5 дни
community 78d2ddb14c Update screenshots and descriptions in Asset Library docs (#10665) преди 23 часа
contributing 0eb095eaef Add i18n label to Bug triage guidelines преди 2 дни
getting_started 65c9060419 Merge pull request #10658 from tetrapod00/remove-plugin-link преди 4 дни
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) преди 6 месеца
tutorials 9d5712ec5b Merge pull request #10677 from tetrapod00/no-profiler-macos преди 1 ден
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) преди 4 години
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) преди 4 години
.gitignore 965685e247 Add more Python-related files to gitignore преди 2 седмици
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years преди 6 месеца
.pre-commit-config.yaml 20d9f0d9b1 CI: Remove EOF fixer from pre-commit hook преди 2 месеца
.readthedocs.yml d9e0d8386e Add tools definition for RTD преди 1 година
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years преди 6 месеца
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license преди 6 години
Makefile 31204023b6 Makefile: use sphinx-build -M преди 1 година
README.md d4b2a69cf6 Fix broken link in README to Contributing section преди 3 месеца
conf.py 68d7191b39 Add Plausible преди 1 седмица
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute преди 6 месеца
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs преди 1 година
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks преди 3 месеца
requirements.txt c6fdf264db Bump sphinx-notfound-page from 1.0.4 to 1.1.0 преди 2 седмици
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 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.