Mirage Source 6
Overview

A 2D MMORPG engine built to be forked

MS6 is a full-stack, real-time 2D MMORPG engine: a Colyseus game server, a Phaser client, a Prisma-backed content database, and a standalone admin editor. This documentation is for developers building their own game on top of it — not players.

The core idea: every piece of gameplay behavior that's specific to this game — item effects, spell effects, NPC AI, tile triggers, damage/experience formulas — is reachable through a registry or an injectable Ruleset, not hardcoded into a switch statement you'd have to fork the engine to change. See Behaviors & Rules for the pattern.

What's in the box

  • packages/serverColyseus room, gameplay systems, Prisma content storage, REST API for the admin editor.
  • packages/clientPhaser 3 game client: rendering, movement prediction, UI panels, spell effects.
  • packages/sharedThe pure engine layer both client and server import: enums, packet types, rules/formulas, the registry utility.
  • packages/editorThe standalone admin web app for editing items, NPCs, spells, shops, maps, and accounts.

Where to start

  1. Getting Started — clone it, run it, see it work.
  2. Architecture — the mental model: rooms, systems, registries, the ruleset.
  3. Behaviors & Rules — the flagship page: how to add a new item type, spell effect, NPC behavior, or tile trigger without touching engine source.