Realms: Eternum & Blitz

Eternum is the foundational game for Realms World — a living digital ecosystem that evolves through player interaction. It serves as both a game and an open platform.

• Community: https://discord.gg/realmsworld
• Repo docs index: docs/README.md
• Official docs site source: client/apps/game-docs

Choose your path

I’m here to play / learn the game

• Start with the docs site: client/apps/game-docs

I’m here to build (developers)

• Setup: see Prerequisites + Setup below
• Contributing: CONTRIBUTING.md
• Contracts: contracts/
• Packages/SDK: packages/

I’m here for architecture / internal notes

• See docs/

---

Project Structure

• Client - React apps built with Vite
  • Game - Main game client with Three.js interface
  • Landing - Landing page
  • Game Docs - Game documentation
  • Balancing - Game balancing tools
• Contracts - Cairo/Dojo smart contracts
• Packages - Shared libraries
  • Core - Eternum SDK
  • Provider - Game contract interactions
  • React - React hooks and components
  • Torii - On-chain data querying
  • Types - Type definitions
• Config - Configuration and deployment scripts

Realtime communication

The realtime work plan was moved out of the README to keep this page focused:

• docs/roadmap/realtime.md

Packages overview

For package-by-package docs, see:

• packages/README.md

Prerequisites

• Dojo v1.0.4
• Node.js
• pnpm v9.12.3
• Bun

Setup

1. Install Dojo:

curl -L https://install.dojoengine.org | bash

2. Install pnpm:

npm install -g pnpm

3. Install dependencies:

pnpm install

4. Build shared packages:

pnpm run build:packages

Development commands (common)

• pnpm dev - Start game development server
• pnpm dev:docs - Start documentation dev server (Vocs)
• pnpm build:packages - Build shared packages

License

MIT