Skip to content

CLAUDE.md

Latest commit

 

History

History
103 lines (77 loc) · 4.2 KB

CLAUDE.md

File metadata and controls

103 lines (77 loc) · 4.2 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

Dominus is a multiplayer browser-based social strategy game built with Meteor.js. Players conquer castles, form feudal hierarchies (king/lord/vassal), and compete to dominate the map. Army movement and resource gathering are time-based (asynchronous gameplay).

Development Commands

# Install dependencies
meteor npm install

# Run locally (requires MongoDB running)
meteor run --settings settings.json

# Build for production
meteor build .build --architecture os.linux.x86_64
# Run tests (from a second terminal while the app is running)
meteor shell
# Then in the shell:
Meteor.call('runGameCreationTests')

Tests are defined in server/gameCreationTests.js and run as a Meteor method. Results print to the server console and return as an object to the shell.

Environment Variables

Required: MAIL_URL, S3ACCESSKEYID, S3SECRETACCESSKEY, DOMINUS_WORKER=true, DOMINUS_ADMIN_EMAIL, DOMINUS_TEST=false

Optional: DOMINUS_REDIS_HOST, DOMINUS_REDIS_PORT

Architecture

Package-Based Modular Monolith

The core application logic lives in 34 custom Meteor packages under packages/. Each package encapsulates a game feature domain and follows this internal structure:

packages/dominus-<feature>/
├── package.js          # Manifest: dependencies, exports, file loading order
├── both/               # Shared client+server code
│   ├── namespace.js    # Global namespace object (e.g., dCastles = {})
│   ├── *Methods.js     # Meteor.methods() RPC definitions
│   └── *Functions.js   # Shared business logic
├── server/
│   ├── publish*.js     # Meteor.publish() data subscriptions
│   ├── *ServerMethods.js
│   ├── *ServerFunctions.js
│   ├── *Job.js         # Bull queue background jobs
│   └── indexes.js      # MongoDB index definitions
└── client/
    ├── *.html          # Blaze templates
    ├── *.js            # Template helpers and event handlers
    └── *.less          # Component styles

Key Package Domains

  • Game core: dominus-game, dominus-control, dominus-init
  • Entities: dominus-castles, dominus-villages, dominus-armies, dominus-capitals
  • Combat: dominus-battles
  • Economy: dominus-income, dominus-market
  • Map: dominus-hexmap, dominus-mapmaker, dominus-mapbaker, dominus-minimap, dominus-mappather
  • Social: dominus-chat, forum-*
  • Data: dominus-collections (defines all 25+ MongoDB collections)
  • Background processing: dominus-queue (Bull/Redis job queue)
  • Admin: dominus-admin

Top-Level Directories

  • client/ - Meteor client entry: main HTML, body template, account handling
  • server/ - Meteor server entry: startup, account hooks, user publications
  • lib/ - Shared utilities and client router (SimpleRouter)
  • game/ - Game UI templates (left/right panels, navigation, settings)
  • alert/ - Alert notification system UI
  • public/ - Static assets

Client-Server Communication

  • Meteor Methods: RPC calls defined in *Methods.js files, validated with check(), rate-limited via DDPRateLimiter
  • Pub/Sub: Server publishes via Meteor.publish(), clients subscribe with Meteor.subscribe()
  • Routing: SimpleRouter (danimal:simplerouter) maps URLs to Blaze templates via Template.dynamic

Background Job System

Uses Bull (Redis-backed queue) with 40+ job types for async game mechanics: army movement, income collection, battle resolution, map baking. Jobs are defined in *Job.js files within packages. DOMINUS_WORKER=true env var enables background processing. SyncedCron handles distributed scheduling.

Tech Stack

  • Framework: Meteor.js with Blaze templating
  • Database: MongoDB (via Meteor's mongo package)
  • Queue: Redis + Bull
  • CSS: LESS + Bootstrap 3
  • Client libs: jQuery, D3.js (v3), Moment.js, Underscore.js
  • Auth: Meteor accounts with password, Google OAuth, Facebook OAuth
  • Payments: Stripe
  • Email: SendGrid / Mandrill
  • Deployment: Docker, served on port 80 via node main.js