Getting Started with Saffron Library

Welcome to the Saffron Library's API documentation. This guide will help you understand the framework and navigate the API reference.

Core Concepts

Systems

Saffron Library is built around decoupled systems. Each system (Audio, UI, Level, etc.) communicates through a central event bus rather than direct references.

Event-Driven Architecture

Everything in Saffron Library communicates through events, commands, and requests. This keeps your code modular and testable.

Contracts Layer

All messaging is defined in the Contracts System—a central place where you define what events exist, what commands you can send, and what data they carry.

Quick Start

1. Understand the Architecture

Start with Contracts System to understand how systems communicate

2. Learn the Core Execution Layer

Then explore how work gets scheduled and executed.

3. Explore Infrastructure

Understand the foundational systems.

4. Dive Into Messaging

Learn the types of inter-system communication.

5. Presentation & Audio

Finally, explore the systems.

API Reference

Browse the full API documentation using the sidebar. Each system is organized by category:

• Contracts — Messaging vocabulary and shared constants
• Execution — Scheduling, coroutines, and flow control
• Infrastructure — Application lifecycle, input, and updates
• Messaging — Events, commands, requests, queries, and signals
• Presentation — Audio and UI systems

Next Steps

• Pick a system and dive into its API reference
• Look at code examples in your game project
• Integrate Saffron Library into your workflow!

Questions? Check the individual system documentation or reach out on GitHub (opens in a new tab).