godotengine /godot-docs
Godot Engine official documentation
★ 5,911⑂ 3,814👁 122⑃ 8,219● 3,943▤ 0
More from this author
+4
Daily
5,911
stars
3,814
forks
122
watchers
8,219
prs
3,943
issues
0
releases
README
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 documentation. 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.
Top issues
#5121Documentation pages to add or update for Godot 487 comments · 2021-07-29#5618Create a complete and concise documentation for GDExtension51 comments · 2022-02-16#4400Document how to interpret mesh vertex count in the editor49 comments · 2020-11-20#5378Docs on new method to get Input is factually wrong and misleading28 comments · 2021-11-07#9588SoftBody3D wind can't be changed unless wind subject is re-entering Area3D21 comments · 2024-07-09#7515Add example docs on how to simulate mouse pressed and releases through artifical events21 comments · 2023-06-14#6385godot 4 glTF runtime loader21 comments · 2022-11-15#7398Tutorial or docs on human skin/hair shaders19 comments · 2023-05-22