What problem does it solve?
Provides a focused, file-level reference for developers who need authoritative answers about Orkid's Entity Component System, scene composition, simulation lifecycle, and Python binding architecture so they do not have to manually search the repository.
Core Features & Use Cases
- Architecture Mapping: Identifies key header and source locations for Entities, Components, Systems, Archetypes, Scenes, Simulation, and Controllers.
- Binding Guidance: Explains the dual Python binding strategy (pybind11 for controller, nanobind for simulation subinterpreters) and where to find pyext and pyext_sim code.
- Editor & Runtime Workflows: Describes scene editor/player usage patterns, spawn and lifecycle flows, and how PythonSystem scripts are dispatched in simulation.
- Use Case: A developer adding a new component can quickly locate base classes, lifecycle hooks, Python binding entry points, and example editor integrations.
Quick Start
Ask for a file-level walkthrough that explains how to create and stage an archetype, how spawning and simulation lifecycles proceed, and how PythonSystem subinterpreters are managed during updates.