commit 1c784e28300f79c0adc51f8c129a4ca11e2e0aa8 Author: John McCardle Date: Sat Oct 25 20:56:09 2025 +0000 Add "Home" diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..501c567 --- /dev/null +++ b/Home.md @@ -0,0 +1,62 @@ +# McRogueFace Wiki + +Welcome to the McRogueFace documentation wiki! This wiki provides focused, cross-referenced documentation for understanding and extending the engine. + +## Navigation + +### 📦 By System +- [[Grid-System]] - Grid rendering, entities, TCOD integration +- [[Animation-System]] - Property animation, easing functions +- [[Python-Binding-Layer]] - C++ ↔ Python integration +- [[UI-Component-Hierarchy]] - Frame, Caption, Sprite, Grid, Entity +- [[Performance-and-Profiling]] - Optimization, profiling tools + +### 🎮 By Use Case +- [[Rendering-and-Visuals]] - How to render tilemaps, sprites, UI +- [[Entity-Management]] - Creating and managing game entities +- [[Input-and-Events]] - Keyboard, mouse, event handling +- [[AI-and-Pathfinding]] - FOV, A*, Dijkstra maps +- [[Procedural-Generation]] - BSP, cellular automata, WFC + +### 🏗️ Development Workflows +- [[Adding-Python-Bindings]] - Expose C++ to Python +- [[Performance-Optimization-Workflow]] - Measure and optimize +- [[Writing-Tests]] - Test patterns and automation +- [[Profiling-and-Debugging]] - Using profiler overlay, GDB + +### 🗺️ Architecture & Design +- [[Architecture-Overview]] - High-level system design +- [[Design-Proposals]] - Index of architectural proposals +- [[Strategic-Direction]] - Project goals and priorities + +### 📋 Issue Roadmap +- [[Active-Development]] - Tier 1: Current focus +- [[Foundation-Work]] - Tier 2: Important systems +- [[Future-Features]] - Tier 3: Deferred features + +## Quick Links + +- **API Reference**: [docs/api_reference_dynamic.html](../docs/api_reference_dynamic.html) - Complete API extracted from C++ docstrings +- **Issue Tracker**: [Open Issues](https://gamedev.ffwf.net/gitea/john/McRogueFace/issues) +- **Repository**: [Source Code](https://gamedev.ffwf.net/gitea/john/McRogueFace) +- **Build Guide**: See CLAUDE.md in repository root + +## How to Use This Wiki + +**Multiple Entry Points:** +- **System-focused**: Start with system pages to understand architecture +- **Issue-focused**: Issue pages link to relevant wiki documentation +- **Use-case-focused**: Game development pages show practical examples + +**Cross-Referenced:** +- Every page links to related systems, issues, and source files +- Follow the links to navigate the relevant subset of documentation + +**Living Documentation:** +- Wiki evolves with the codebase +- Issues reference wiki pages +- Wiki pages reference current implementation files + +--- + +*Last updated: 2025-10-25* \ No newline at end of file