Getting started

This section walks developers and curious readers through bringing up a local Splintertree cluster for study and contribution.

Educational project

Splintertree ships no Blizzard data, operates no public realms, and does not recommend running public realms with it. The walkthroughs below are for local development and code study.

• Key concepts — what cluster, realm, instance, map, worker, mod, patch mean inside Splintertree. Read this first.
• Quick start — fire up the full stack with Docker Compose and log in with a 3.3.5a client.
• Installation — toolchain prerequisites, workspace build, native vs. container workflows.
• Deployment — the officially supported Helm / Kubernetes path, plus the Compose dev convenience.

If you only want to read the design, jump to Architecture › Overview.