Sources: AGENTS.md GOVERNANCE.md commit d32b9cc880a8 docs-explanation

CCB Developer Documentation¶

This is the official developer guide, API reference, and architecture navigation site for Cataclysm: Cleanwater Bomb.

This site is dedicated to two primary developer groups: Mod Authors and Core C++ Engine Developers.

Lua Platform v1: zero to running: the only supported Lua MOD entry point and a minimal example.
First Contribution Guide: The fastest path from local environment to your first Pull Request.

Characters & Creatures Manual: Entity inheritance, 12-part anatomical health model, stamina/pain, and buffs.
Items & Pockets Manual: Metric physical standards, recursive multi-pocket containers, and item actions.
Map & Mapgen Manual: 3D spatial grids, terrain/furniture collision rules, and procedural blueprint matrices.
Combat & Damage Manual: 7 physical damage types, armor coverage rolls, and damage hook interception.
Finite Water & Environment Manual: Mass-conserving fluid simulation, storm radar forecasting, and field diffusion.
Vehicles & Parts Manual: Rigid-body center-of-mass physics, powertrain torque, and modular part mount slots.

Quickstart and version rules: create, install, and check your first Lua MOD.
Complete LuaLS declarations: detailed functions, parameters, returns, and types.
Machine-readable API contract: generator input and API change checks.
Complete example MOD: real code organized by game domain.
CCB-MOD catalog: find, install, or register external MODs.

Core Engine Lifecycle & Main Loop Deep-Dive: Complete control flow from bootstrap, content loading to process_turn loop.
Engine Subsystems Deep Dive: Entities, sliding map cache, item pocket trees, finite water, and physics.
Core Development & Contribution Guide: Linux/Windows/Android setup, C++20 standards, Catch2 tests, and PR practices.
C++ Native Binding & Lua Export Guide: Sol2 bindings, LuaLS annotations, and 100% coverage gates.
Build & Compilation Overview: Learn CMake and Make modern build workflows and multi-platform support.

Responsible Human: Understand our accountability model for human and AI-assisted contributions.

Quick Navigation & Manual Directory¶