Cookbook
The KeenEyes Cookbook provides practical, copy-paste-ready recipes for common game development patterns. Each recipe is self-contained and demonstrates best practices.
How to Use This Cookbook
Each recipe follows a consistent structure:
- Problem - What you're trying to solve
- Solution - The recommended approach with complete code
- Why This Works - Explanation of the design choices
- Variations - Common modifications and alternatives
Getting Started Recipes
Start here if you're new to KeenEyes:
| Recipe | Description |
|---|---|
| Basic Movement System | Move entities with velocity and handle acceleration |
| Health & Damage | Implement health, damage, healing, and death |
| Entity Spawning Patterns | Create entities efficiently at runtime |
Game Patterns
Common patterns for game logic:
| Recipe | Description |
|---|---|
| State Machine Entities | Implement FSM behavior for AI and game objects |
| Inventory System | Item management with components |
| Timers & Cooldowns | Time-based mechanics like abilities and buffs |
Performance Patterns
Optimize your ECS code:
| Recipe | Description |
|---|---|
| Entity Pooling | Reuse entities to avoid allocation |
| Spatial Queries | Efficient proximity and collision checks |
| Batch Operations | Bulk create, modify, and destroy entities |
Integration Patterns
Connect KeenEyes with external systems:
| Recipe | Description |
|---|---|
| Physics Integration | Sync ECS with physics engines |
| Input Handling | Process player input cleanly |
| Scene Management | Load, unload, and transition between scenes |
Contributing Recipes
Have a pattern that helped you? Recipes should:
- Solve a real, common problem
- Be complete and runnable
- Follow KeenEyes conventions
- Explain why, not just what