Godot Engine Official Documentation
This skill serves the official Godot Engine documentation from the stable branch of godotengine/godot-docs in its original reStructuredText format.
The documentation snapshot is not bundled — it is installed into the references folder on first use (see below). Once installed, the skill works fully offline.
Initialize this skill (first use)
If the references folder is missing, install the snapshot (needs network access, downloads a few hundred MB):
- Git clone https://github.com/godotengine/godot-docs into the same folder as this skill file is located in.
- Switch to the
stable branch in the Git working copy cloned into the godot-docs folder.
- Create the
references folder under the folder this skill file is located in.
- Move the following file from the
godot-docs folder into the references folder: index.rst
- Move the following folders from the
godot-docs folder into the references folder: classes, tutorials, engine_details, getting_started, community, about
- Delete the
godot-docs repository folder (what you have just cloned).
Update this skill
If the Godot version increases, then update this skill by:
- Remove the
references folder.
- Run all steps of the "Initialize this skill" section above.
When to Use
Use this documentation as the authoritative reference for Godot when:
- Looking up API class reference (
references/classes/)
- Checking how engine features work (
references/tutorials/)
- Understanding engine internals (
references/engine_details/)
- Following getting started guides (
references/getting_started/)
- Verifying correct usage of nodes, resources, signals, or GDScript syntax
Documentation Structure
| Directory |
Contents |
references/classes/ |
API class reference for all Godot classes |
references/tutorials/ |
In-depth tutorials on all engine systems |
references/engine_details/ |
Engine internals and architecture |
references/getting_started/ |
Introduction and first steps |
references/about/ |
About Godot, FAQ, release info |
references/community/ |
Community resources and contribution guides |
The documentation files are in reStructuredText (rst) format.
Key References
Class Reference
- Node types:
references/classes/class_node.rst, references/classes/class_node2d.rst, references/classes/class_node3d.rst
- Physics:
references/classes/class_characterbody2d.rst, references/classes/class_characterbody3d.rst, references/classes/class_rigidbody2d.rst, references/classes/class_rigidbody3d.rst
- UI:
references/classes/class_control.rst, references/classes/class_container.rst, references/classes/class_label.rst
- Resources:
references/classes/class_resource.rst, references/classes/class_packedscene.rst
Tutorials by Topic
- Scripting:
references/tutorials/scripting/
- 2D:
references/tutorials/2d/
- 3D:
references/tutorials/3d/
- Animation:
references/tutorials/animation/
- Physics:
references/tutorials/physics/
- Shaders:
references/tutorials/shaders/
- Networking:
references/tutorials/networking/
- Navigation:
references/tutorials/navigation/
- UI:
references/tutorials/ui/
- Audio:
references/tutorials/audio/
- I/O:
references/tutorials/io/
- XR:
references/tutorials/xr/
- Performance:
references/tutorials/performance/
- Platform-specific:
references/tutorials/platform/
- Export:
references/tutorials/export/
Usage Guidelines
- Always prefer this documentation over guessing or relying on potentially outdated information
- Check class reference first when unsure about method signatures, property types, or signal parameters
- Cross-reference tutorials for recommended patterns and best practices
- Note: Image references in the docs point to the original repo paths and won't render locally — focus on the text content
1---2name: godot-documentation3description: Installs and serves an offline copy of the official Godot Engine documentation (getting started guides, tutorials, API class reference, engine details). Use when working on a Godot project or GDScript code and you need authoritative API or engine reference. On first use it downloads the docs by cloning godotengine/godot-docs (requires network access and a few hundred MB of disk).4license: Creative Commons Legal Code 3 (same as Godot's documentation)5---67# Godot Engine Official Documentation89This skill serves the official Godot Engine documentation from the `stable` branch of [godotengine/godot-docs](https://github.com/godotengine/godot-docs) in its original reStructuredText format.1011The documentation snapshot is **not bundled** — it is installed into the `references` folder on first use (see below). Once installed, the skill works fully offline.1213# Initialize this skill (first use)1415If the `references` folder is missing, install the snapshot (needs network access, downloads a few hundred MB):161. Git clone https://github.com/godotengine/godot-docs into the same folder as this skill file is located in.172. Switch to the `stable` branch in the Git working copy cloned into the `godot-docs` folder.183. Create the `references` folder under the folder this skill file is located in.194. Move the following file from the `godot-docs` folder into the `references` folder: `index.rst`205. Move the following folders from the `godot-docs` folder into the `references` folder: `classes`, `tutorials`, `engine_details`, `getting_started`, `community`, `about`216. Delete the `godot-docs` repository folder (what you have just cloned).2223## Update this skill2425If the Godot version increases, then update this skill by:261. Remove the `references` folder.272. Run all steps of the "Initialize this skill" section above.2829# When to Use3031Use this documentation as the authoritative reference for Godot when:3233- Looking up API class reference (`references/classes/`)34- Checking how engine features work (`references/tutorials/`)35- Understanding engine internals (`references/engine_details/`)36- Following getting started guides (`references/getting_started/`)37- Verifying correct usage of nodes, resources, signals, or GDScript syntax3839# Documentation Structure4041| Directory | Contents |42|-----------|----------|43| `references/classes/` | API class reference for all Godot classes |44| `references/tutorials/` | In-depth tutorials on all engine systems |45| `references/engine_details/` | Engine internals and architecture |46| `references/getting_started/` | Introduction and first steps |47| `references/about/` | About Godot, FAQ, release info |48| `references/community/` | Community resources and contribution guides |4950The documentation files are in reStructuredText (rst) format.5152# Key References5354## Class Reference55- Node types: `references/classes/class_node.rst`, `references/classes/class_node2d.rst`, `references/classes/class_node3d.rst`56- Physics: `references/classes/class_characterbody2d.rst`, `references/classes/class_characterbody3d.rst`, `references/classes/class_rigidbody2d.rst`, `references/classes/class_rigidbody3d.rst`57- UI: `references/classes/class_control.rst`, `references/classes/class_container.rst`, `references/classes/class_label.rst`58- Resources: `references/classes/class_resource.rst`, `references/classes/class_packedscene.rst`5960## Tutorials by Topic61- Scripting: `references/tutorials/scripting/`62- 2D: `references/tutorials/2d/`63- 3D: `references/tutorials/3d/`64- Animation: `references/tutorials/animation/`65- Physics: `references/tutorials/physics/`66- Shaders: `references/tutorials/shaders/`67- Networking: `references/tutorials/networking/`68- Navigation: `references/tutorials/navigation/`69- UI: `references/tutorials/ui/`70- Audio: `references/tutorials/audio/`71- I/O: `references/tutorials/io/`72- XR: `references/tutorials/xr/`73- Performance: `references/tutorials/performance/`74- Platform-specific: `references/tutorials/platform/`75- Export: `references/tutorials/export/`7677# Usage Guidelines78791. **Always prefer this documentation** over guessing or relying on potentially outdated information802. **Check class reference first** when unsure about method signatures, property types, or signal parameters813. **Cross-reference tutorials** for recommended patterns and best practices824. **Note**: Image references in the docs point to the original repo paths and won't render locally — focus on the text content