Documentation web scraped and aggregated to help the ai agents
- Python 100%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .github/workflows | ||
| Bevy-Documentation | ||
| Godot-Documentation | ||
| .gitignore | ||
| README.md | ||
📚 Game Engine Documentation Knowledge Hub
Offline-Queryable, Cross-Linked Documentation for Bevy (Rust) & Godot Engine
Welcome to the central game development documentation repository. This workspace provides complete, structured, offline-queryable Markdown references for both the Bevy Rust Game Engine and Godot Engine, designed for both human developers and AI coding assistants.
🧭 Master Documentation Hubs
| Engine | Active Version | Master Index | Scope & Coverage |
|---|---|---|---|
| 🦀 Bevy Engine (Rust) | 0.15+ |
Bevy-Documentation/INDEX.md |
Official Bevy Book (40 docs), Unofficial Cheat Book (138 guides), 9 Game Tutorials, 150+ Official Examples, 366+ Community Crates, 98 Open-Source Games, & Migration Guides |
| 🤖 Godot Engine | 4.7 (Stable) |
Godot-Documentation/INDEX.md |
Official Manual & Tutorials (511 docs), 1,078 Built-in Classes (9 Catalogs), KidsCanCode 4.x Recipes (101 guides), Catlike Coding Godot 4 Series (31 guides), 110+ Official Demo Projects, 14 Complete Game Codebases, & Awesome-Godot |
🗂️ Repository Layout
Documentation/
├── .github/
│ └── workflows/
│ └── sync-godot-docs.yml # Daily automated version check & incremental sync
├── Bevy-Documentation/ # 🦀 Bevy 0.15+ Rust Game Engine Knowledge Hub
│ ├── 00_getting_started/ # Setup, cargo optimizations, compiler error cookbook
│ ├── 01_core_ecs_architecture/ # Official Bevy Book (ECS, Schedules, Rendering, Assets)
│ ├── 02_tutorials/ # 9 End-to-end game tutorials (Snake, Chess, Roguelike, etc.)
│ ├── 03_deep_dives_and_guides/ # Networking, GGRS rollback, render pipelines, archetypes
│ ├── 04_bevy_cheat_book/ # The Unofficial Bevy Cheat Book (138 chapters)
│ ├── 05_official_examples/ # 11 Domain catalogs indexing 150+ official Bevy examples
│ ├── 06_ecosystem_and_plugins/ # Physics (Avian/Rapier), UI, Input & 366 community crates
│ ├── 07_migrations_and_history/ # Migration guides (0.11 -> 0.15+) & breaking changes table
│ ├── 08_game_showcase_and_templates/ # 98 Open-source games, 13 tools & 10 starter templates
│ ├── tools/ # Bevy ingestion & index maintenance scripts
│ ├── INDEX.md # Bevy Master Index
│ └── manifest.json # Bevy asset registry
└── Godot-Documentation/ # 🤖 Godot 4.7 (Stable) Game Engine Knowledge Hub
├── 00_getting_started/ # About Godot, FAQ, Step-by-Step, First 2D & 3D Games
├── 01_core_and_scripting/ # Best Practices, GDScript, C#/.NET, GDExtension, Editor
├── 02_2d_and_3d_development/ # 2D, TileMaps, 3D, Global Illumination, Animation, Assets
├── 03_physics_navigation_and_math/ # 2D/3D Physics, Raycasting, Navigation, Vector Math
├── 04_rendering_shaders_and_ui/ # Renderers, Shading Language, Canvas/Spatial/Compute, UI
├── 05_systems_io_audio_networking_xr/ # Audio, Input, File/Data I/O, Multiplayer, i18n, OpenXR
├── 06_export_performance_and_engine/ # Exporting, Profiling/Optimization, Plugins, Engine C++
├── 07_migrations_and_history/ # Upgrade guides (Godot 3 -> 4.0 through 4.7)
├── 08_class_reference_and_community/ # 1,078 Built-in Classes (9 Catalogs) & Community
├── 09_godot_recipes_and_tutorials/ # KidsCanCode 4.x Recipes (101) & Catlike Coding Series (31)
├── 10_official_demos_and_community_games/ # 110+ Official Demos, 14 Full Game Codebases & Awesome-Godot
├── tools/ # Godot scraper, RST->MD converter & incremental diff engine
├── INDEX.md # Godot Master Index
└── manifest.json # Godot version tracker & per-page SHA-256 registry
🚀 Quick Jump by Engine
🦀 Bevy Engine (Bevy-Documentation/)
- Foundations & Getting Started — Installation, fast compiles (
mold/lld/Cranelift), project structure, and Common Cryptic Compiler Errors Cookbook. - Core ECS Architecture & Official Book — Entities, Components, Systems, Resources, Queries, Schedules, States, Events, and Plugins.
- Hands-On Game Tutorials — 2D Snake, Minesweeper, Breakout, Flappy Bird, 3D Chess, Rhythm Game, and Turn-Based Roguelike.
- Technical Deep Dives — Rollback netcode (
bevy_ggrs), dual-world rendering pipeline, archetype storage, and design patterns. - The Unofficial Bevy Cheat Book — 138 reference chapters covering ECS rules, pitfalls, and cookbooks.
- Official Examples Catalog & Ecosystem Plugins (366+ Crates).
- Version Migration Guides (0.11 → 0.15+) & Open-Source Games Showcase.
🤖 Godot Engine (Godot-Documentation/)
- Foundations & Getting Started — Introduction, Step-by-Step Core Concepts, Your First 2D Game, and Your First 3D Game.
- Core Architecture & Scripting — Best Practices, GDScript Reference, C# / .NET, GDExtension, and Troubleshooting.
- 2D & 3D Game Development — 2D Guides, 3D Guides, Animation, and Assets Pipeline.
- Physics, Navigation & Math — Physics, Navigation, and Math.
- Rendering, Shaders & UI — Rendering, Shaders, and User Interface (UI).
- Audio, Input, I/O, Networking & XR & Exporting, Performance & Engine Internals.
- Version Migration Guides (3.x → 4.7) & Complete Class Reference (1,078 Classes).
- Community Recipes & Game Tutorial Series — KidsCanCode Godot 4.x Recipes (101 Guides) & Catlike Coding Godot 4 Series (31 Guides).
- Official Demo Projects, Complete Game Codebases & Awesome-Godot — 110+ Official Demo Projects & 14 Full Game Codebases & Awesome-Godot Open-Source Games, Plugins & Templates.
🔄 Automated Documentation Synchronization
The Sync Godot Documentation workflow runs daily at 06:00 UTC (and supports manual dispatch):
- Version Check Gate: Runs
python Godot-Documentation/tools/ingest_godot_docs.py --check-onlyto compare the live version on docs.godotengine.org/en/stable againstGodot-Documentation/manifest.json. - Fast Skip: If the version has not changed, the workflow exits immediately without scraping.
- Incremental Diff Sync / Full Rescrape: When a new version is detected (or when triggered manually with
force_updateorfull_rescrape), it compares per-page SHA-256 hashes, updates modified/added/removed guides and class catalogs, regeneratesGodot-Documentation/INDEX.md, and commits the changes tomain.