Syphax Engine Documentation

Syphax Engine is a C framework for interactive visuals, games, and tools.

Start with setup and first run

Follow one concept per page

Use example walkthrough pages

Jump to module guides and API pages

Quick links

• Install and build
• First window
• Path overview
• Window path page
• Examples index
• Module guides
• API reference
• Glossary

Documentation map

• Start Here: setup and first-run pages.
• Path: ordered pages that each explain one concept.
• Examples: one page per runnable target.
• Module Guides: usage-oriented pages mapped to API modules.
• Path walkthroughs: progressive four-step module pages with compileable snippets.
• API Reference: generated declaration pages from public headers.

Build this docs site locally

python3 -m venv .venv
source .venv/bin/activate
pip install -r docs/requirements.txt
./scripts/docs/build.sh