How glassesneo/saohime works
Main Components
• Core Engine: Include the Application instance (src/saohime/core/application.nim), core types (saohime_types.nim), exceptions, and helper modules (like sdl2_helpers.nim). This forms the heart of the engine.
• Plugin System: Show the extensible plugin architecture (present in src/saohime/plugins) which hosts dedicated plugins like asset, camera, event, graphics, render, sdl2, times, transform, and window. Also note the default plugins loaded from default_plugins.nim.
• Entity Component System (ECS): Represent the underlying ECS integration (with ecslib) that ties into the creation of entities, the attaching of components, and the registration of systems.
• System / Game Loop: Indicate the processing flow for events, updates, rendering, and system execution (e.g., as shown by the example usage in the README where multiple systems such as pollEvent, randomCircles, and increaseRadius are registered).
• External Dependencies: Identify external technologies such as SDL, SDL_image, SDL_ttf for rendering, as well as OpenAL (via slappy) for audio, and integrations like Lua through spellua.
• Example Applications: Optionally include the sample projects (example_app and examples) to illustrate practical usage of the engine.
Relationships and Data Flow
• “ECS/World” which is responsible for managing entities and components. This block should be linked with the systems registered by both the core engine and the plugins.
Adjustments Specific to This Project
• Since this is a full-stack engine that offers both core functionality and an extensible plugin system, emphasize the interplay between the central ECS loop and the various plugin modules.
• A block for “Example Applications” to illustrate how the engine is used practically. This could be shown as usage examples that receive input from the outside (e.g., server.py, example_app) and display how systems (like pollEvent, randomCircles) are utilized.
• Unique elements shown in the file tree such as “config.nims” or build/deployment scripts (.nimble file), noting how they support the build and deployment process rather than runtime behavior.