Domů Procházet Nápověda
Přihlásit se
godotengine
/
godot-docs
zrcadlo https://github.com/godotengine/godot-docs
Sledovat 1
Oblíbit 1
Rozštěpit 0
Soubory

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.

Větev: classref/sync-42c7f14
Větve Značky
godot-docs
ZIP TAR.GZ
Godot Organization f9f2c80955 classref: Sync with current master branch (42c7f14) před 1 měsícem
.github 5bf9ef3aa6 CI: Check URLs on schedule only to reduce false positives před 3 měsíci
_extensions d610bfdf23 GDScript: Document `@warning_ignore_start` and `@warning_ignore_restore` před 6 měsíci
_static 049b42989e Revert "Fix video alignment after dependency update" před 5 měsíci
_styleguides 88970e5daa Add German style guide před 1 rokem
_templates f6879c1bc4 Add navigation buttons before user-submitted comments on all pages. před 6 měsíci
_tools 028abe15d1 Split C++ (godot-cpp) and GDExtension system info into separate categories, children of Scripting. před 2 měsíci
about 2dfadeb141 Update system requirements to Windows 10. před 1 měsícem
classes f9f2c80955 classref: Sync with current master branch (42c7f14) před 1 měsícem
community a15f86bc03 Merge branch 'master' into patch-1 před 2 měsíci
contributing 1e6df92f02 Update Optimizing for size for Godot 4.5 (#10968) před 1 měsícem
getting_started 7f82289aee Update the getting started 3d tutorial for godot 4.x před 2 měsíci
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) před 10 měsíci
tutorials 365ca84c14 Merge pull request #10992 from wjt/push-lxwsmntzmvxp před 1 měsícem
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) před 4 roky
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) před 4 roky
.gitignore 965685e247 Add more Python-related files to gitignore před 5 měsíci
.lycheeignore bf27bf2c96 Fix URL check errors před 3 měsíci
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years před 10 měsíci
.pre-commit-config.yaml 20d9f0d9b1 CI: Remove EOF fixer from pre-commit hook před 7 měsíci
.readthedocs.yml d9e0d8386e Add tools definition for RTD před 2 roky
404.rst 2bfc2f04cf Hide user notes on 404 page před 2 měsíci
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years před 10 měsíci
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license před 6 roky
Makefile 31204023b6 Makefile: use sphinx-build -M před 2 roky
README.md d4b2a69cf6 Fix broken link in README to Contributing section před 8 měsíci
conf.py 2bfc2f04cf Hide user notes on 404 page před 2 měsíci
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute před 11 měsíci
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs před 2 roky
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks před 7 měsíci
requirements.txt 7fd2c763f2 Bump sphinxext-opengraph from 0.9.1 to 0.10.0 před 3 měsíci
robots.txt fd5f6f4909 Appease our great search engine overlords před 5 roky

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.