Forge Engine Documentation

Welcome to the Forge Engine documentation. This folder contains comprehensive documentation for building games with Forge.

Quick Links

Document	Description
ARCHITECTURE.md	High-level system overview and design principles
EDITOR.md	Forge Editor - Tauri desktop application
AI_INTERFACE.md	JSON-RPC API reference for AI agents
ECS.md	Entity Component System guide
RENDERING.md	Rendering pipeline and graphics features
NETWORKING.md	Multiplayer and networking guide
PHYSICS.md	Physics system documentation
NAVIGATION.md	AI pathfinding and navigation
AUDIO.md	Audio system and spatial sound
UI.md	User interface systems
ASSETS.md	Asset pipeline and loading
BUILDING.md	Build system and deployment
CONTRIBUTING.md	How to contribute to Forge

Examples

Run examples from the forge/ directory:

Example	Description	Command
hello_world	Basic setup and version info	cargo run --example hello_world
window	Window creation and event handling	cargo run --example window
shapes	Basic shape rendering	cargo run --example shapes
camera	Camera controls (orbit, fly)	cargo run --example camera
pbr	PBR materials and lighting	cargo run --example pbr
input	Input handling (keyboard, mouse)	cargo run --example input
physics_demo	Physics simulation with spheres and cubes	cargo run --example physics_demo
audio_demo	3D spatial audio with positional panning	cargo run --example audio_demo
scene_demo	Scene serialization with multiple entity types	cargo run --example scene_demo
hotreload_demo	Hot-reloading assets	cargo run --example hotreload_demo
debug_overlay_demo	Interactive egui debug panels and profiler	cargo run --example debug_overlay_demo
query_demo	ECS query patterns with visual rendering	cargo run --example query_demo

Architecture Decision Records

The decisions/ folder contains ADRs documenting significant technical decisions:

ADR	Title
001	Rust as Primary Language
002	Entity Component System Architecture

For AI Agents

If you're an AI agent working on Forge Engine:

1. Start with .cursorrules in the project root - it has project-specific rules
2. Check ARCHITECTURE.md for system overview
3. Use AI_INTERFACE.md for API command reference
4. Check relevant system doc (ECS, RENDERING, etc.) for specific features
5. Read CONTRIBUTING.md before making changes

Documentation Standards

When updating documentation:

• Keep docs in sync with code changes
• Use code examples that actually compile
• Include both API and usage examples
• Update the relevant doc when adding features
• Add ADRs for significant architecture decisions

Version

This documentation reflects Forge Engine v0.1.0-dev (initial development).