Cheryl Engine

Build a game with Cheryl’s application lifecycle, input actions, retained assets, and rendering interfaces. Set up your project, then follow the first-game walkthrough from startup and resource ownership to sprites and text on screen. Use the task guides and generated reference as you add features.

You want to…	Start here
Connect a new game to the engine	Project setup.
Learn by building a working example	Tutorials, beginning with First game.
Complete a specific operation	Task index.
Understand a feature’s contracts and design choices	Guides by topic.
Find a subsystem’s public types or exact declaration	Engine Systems, then the C++ API.
Change the engine or an integration	Contributing and its owner-specific checks.

API Reference

• C++ API

Game Development

• Project setup
• Tutorials
  • First game
  • Actor controllers and commands
  • PlayerController
  • Character
  • AIController
  • UIController
  • HUD with TGUI
  • Event
  • Abstract controller interfaces
• Task index
• Guides by topic
  • Assets and animation
    • Load and publish assets
    • Author graphics manifests
    • Play sprite animation
    • Animate sprites and select tiles
    • Discover files and font candidates
    • Install optional artwork packages
  • Rendering and resources
    • Draw a whole image
    • Position objects with a camera
    • Submit frames and configure materials
    • Manage caches, publication and retirement
    • OpenGL backend reference
  • Input
    • Bind input actions
    • Actions, records, capture and focus
  • Text and fonts
    • Display and update text
    • Configure fonts and prepare text
    • Decode UTF-8 and interpret source indices
    • Use legacy bitmap fonts
  • GUI
  • Audio
    • Control playback and ownership
    • miniaudio reference
  • Runtime and concurrency
    • Ownership and cleanup
    • Threads and data flow
    • Initialize, run and stop a session
    • Choose simulation timing and recovery
    • Observe and operate windows
    • Deliver typed events
    • Dispatch to an owner thread
    • Configure worker pools and groups
    • Application startup reference
    • Worker configuration and topology
    • Native GLFW platform reference
  • Memory, state and utilities
    • Use pools, reservations and release contexts
    • Track state and use time, number and geometry helpers
  • Logging and diagnostics
    • Configure logging and investigate missing records
    • Investigate runtime and resource symptoms
    • Handle native and cleanup failures
    • Linux output viewer
• Engine Systems

Engine Development

• Contributing
• Build the engine and SDKs
• Module authoring
• Testing and validation
• Documentation tooling
• CI and SDK artifacts