Contributing

All five phases of Flint are complete. Contributions are welcome in these areas:

• Bug reports — file issues on GitHub
• Schema definitions — new component and archetype schemas
• Documentation — improvements to this guide
• Test coverage — additional unit and integration tests (217 tests across 18 crates)
• Constraint kinds — new validation rule types
• Physics — additional collider shapes, improved character controller behavior
• Rendering — post-processing effects, LOD, additional debug views
• Audio — additional audio formats, reverb zones, music system
• Animation — blend trees, additive blending, animation state machines
• Scripting — new Rhai API functions, script debugging tools, performance profiling
• AI generation — new provider integrations, improved style validation, prompt engineering

Development Setup

git clone https://github.com/chrischaps/flint.git
cd flint
cargo build
cargo test
cargo clippy
cargo fmt --check

Running the Demo

# Scene viewer with hot-reload
cargo run --bin flint -- serve demo/phase4_runtime.scene.toml --watch

# First-person walkable scene
cargo run --bin flint -- play demo/phase4_runtime.scene.toml

Code Style

• Run cargo fmt before committing
• Run cargo clippy and address warnings
• Each crate has its own error type using thiserror
• Tests live alongside the code they test (#[cfg(test)] modules)
• Prefer explicit over clever; readability over brevity

Architecture

The project is an 18-crate Cargo workspace. See the Architecture Overview and Crate Dependency Graph for how the crates relate to each other. Key principles:

• Dependencies flow in one direction (binary crates at the top, flint-core at the bottom)
• Components are dynamic toml::Value, not Rust types — schemas are runtime data
• Two entry points: flint-cli (scene authoring) and flint-player (interactive gameplay)