RapidGameFramework Documentation

RapidGameFramework is a reusable Godot framework for building small, data-driven games from shared systems. The framework documentation focuses on the managers, schemas, editor tools, build profiles, and integration patterns that future games can reuse.

The playable games in this repository are examples of those systems in action. Game-specific sprint notes, playtest feedback, and design details are kept in the examples and testing sections so the top-level docs stay useful as a framework reference.

Start Here

• Framework Docs gathers framework-only documentation.
• Framework Overview explains the reuse model and core system groups.
• Reusable Systems API lists the framework-facing APIs and when to use them.
• Framework Roadmap tracks reusable systems that are planned, seeded, or ready for broader adoption.
• Release Sprint Plan tracks the active release-focused sprint plan.
• Performance And Engine Refactor Plan preserves the completed engine optimization and modular refactor record for lightweight browser/mobile games.
• Framework Handoff summarizes the current optimization/refactor state and the next recommended pickup point.
• Framework Modularity Audit records extraction candidates from current game code into reusable systems.

Framework Schemas

• Data Schemas gathers reusable data schema references.
• Level JSON Schema documents shared JSON level files used by the level editor, Platformer Demo, Project Alchemy fields, and future tile/grid games.

Game Examples

Game Examples gathers the current demos as examples of framework usage:

• Reflecting Pool Simulator demonstrates event packs, resource bars, HUD indicators, save state, and theme-aware custom drawing.
• Emoji Card Collector demonstrates card catalogs, packs, shops, inventory lists, modifiers, battle results, collections, and save slots.
• Arcade Pong demonstrates arcade physics, match flow, difficulty presets, controller/touch input, power-up inventory, audio, sprites, achievements, and single-game build profiles.
• Project Alchemy Roadmap and Project Alchemy Sprint Plan document Project Alchemy as a larger tactical RPG example built on alchemy, codex, deck rotation, grid combat, adventure, sprite mapping, and level data systems.

Testing Notes

• Testing And Playtest Notes gathers validation and playtest notes.
• Arcade Pong Release Feedback and Emoji Card Collector First Release Plan track the active release polish lanes.
• MVP Playtest Feedback 2026-07-13 stores archived July 2026 cross-game MVP playtest feedback and closeout status.

Build And Publishing

GitLab CI runs headless tests, generates Doxygen documentation, exports selected Godot build profiles, and publishes GitLab Pages with:

• This generated framework documentation.
• The Pages landing page from pages/.
• Published web builds for active release profiles.

Per-game export profiles live in data/build_profiles/. Game data lives under data/games/<game_id>/, while shared schemas, settings, themes, palettes, and menus live under data/.