38aea06740
- Update screenshots for Godot 4.0. - Document RichTextLabel having its own vertical scrollbar. - Document `push_[tag]()` and `pop()` functions as a faster alternative to BBCode. - Document threading support and when to use it. - Document how to escape user input to prevent it from having its BBCode tags parsed. - Document stripping BBCode tags from the text. - Mention entangled tags not being supported. - Mention faux bold/italic versus real bold/italic fonts. - Document `[hint]` and `[dropcap]` BBCode tags. - Mention animated RichTextEffects pausing when the scene tree is paused and how to control this behavior. - Modify RichTextEffect examples to use the actual default values. - Add screenshot showcasing how to add a RichTextEffect to the Custom Effects inspector property. - Fix and improve `[pulse]` custom RichTextEffect. This adds an easing parameter and makes the target color a multiplier, so that colored text keeps its original color while fading in and out.
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:
- Contributing to the online manual
- Contributing to the class reference
- Content guidelines
- Writing guidelines
- Building the manual
- 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.