Godot Engine official documentation
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Max Hilbrunner da46470513
Merge pull request #6978 from JohnVeness/project-manager
13 hours ago
.github Enable error reporting on the CI and address the remaining errors 3 weeks ago
_extensions Update GDScript syntax highlighting for Godot 4.0 1 year ago
_static Display Godot version more clearly 3 weeks ago
_templates Display Godot version more clearly 3 weeks ago
_tools Fix typos and make CI a happy Gobot 2 weeks ago
about Merge pull request #6978 from JohnVeness/project-manager 13 hours ago
classes classref: Sync with 4.0-stable 3 weeks ago
community Change capitalization of Project Manager 7 days ago
contributing Merge pull request #6978 from JohnVeness/project-manager 13 hours ago
getting_started Merge pull request #6978 from JohnVeness/project-manager 13 hours ago
img Add links to demo projects where relevant (#6874) 2 weeks ago
tutorials Merge pull request #6978 from JohnVeness/project-manager 13 hours ago
.editorconfig Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 2 years ago
.gitattributes Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 2 years ago
.gitignore ReadTheDocs redirect automation. 1 year ago
.mailmap Add AUTHORS.md with list of main contributors 3 years ago
.readthedocs.yml RTD: Migrate config file to v2 3 years ago
AUTHORS.md Use official CC BY 3.0 terminology and resources 6 months ago
LICENSE.txt Add full text of CC-BY-3.0 license 4 years ago
Makefile Allow specifying a list of files for the make command 3 weeks ago
README.md Update links in README to fix broken URLs (#6589) 2 months ago
conf.py Display Godot version more clearly 3 weeks ago
index.rst Improve naming and organization of some manual articles 3 weeks ago
make.bat Revert "Default to parallel builds in Sphinx for faster builds" 3 years ago
requirements.txt Pin additional build requirements to avoid syntax highlighting issues 2 months ago
robots.txt Appease our great search engine overlords 3 years ago

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

You can 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.

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.