Home - Krystian-L-Lis/Stage GitHub Wiki
Guide
1. Rationale
Explains the motivation behind the library and its philosophy. Also check: Conventions.
2. Debug
Introduces tools for structured logging, debugging, and context-aware messaging.
3. Result
Describes the lightweight error handling system (Result) and simplifies loop management.
4. Runtime
Covers automated function block execution and the initialisation lifecycle.
5. Entities and Components
Explains the modular Entity-Component system for object and data management.
6. Strings
Demonstrates tools for building, formatting, and manipulating strings.
7. Tags
Highlights the identification mechanism for EC and path-based reflection.
8. Broadcast
Describes decoupled, event-driven communication with Signal and Receiver.
9. States
Outlines the modular state pattern for predictable and scalable system behaviour.
10. Jobs
Shows how to use workers and jobs to spread workload over multiple cycles or start some parallel processes.
12. API Reference
- Broadcast: Methods for event-driven programming.
- Debug: Tools for logging and troubleshooting.
- Entities and Components: APIs for entities, components, and object management.
- Result: Core tools for error handling.
- Jobs: Handles parallel processing and execution.
- Runtime: Initialisation and cyclic execution tools.
- State: State management and transition APIs.
- Strings: String builder and formatter utilities.
- Tags: Tools for identification and reflection.
- Utils: Miscellaneous helper functions and utilities.