Documentation

SparkEngine Documentation

Audience: Mixed

Thread Context: Not applicable — documentation index

Platform/Backend Scope: These docs describe implementation and experimental paths. The only declared product set is the blocked, uncertified stable-v1 C++ module slice: Windows 11 x64/MSVC v143, D3D11/Windows NullRHI.

This is the canonical documentation entry point used by sparkengine.dev. SparkEngine's documentation is authored with the engine source, published to this GitHub Wiki, and also packaged into the website's repository-driven documentation bundle.

Start here

Goal	Recommended path
Build and run the engine	Getting Started → Quick-Start Tutorial
Create a first project	Making Your First Game → Creating a Game Module
Build multiplayer gameplay	Multiplayer Quick Start → Networking
Understand the engine	How SparkEngine Works → Architecture Overview
Browse public interfaces	API Reference → Symbol Index
Contribute changes	Build Guide → Contributing

Documentation collections

• Guides — task-oriented setup, authoring, engine, and contributor guides.
• Tutorials — guided first-project, editor, gameplay, and multiplayer walkthroughs.
• Samples and Examples — starter templates and reference game modules.
• API Reference — generated symbol, class, function, enum, macro, file, and hierarchy indexes.
• Build Guide — documented toolchains, prerequisites, presets, and troubleshooting.
• Dependencies — bundled and system dependencies plus audit references.
• Roadmap, Changelog, and project status.

Canonical sources

• Repository wiki source
• Documentation source
• Full navigation

Documentation describes the Working branch unless a page explicitly names a historical snapshot. It does not imply that a versioned release exists.

Source & Freshness

This index is maintained in wiki/Documentation.md; publication pins repository links and the footer to the exact source commit.