BlueGit

timfa questward

Files

questward / tile_mmo_server_technical_design_v0.6.md

tile_mmo_server_technical_design_v0.6.md

tile_mmo_server_technical_design_v0.6.md 131.6 KiB Download Raw

--- title: Tile MMO Server Technical Design version: 0.12 status: proposed format: living-design-document ---

Tile MMO Server Technical Design

Version: 0.12 Status: Proposed architecture; intended to be iterated as implementation decisions are made. Scope: Authoritative Node.js/ECS backend, FrameworkV3-based game client (16×16 sprites, player-centered viewport), chunk/region streaming, SQLite persistence, admin world editor with per-chunk changelogs, player inventory and items, combat, player communication, banking/cheques, shopkeepers, marketplace/economy systems, skill progression, automatic restart/update orchestration, and future player scripting hooks.

1. Design goals

  • Support a large tile-based MMO world without simulating unused areas.
  • Keep the server fully authoritative: clients send actions and

intentions, never authoritative state changes.

  • Authenticate accounts via auth.timfalken.com (with an admin-<n> stub

until that service is live). An account may have unlimited characters, one in the world at a time, with delayed deletion and an inheritance bank tab.

  • Use ECS composition for entities and systems, while using chunks and

regions for spatial ownership and simulation lifecycle.

  • Allow simulation work to scale across Node.js workers and permit

entities to cross worker-managed region boundaries safely.

  • Keep client replication small: a player receives only the current

16×16 chunk and the eight neighbouring chunks.

  • Keep authored world data separate from ephemeral simulation state.
  • Persist only entities that explicitly need persistence; ordinary

spawned mobs disappear when their chunk is unloaded.

  • Avoid constant chunk writes. Normal chunk persistence occurs on

unload; graceful shutdown is implemented as a forced unload of all resident chunks.

  • Provide an admin-only graphical world editor for painting tiles,

opening or closing chunks, and placing/configuring spawners, with a per-chunk changelog of who changed what and when. Unedited chunks are grass-only and closed.

  • Automatically schedule a graceful midnight restart when live code or

authored world data changes, with an admin-triggered immediate restart path.

  • Reserve a clean control abstraction for a later sandboxed player

scripting language without requiring the scripting system in the initial release.

  • Build the player-facing client on the shared FrameworkV3 library, vendored

as a git submodule and built first so game-specific client code can layer on top of it, while keeping the server-side ECS an implementation detail of the backend. World sprites may be any size; each uses a centred pivot 8 pixels from the sprite bottom. The play viewport stays centered on the local player.

  • Authoritative movement is tile-to-tile at a global walk/run cadence

(default walk 2 tiles/s, run double), not a per-mob speed. Admins edit that cadence and other tick timers in a world-settings modal. World calendar time is server time minus 1200 years. At night the client darkens unlit tiles; static light reach is baked by raycast when a chunk is saved.

  • Give every player a 32-slot inventory in which stackable items occupy a

single slot, and treat dropped items as temporary, non-blocking ground objects rather than tile occupancy.

  • Make ordinary communication spatial rather than global: nearby speech is

progressively degraded by distance, while long-distance exchange is a physical item or currency delivery by carrier pigeon. A letter is simply a paper item with player-written text.

  • Support persistent player groups without turning them into an instant

long-distance chat channel.

  • Provide a shared, unlimited player bank near the marketplace, with later

banks all reading the same vault, plus bearer cheques and free pigeon deposits.

  • Make the central marketplace an order-matching service rather than a public

auction list, with durable escrow and asynchronous pigeon delivery.

  • Keep the economy predominantly player-driven: most ingredients are gathered,

final goods are normally crafted by players, and finished-item drops come from enemies/bosses rather than ordinary NPC shops.

  • Let every combatant — players and other mobs — attack. Melee requires an

adjacent tile including diagonals; ranged attacks and spells use the range of the weapon or spell. A hit roll uses the weapon skill; damage uses Strength, Dexterity or Mind. Attack XP is split equally between those two skills.

  • Let shop NPCs sell items at a seed value that lerps toward the last

player-market sale price over a configurable duration (default one hour), with a hidden per-shop discount. Item inspection shows name, description, origin and the undiscounted current value, refreshed at most once per minute.

  • Use skill-based progression with no player classes. Every gameplay action is

governed by a skill and awards XP to that skill when successfully performed. Combat is the explicit dual-skill exception: hit skill and damage skill share the XP.

2. Core world model

2.1 Spatial hierarchy

World └── Region: 4 × 4 chunks └── Chunk: 16 × 16 tiles └── Tile

One chunk contains 256 tiles. One region is 64×64 tiles and contains 16 chunks (4,096 tiles). World tile coordinates are canonical; chunk and region coordinates are derived from them.

chunkX = floor(tileX / 16) chunkY = floor(tileY / 16) regionX = floor(chunkX / 4) regionY = floor(chunkY / 4)

If negative world coordinates are allowed, use true floor division rather than JavaScript integer truncation.

2.2 Three independent spatial states

The design deliberately separates region residency, chunk simulation, and client visibility.

ConcernUnitMeaning
ResidencyRegionWhether the region and its required chunk data exist in server memory and have a worker owner.
SimulationChunkWhether ECS systems actively simulate entities and gameplay in this chunk.
VisibilityChunkWhether a specific client is subscribed to the chunk and receives its snapshot/deltas.

2.3 Region states

UNLOADED ↓ load RESIDENT ↓ no residency references + grace period UNLOADED

A resident region is assigned to exactly one simulation worker. An unloaded region has no active ECS representation.

2.4 Chunk states

DORMANT ⇄ SIMULATING

A dormant chunk can remain resident in memory while normal gameplay systems ignore it. A simulating chunk participates in movement, combat, AI, spawners and other active systems.

3. Tile layers and occupancy

3.1 Ground layer

Every tile has a ground type. Ground is visual only. It does not by itself block movement, cause collision, or create gameplay behaviour.

TileGround { groundTypeId: GroundTypeId }

3.2 Block layer

A tile may also contain one block. The block is the actual world object standing on the tile and can determine collision and behaviour.

TileBlock { blockTypeId: BlockTypeId \| null config?: BlockConfig }

Examples include walls, doors, trees, torches and other lights, containers, spawners, marketplace counters and banks. Block definitions determine properties such as passability, interaction behaviour, whether a block participates in navigation, and whether it emits light (lightRangeTiles).

3.3 MOBile entities

A moving game entity — player, enemy, animal, NPC or any other mobile actor — is represented by an ECS entity rather than being painted into the static tile map. A mobile entity may inhabit a tile in addition to the tile’s ground and block layers, subject to collision rules.

Tile ├── Ground (visual layer) ├── Block (static/world-object layer; optional) ├── Ground item stacks (ephemeral, non-blocking) └── Mobile ECS entities (dynamic occupancy)

The spatial chunk index maintains which mobile entity IDs currently occupy each tile, allowing collision, nearby queries and replication without scanning the global ECS. Ground item stacks are indexed per tile as well, but they never contribute to movement collision and never prevent a mobile entity from standing on that tile.

4. ECS model

4.1 Entity composition

Entities are numeric identities plus components. Behaviour comes from systems querying component combinations rather than deep class inheritance.

Player Position Movement Health Combat Skills Inventory Currency Equipment Player NetworkIdentity ChunkLoader Persistent

Ordinary enemy Position Movement Health Combat Skills Creature AI

Named NPC Position Movement Health NPC AI Persistent

4.2 Global identity versus local ECS handle

Use a globally meaningful EntityId for storage, networking and cross-worker transfer, and a compact worker-local EntityHandle for hot ECS arrays. A transferred entity keeps its EntityId but may receive a different local handle on the destination worker.

4.3 Recommended initial components

CategoryComponents
SpatialPosition, Movement, Path, Collision
LivingHealth, Combat, Creature, Mob, Skills
PlayerPlayer, NetworkIdentity, Inventory, Currency, Equipment
AIAI, Target, BehaviourState
LifecycleChunkLoader, Persistent, SpawnOrigin
PresentationRenderable / Appearance
Future controlController / ScriptController / OfflineUntil

5. ChunkLoader and simulation activation

5.1 Generic ChunkLoader component

World activation is component-driven rather than player-specific. Any entity may carry a ChunkLoader component that says “keep the surrounding world resident and simulated”.

ChunkLoader { simulationRadiusChunks: 1, regionLoadRadius: 1 }

A normal player can therefore stimulate a 3×3 chunk area while keeping the surrounding 3×3 regions resident. Bosses, travelling NPCs, machines, scripted actors or administrative anchors can use the same mechanism.

5.2 Reference counting

Chunk simulation and region residency should use reference counts. Overlapping loaders increment the same references; leaving decrements them. A chunk sleeps only when its simulation reference count reaches zero. A region becomes eligible for unload only when its residency references reach zero.

5.3 Grace period

After the last residency reference disappears, retain the region briefly before unloading. This prevents repeated SQLite reads and writes when a loader oscillates around a boundary. The delay should be configurable.

6. Chunk lifecycle and persistence

6.1 No periodic chunk saves

Normal gameplay does not periodically rewrite loaded chunks. A chunk is saved as part of the unload path only.

Resident chunk ↓ last residency / forced shutdown unload Prepare unload ↓ Persist required chunk state once ↓ Persist required entities ↓ Remove ECS/runtime representation

A graceful server restart does not introduce a second save mechanism. It force-unloads every resident region/chunk, so the normal unload persistence path remains the single source of truth.

6.2 Persistent versus non-persistent entities

Persistence is an entity property, not a property of the chunk or spawner. An entity with Persistent is serialised when its owning chunk/region unloads. A non-persistent entity is simply discarded.

Non-persistent wolf spawn → simulate → chunk unload → disappear

Persistent named NPC load → simulate → chunk unload → save → recreate when area loads

6.3 Persistent is independent of ChunkLoader

These traits must remain independent. A persistent entity does not automatically keep its area active, and a ChunkLoader does not automatically become persistent.

7. Storage architecture

7.1 Separate authored world and runtime state

Use two SQLite databases with different responsibilities.

DatabaseResponsibility
world.sqliteAdmin-authored ground tiles, block tiles, light maps, world settings, spawner configuration, per-chunk editor changelogs, world revisions and world metadata.
state.sqliteAccounts, characters, inventories, carried currency, character vaults, inheritance tabs, cheque reservations, skills, groups, courier cargo/transit, unexpired ground items, market orders/escrow/trades, per-item last player-market sale, persistent ECS entities, offline-script state, optional persistent runtime chunk overrides, and other durable live-game state.

This prevents editor authoring changes from becoming entangled with live player/entity persistence.

7.2 Chunk writes in runtime state

If initial gameplay does not allow permanent tile/block modification, runtime chunks require no writes at all. If permanent runtime world changes are later added, dirty chunk overrides are held in memory and written to state.sqlite only when that chunk unloads. Shutdown uses forced unload and therefore follows the same rule.

7.3 Central persistence service

Simulation workers should not independently compete for SQLite writes. A persistence service owns the write connection, batches transactions, and receives logical save requests from workers.

Simulation workers │ save/unload messages ▼ Persistence service │ ▼ SQLite (WAL)

Live ECS state remains authoritative while loaded; SQLite is durable state, not a per-tick synchronisation mechanism.

8. World authoring and revision model

8.1 Admin-only world editor

The server includes a separate admin-only world editor UI. It is not part of the normal player client.

  • Display a 3×3 of 16×16 chunks, with the currently selected

chunk in the centre and a red border around that chunk. Painting, open/closed, and changelog apply only to the selected chunk; neighbours are visible for alignment and baked lighting context.

  • Provide Up, Down, Left and Right navigation buttons that move the

editor exactly one chunk in that direction.

  • Show the current chunk coordinates prominently, and whether the chunk

is open or closed.

  • Toggle the current chunk open or closed. Closed chunks remain visible

to nearby players but cannot be entered.

  • Allow painting a ground type on a tile.
  • Allow painting, replacing or erasing the block type on a tile.
  • Render both layers together so the block appears on top of the ground.
  • Do not display ordinary mobile entities as editable map paint.
  • Allow selecting/configuring special block types such as Spawner, Bank,

Marketplace and light-emitting blocks (lightRangeTiles).

  • Open a world settings modal for global tick timers and constants

(movement cadence, shop lerp duration, drop lifetime, and other values listed in section 8.5).

  • Provide a night-to-day slider that only previews lighting; it does

not change live world time. Preview uses the same baked light maps as play, including light that reaches this chunk from neighbouring chunks.

  • Later: allow configuring ground-item spawners analogously to mob

spawners. Exact item tables remain a later content decision.

  • Save changes through an authenticated admin API; the browser never

opens SQLite directly.

  • Show that chunk's changelog: a chronological list of saves, each with

which admin made the edit, when, and a bullet-point diff of the change.

The editor camera is not locked to a player character. It frames the currently selected chunk. This is the only intended exception to the player-centered play viewport in section 21.4.

8.2 World editor save behaviour

Saving a chunk or world settings writes the authored result to world.sqlite. It does not live-patch the currently running simulation. Instead, the change creates or updates a pending world revision and schedules a server restart for the next server-local midnight.

The running game remains pinned to the world revision selected at its own startup. This avoids a dangerous mixed state where some loaded chunks use old authored data and newly loaded chunks use newer editor data.

8.3 Versioned authored chunks

A practical schema is to give every editor change a monotonically increasing world revision. The game process pins one active revision for its entire lifetime. Chunk lookup selects the latest authored version not newer than that pinned revision.

world_revisions revision_id created_at created_by status // pending / active / superseded

world_chunk_versions chunk_x chunk_y revision_id open // player-enterable; default false until set data_blob

world_meta active_revision pending_revision

world_settings revision_id settings_blob // walk speed, tick timers, shop lerp, drop TTL, ...

world_chunk_edit_log log_id chunk_x chunk_y revision_id editor_admin_id edited_at diff_entries // structured bullets for this save

On the next planned restart, startup promotes/selects the latest valid pending revision before world loading begins.

8.4 Per-chunk changelog

Every successful chunk save appends one changelog record for that chunk. The record is durable in world.sqlite and is not gameplay state.

The server diffs the newly saved chunk against the previous authored version of that same chunk (the latest world_chunk_versions row for those coordinates that this save replaces). Unchanged tiles produce no bullets. Each changed tile becomes one of:

- Ground at X, Y changed from Prev to New.
- Block <type> placed at X, Y.
- Block at X, Y changed from Prev to New.
- Chunk opened.
- Chunk closed.

X, Y are world tile coordinates. Prev / New / <type> are the ground or block definition display names. A block paint on an empty block layer is a placement. Replacing one block type (or its config, such as a spawner) with another is a change. Erasing a block is a removal. Ground is never absent; a ground paint is always a change from one type to another.

The editor UI lists records newest-last or newest-first consistently, each headed by admin identity and timestamp, with that save's bullets underneath. The changelog is an audit trail, not an undo stack. Undo/redo remains an open editor-UX decision. Derived light maps are not changelog bullets; they are regenerated on save (section 8.6).

8.5 World settings

Global gameplay constants live in authored world_settings for the world revision. They are not per-mob and not client-authored. Admins edit them from a modal in the world-editor UI. Saving the modal writes into the pending world revision and schedules the same midnight restart as a chunk save. The running process keeps the settings it loaded at startup.

Minimum initial settings and defaults:

WorldSettings
- walkTilesPerSecond          // default 2
- simulationTickHz            // default 20; implementation default, still a setting
- shopPriceLerpDuration       // default 1 hour
- groundItemDespawnDuration   // default 10 minutes
- regionUnloadGracePeriod     // configurable grace after last residency
- defaultGroundTypeId         // grass used for never-edited chunks
- characterDeletionDelay      // default 24 hours

Running is always double walking speed. It is not a separate per-entity field. From walkTilesPerSecond:

runTilesPerSecond   = walkTilesPerSecond * 2     // default 4
movementTickHz      = runTilesPerSecond          // default 4 Hz
walk: commit a tile every 2 movement ticks
run:  commit a tile every 1 movement tick

All ground mobiles — players, enemies, NPCs — use this same cadence. A mob definition does not set move speed. Gait (walk | run) is the only per-entity choice; it selects every-other vs every movement tick.

Other tick-duration constants that already exist in this document (shop lerp, ground-item despawn, residency grace, and later ones of the same kind) are edited here rather than hardcoded. Adding a new global timer means adding a field to WorldSettings and a row in this modal.

8.6 Baked lighting

Light from authored blocks is precomputed when a chunk is saved, not raytraced every simulation tick.

A block definition may set lightRangeTiles > 0. That tile is a static light source. Light travels only through passable tiles (the same passability as walking). Ground type does not block light. Mobiles and ground items do not block light.

For every tile within a source's range, the baker runs a simple grid raycast (for example Bresenham through tile centres). If the ray hits an impassable block before the destination, that source does not light that tile. A tile is lit if any source can reach it. Light does shine across chunk boundaries.

Saving a chunk rebakes:

1. that chunk's 16×16 light map, and 2. every neighbouring chunk that could be affected (chunks within the maximum lightRangeTiles of the saved chunk).

Neighbor rebakes use light sources and walls from the pending revision, including the chunk just saved. Those neighbor light maps are written into the same pending revision so play never mixes old and new lighting.

The light map is stored in the chunk data_blob as a 16×16 intensity (0 = unreachable, 1–255 = falloff by distance from the strongest reaching source). The client darkens tiles by that intensity at night, so a torch fades tile-by-tile rather than lighting a hard disc. It is replicated to clients in CHUNK_SNAPSHOT / CHUNK_DELTA.

Runtime door open/close does not rebake static light unless a later iteration adds live lighting. Baked light is authored geometry.

The editor night-to-day slider interpolates preview ambient from full night (dark except baked-lit tiles) to full day (no ambient darkening). It does not persist and does not change server/world clock.

8.7 Default chunks and open / closed

A chunk the editor has never saved does not exist in world_chunk_versions. At runtime it is synthesised as:

  • every tile defaultGroundTypeId (grass),
  • no blocks,
  • closed,
  • no baked lights.

The world is therefore an infinite grass field until admins paint it, and players cannot walk onto it until an admin opens the chunk.

Closed chunks can still appear in a player's 3×3 view. They cannot be entered: MOVE_TO, pathfinding, spawning, and other player-entry actions treat every tile in a closed chunk as impassable. Visibility and lighting previews are unchanged. Where an open chunk shares an edge with a closed (or never-edited) chunk, the client draws a red border on that edge so players can see they cannot cross.

Open chunks are the playable map. Opening or closing is an authored chunk flag, saved with the pending revision like paint.

Spawners in a closed chunk do not spawn. Ground movement, including AI, does not step into a closed chunk. If a future bug or admin tool places an entity there, it can still be replicated to observers, but players cannot walk in after it.

9. Spawner blocks

9.1 Spawner data

A Spawner is a block in the authored block layer, with per-instance configuration stored as part of the chunk data.

SpawnerConfig { spawnerId: SpawnerId, mobTypeId: MobTypeId, maxAlive: number, spawnRangeTiles: number }

Additional parameters such as minimum/maximum spawn delay can be added later without changing the core model.

9.2 Spawner editor

Selecting a Spawner tile in the world editor opens a configuration panel containing at minimum: mob type, maximum alive count and spawn range. Validation happens server-side before the pending world revision is written.

9.3 Spawned entity persistence

The spawner never decides whether its mob is persistent. The mob definition/archetype does. When the spawner creates an entity, the entity receives Persistent only if that mob type is defined as persistent.

MobDefinition: deer persistent = false

MobDefinition: named_guard_captain persistent = true

9.4 SpawnOrigin

Spawned mobs receive a SpawnOrigin component referencing the spawner. This lets maxAlive count only entities belonging to that spawner and avoids expensive geometric searches.

SpawnOrigin { spawnerId: SpawnerId }

For non-persistent mobs, disappearance on chunk unload naturally decreases the count. For persistent mobs, SpawnOrigin is persisted so the spawner can recognise an existing persistent instance even after it has moved or been unloaded elsewhere. A lightweight persistence index by spawnerId prevents duplicate persistent spawns.

9.5 Spawner simulation

SpawnerSystem runs only while the spawner’s chunk is simulating and open, and at a much lower frequency than movement. A spawn candidate must satisfy block collision, bounds, an open chunk, and mobile-occupancy rules. Ground type does not affect passability unless a later gameplay system explicitly introduces a separate rule for it.

9.6 Future ground-item spawners

Some items will later spawn naturally on the ground, using a world-editor block analogous to a mob spawner. Those spawned stacks should use the same non-blocking ground-item representation as player drops, but their lifetime, respawn and maxOnGround rules belong to the spawner configuration rather than the 10-minute player-drop timer.

Exact item lists, harvest interactions and spawner parameters are later content decisions and do not block the inventory/bank model.

10. Startup and loading order

Loading order is explicit so authored world state exists before persistent entities are instantiated into it.

> 1. Start process and load configuration, including server time > zone and storage paths. > > 2. Open world.sqlite and validate/migrate its schema. > > 3. Select/promote the world revision to use for this process and > pin it for the lifetime of the process. > > 4. Load static registries: ground definitions, block definitions, > item definitions, material definitions, spell definitions, mob archetypes and component serializers. > > 5. Open state.sqlite and run runtime-state migrations. > > 6. Start the persistence service, durable domain services (such as courier, bank, market and shop-price services when enabled), region coordinator and simulation workers. > > 7. Load the index of persistent entities that themselves require > world activation (for example persistent ChunkLoaders or future > offline scripted players). > > 8. For each required region, load authored chunk data from the > pinned world revision first. > > 9. Apply any durable runtime chunk override state, if the game > supports such modifications. > > 10. Instantiate persistent entities into the already-created > world/chunks. > > 11. Recalculate ChunkLoader references and begin chunk simulation. > > 12. Only after the world reports READY does the gateway accept > normal player logins.

This ordering solves the bootstrap problem for persistent entities that keep their own chunks active: a compact persistence index can locate them without first loading the entire world.

11. Simulation workers and region ownership

11.1 Ownership invariant

Exactly one worker authoritatively owns a region at any instant. Every authoritative entity belongs to the worker that owns the entity’s current region.

11.2 Coordinator

A central region coordinator maintains RegionId → WorkerId and assigns/migrates regions based on actual measured simulation effort, while preferring neighbouring regions on the same worker when load permits.

11.3 Work measurement

  • Average and high-percentile tick execution time.
  • Number of simulating chunks.
  • Number of active entities and AI entities.
  • Pathfinding work and queued searches.
  • Cross-worker boundary message volume.
  • Backlog / tick lateness.

Actual time spent simulating is more important than raw player count or raw region count.

11.4 Node.js implementation

Start with Node.js worker_threads for simulation workers. Keep mutable ECS worlds isolated per worker and use message passing between them. Do not begin with a shared mutable ECS in SharedArrayBuffer.

12. Cross-worker communication

12.1 No remote mutation

A worker may inspect a limited read-only representation of neighbouring entities but never directly mutates authoritative state owned by another worker.

12.2 Border ghosts

Neighbouring workers can exchange compact border/ghost entity data for nearby interaction and AI: EntityId, position, collision footprint, type and minimal combat metadata. Ghosts are not full ECS entities and are never authoritative.

12.3 Remote actions

Worker A goblin targets Player 42 (owned by Worker B) Worker A → REMOTE_ACTION(attack intent) → Worker B Worker B validates range/state and applies authoritative result

12.4 Entity transfer

When an entity crosses from a region owned by Worker A into one owned by Worker B, ownership is handed off at a simulation tick boundary using a sequence-numbered transfer protocol. There is never more than one authoritative copy.

A: prepare transfer B: validate / accept A: freeze at handoff boundary B: instantiate authoritative entity at effective tick Coordinator: update ownership mapping A: remove authoritative copy

13. Server tick and stimulation

13.1 Fixed simulation tick

Use a fixed server simulation tick. The default is 20 Hz (50 ms), stored as WorldSettings.simulationTickHz. This is not a protocol promise.

Movement does not commit a new tile on every simulation tick. See section 13.4.

1\. Drain validated incoming commands 2. Apply completed worker/entity transfers 3. Recalculate activation changes 4. Movement / collision 5. Combat 6. Scheduled AI 7. Scheduled spawners/environment, including ground-item expiry in simulating chunks 8. Produce cross-worker messages 9. Produce client replication deltas 10. Queue unload/persistence work

13.2 Different system frequencies

Not every ECS system should run every tick. Ground movement commits only on the global movement cadence (section 13.4). AI decisions, target searches and spawner checks can run at lower frequencies. Sleeping chunks are not “slow ticked”; they are omitted from normal simulation.

13.3 Timestamp-based inactive progression

Long-lived timers such as growth, cooldowns, ground-item expiry and shop price lerps should store future timestamps where possible. When an area wakes, the system catches up from the timestamp instead of executing missed ticks. An expired ground item is discarded on catch-up without ever reappearing. Shop and tooltip prices are evaluated from last-sale timestamps when observed; they are not ticked. Durations such as shop lerp and ground-item despawn come from WorldSettings, not from hardcoded literals in systems.

13.4 Global movement cadence

All ground-moving entities share one walk speed and one run speed.

  • Default walk: 2 tiles per second (walkTilesPerSecond).
  • Run: always double walk (default 4 tiles per second).
  • Movement ticks fire at runTilesPerSecond (default 4 Hz).
  • Walk: the entity may advance one path tile on every other movement

tick.

  • Run: the entity may advance one path tile on every movement tick.

Mobs do not define their own move speed. Movement.gait is walk or run. Players send SetGait. AI may set gait; it still uses the global cadence. Flying pigeon transit is not this cadence; it keeps its own route clock.

If the path is blocked on a movement tick, the entity stays on its tile and retries on a later legal tick. Occupancy, combat range and pickup always use the last committed tile.

13.5 World calendar time

World time is server time 1:1, in the same configured IANA zone used for midnight restarts, with 1200 years subtracted from the calendar date. A server clock of 24 Aug 2026 21:00 is world 24 Aug 826 21:00. Clock-of-day, including night, therefore matches the host's zone.

The gateway includes current world time (or server unix time plus the year offset) in the status sent to clients so shading does not depend on the player's device clock. Lighting is presentation; combat and movement do not wait on the day/night overlay.

14. Client gateway and authority

14.1 Stable connection ownership

Client WebSocket/TCP connections belong to a gateway rather than simulation workers. When the player crosses into a region owned by another worker, the socket stays connected to the same gateway; only internal routing changes.

14.2 Client commands are intentions

A client sends commands such as MoveTo, Interact, Attack, UseItem, EquipItem, UnequipItem, SelectSpell, SetGait, DropItem, PickupItem, BankDeposit, BankWithdraw, BuyFromShop or SendPigeon. The authenticated account determines the actor; after character select, commands apply to that account's active character. The client never supplies an authoritative resulting position, health value or inventory result.

14.3 Input queue

Socket handlers validate message shape and enqueue commands. Simulation workers consume commands at tick boundaries. WebSocket callbacks do not mutate ECS state directly.

14.4 Authentication

Live login uses auth.timfalken.com. The game server never stores a password. It receives an authenticated account identity (and email) from that service and maps it to a durable accountId in state.sqlite.

Until auth.timfalken.com is available, the gateway uses a stub identity: each new connection is admin-<n>, where n is the number of currently connected clients including this one (the first connection is admin-1). Stub accounts are treated as admins so the world editor can be used during development. Stub accounts have no email; deletion “emails” are logged instead of sent.

When real auth ships, the stub is removed. Admin rights come from that service, not from the admin- name prefix.

An account may have only one active play session at a time (one character in the world).

14.5 Characters

An account has unlimited characters and plays one at a time. First login with no characters must create one before entering the world. Later logins show a character-selection menu: create, choose, mark for deletion, or cancel deletion.

Initial character setup (may change later):

CreateCharacter
- firstName     // not globally unique
- lastName      // unique surname, owned by this account
- sex           // male | female

Rules:

  • Last names are globally unique. The first character to take a surname

claims it for that account. The same player may reuse that last name on their other characters. Another account cannot use it.

  • First names need not be unique globally.
  • For a given account, firstName + lastName must be unique among

characters that still exist (including those pending deletion).

  • Uniqueness is case-insensitive; display uses the casing the player typed.
Account
- accountId
- authSubject               // from auth.timfalken.com, or stub admin-<n>
- email?                    // from auth; absent on stub
- surnameClaims[]

Character
- characterId
- accountId
- firstName
- lastName
- sex
- deletionScheduledAt?      // null if not deleting
- inventory, equipment, currency, vault, skills, ...

The in-world ECS player entity is a character, not the account.

14.6 Character deletion and inheritance

From character select, the player may mark a character for deletion.

  • The character cannot be played while deletion is pending.
  • Permanent delete happens after characterDeletionDelay (default **24

hours**). Until then the player may cancel.

  • The server always notifies the account email when deletion is

marked (and should notify again on cancel and on actual delete). Stub auth logs the message instead.

  • On permanent delete, the name pair is freed. If this account has no

remaining characters with that last name, the surname claim is released.

  • Before the vault is moved, BankService voids outstanding filled

cheques issued by this character (reservations return to the vault).

  • All items in inventory, equipment, carried currency, and the character

vault are moved to that account's inheritance bank tab.

Any living character of the same account may, at a bank, claim inheritance stacks (and currency) into that character's own vault. Claiming is a move from the account tab to the character vault, not a second copy.

15. Client chunk subscription and replication

15.1 3×3 visibility

A player receives the current chunk and the eight surrounding chunks, a maximum viewport of 48×48 tiles. Neighbouring closed chunks are still sent so scenery remains visible; the player simply cannot walk onto them.

┌───┬───┬───┐ │ V │ V │ V │ ├───┼───┼───┤ │ V │ P │ V │ ├───┼───┼───┤ │ V │ V │ V │ └───┴───┴───┘

15.2 Incremental subscription changes

Crossing one chunk east subscribes only the three newly visible eastern chunks and unsubscribes only the three old western chunks. The rest of the 3×3 view remains subscribed.

15.3 Snapshots and deltas

Initial subscription sends a CHUNK_SNAPSHOT containing authored/runtime tile state, currently visible entities and unexpired ground item stacks. Afterwards, revisioned CHUNK_DELTA messages report tile changes, entity spawn/move/change/despawn events and ground-item appear/change/despawn events. Full chunks are not retransmitted every tick.

Entity move events carry the new integer tile and the current gait so the client can lerp over the walk or run interval. They do not carry a fractional in-between position. Smooth walking is a client visual lerp (section 21.5), not part of the replication payload.

Chunk snapshots include the baked light map (section 8.6).

Visible equipment is replicated as a compact appearance payload (body sprite plus worn overlay layers and recolour parameters), not as the entity's full inventory. Nearby clients can draw another player's armour without receiving their bags.

15.4 Visibility can span workers

The gateway can source visible chunks from multiple workers. A player may be authoritative on Worker A while one or more of the eight neighbouring visible chunks are owned by Worker B. Client visibility must never force simulation-region reassignment.

16. Click-to-move and A\* pathfinding

16.1 Command flow

Client: MOVE_TO(tileX, tileY) ↓ Gateway validates/authenticates ↓ Owning worker validates target ↓ A\ calculates authoritative route ↓ Path component attached/updated ↓ MovementSystem advances the entity one tile at a time* on the global walk/run cadence (section 13.4)

Authoritative Position is always an integer tileX, tileY. The server does not store a sub-tile location for walking mobiles. When a movement tick allows this gait to step, MovementSystem commits the next path tile in a single jump. Combat, occupancy, pickup and interaction all use that committed tile.

Flying pigeons still ignore the ground navigation grid, but their replicated ECS position is likewise a tile. The transit clock determines which tile they occupy at a given time; the client may lerp the sprite between those tiles like any other mobile.

16.2 Initial A\* implementation

For normal player clicks within the visible 3×3 chunks, the search space is at most 48×48 = 2,304 tiles, so conventional A\* is a strong starting point.

  • Binary heap priority queue for the open set.
  • Manhattan heuristic for four-direction movement; octile heuristic if

diagonal movement is later allowed.

  • Reusable typed-array or pooled search buffers for hot paths to reduce

allocation and garbage collection.

  • Rate-limit path requests per player and avoid recalculation every

tick.

  • Use block passability, open-chunk bounds, and dynamic occupancy;

ground is visual only. Tiles in closed or never-edited chunks are not legal path targets for players.

16.3 Navigation revisions

Each chunk maintains a navigation revision that increments when a movement-affecting block changes. A path records the relevant revisions. Static geometry changes can invalidate paths; temporary mobile occupancy normally causes a short wait or small local re-path rather than rebuilding every path.

16.4 Long-distance extension

If long-distance autonomous travel is added later, introduce hierarchical pathfinding: region graph → chunk portals/edges → local tile A\*. The client movement command interface does not need to change. Server movement remains discrete tile steps; only the path length changes.

17. Automatic update and restart scheduler

17.1 Restart triggers

A graceful restart is scheduled for the next midnight in configured server-local time when either of these conditions occurs:

  • A new commit is detected on origin/master. The master branch is the

live branch.

  • An administrator saves a world-editor change, creating/updating a

pending authored world revision.

Multiple triggers coalesce into one scheduled restart. The scheduler stores all reasons so players and admins can see why a restart is pending.

17.2 Detecting live-code changes

The running server periodically performs a non-destructive remote check, for example git fetch origin master followed by comparison of the running commit with origin/master. It does not update the checked-out code while the game is live.

17.3 Server-local midnight

Midnight is calculated in a configured IANA time zone rather than by adding 24 hours to the current time. This keeps behaviour correct across daylight-saving transitions.

17.4 Player-visible restart state

Restart status is part of the server status sent to clients. Connected players see that a restart is scheduled and the scheduled local time. The server can also issue configurable countdown notices as the restart approaches and includes the state immediately when a player logs in.

RestartStatus { scheduled: true, scheduledAt: timestamp, reasons: \["code-update", "world-update"\] }

17.5 Manual admin restart

An authorised admin action can invoke the same graceful restart pipeline immediately. This is not a separate “hard restart” path; it differs only in scheduled time.

17.6 Graceful restart sequence

> 1. Enter DRAINING / RESTARTING state and reject new logins. > > 2. Broadcast the final restart notice. > > 3. Disconnect player sessions cleanly and persist session state. > Shutdown handling overrides normal offline-script retention so chunk > unload cannot be blocked by a retiring process. > > 4. Stop accepting new gameplay commands and finish the current > safe tick boundary. > > 5. Force-unload every resident region/chunk, ignoring normal > ChunkLoader references. This invokes the ordinary chunk/entity unload > persistence path exactly once. > > 6. Flush the persistence service and close SQLite connections > cleanly. > > 7. Atomically write a restart request manifest. It records the > restart reasons, whether a code deployment is requested, the target Git > commit if known, and the pending world revision if one exists. > > 8. Exit the Node.js game process cleanly. At this point the game > process has no responsibility for updating or relaunching itself.

17.7 systemd process supervisor

The production Node.js process is owned by a systemd service. systemd therefore already knows when the process has fully exited; no separate polling process is needed. Only after the previous ExecStart process is gone does systemd begin the next service start.

The preferred lifecycle is:

Running Node.js server
        |
        | graceful planned restart or crash
        v
Node.js process fully exits
        |
        v
systemd starts the service again
        |
        +--> conditional update hook
        |       |
        |       +--> planned code deployment: git fetch/pull --ff-only
        |       +--> world-only restart: no Git mutation
        |       +--> crash/no restart manifest: no Git mutation
        |
        +--> optional dependency/build step if deployment changed code
        |
        v
Start Node.js server
        |
        v
Startup selects the new active world revision
        |
        v
Gateway opens when the world reports READY

17.7.1 Why Git pull must be conditional

A naive ExecStartPre=git pull on every restart is unsafe. Suppose a new commit is detected at 14:00 and correctly scheduled for midnight, but the game process crashes at 16:00. An unconditional pull would deploy the new commit immediately during crash recovery, bypassing the scheduled maintenance window.

Therefore the restart manifest distinguishes an intentional deployment restart from an ordinary process failure:

{
  "reason": ["code-update", "world-update"],
  "deployCode": true,
  "targetCommit": "<optional commit hash>",
  "pendingWorldRevision": 184
}

The manifest should be written using a temporary file plus atomic rename so the supervisor never consumes a half-written request. The supervisor consumes/removes the request only after it has successfully interpreted it.

If the Node.js process dies without a valid deployment request, systemd restarts the currently checked-out version. This gives fast crash recovery without prematurely deploying pending code.

17.7.2 Suggested systemd shape

A production unit can conceptually look like this:

[Unit]
Description=Tile MMO Server
After=network-online.target
Wants=network-online.target

[Service]
Type=simple
User=tilemmo
Group=tilemmo
WorkingDirectory=/srv/tile-mmo/current

# This hook checks the restart manifest. It pulls/builds only when an
# intentional deployment was requested. Prefixing with '+' optionally
# allows the hook to run with privileges different from the game user.
ExecStartPre=+/usr/local/sbin/tile-mmo-update-if-requested
ExecStart=/usr/bin/node /srv/tile-mmo/current/dist/server.js

Restart=always
RestartSec=5s
TimeoutStopSec=120s
KillSignal=SIGTERM

[Install]
WantedBy=multi-user.target

Restart=always is appropriate here because an explicit systemctl stop tile-mmo does not cause systemd to restart the unit, while a clean in-game restart exit and an unexpected crash both do.

The exact paths, build command and privilege split are deployment details, but the important invariant is that the Node.js process does not pull Git itself.

17.7.3 Code-update, world-update and crash behaviour

SituationRestart manifestGit pull before restartWorld revision
Scheduled code updatedeployCode=trueYes, fast-forward onlyActivate pending revision if present
World-editor-only updatedeployCode=falseNoActivate pending revision
Manual deployment restartExplicit admin intentAs requestedActivate pending revision if present
Unexpected Node.js crashMissing/invalidNoContinue current active revision
systemctl stopIrrelevantNo automatic restartN/A

This preserves the midnight deployment promise even when the game crashes before the scheduled maintenance window.

17.8 Failure behaviour

Deployment should fail closed. If Git cannot fast-forward, a build or migration fails, or startup validation fails, the game must not open to players on a partially updated state. The update hook should log the failure clearly and return non-zero; systemd may retry according to its restart/start-limit policy. Databases remain intact, and backups or snapshots before schema migrations are recommended.

A failed crash recovery that did not request deployment must not silently switch to a newer Git commit as a recovery strategy.

18. Future player scripting architecture

18.1 Scope

The custom scripting language is explicitly a later feature. Version 1 only needs architectural hooks so adding scripts does not require replacing the player-control or simulation model.

18.2 Controller abstraction

All player actions should already pass through an internal command interface. Manual client input is therefore one possible controller. A future script is another controller that emits the same validated action intentions.

ClientController ─┐
                  ├─> ActionCommand queue ─> authoritative game systems
ScriptController ─┘

Scripts never mutate ECS components directly. They request actions such as MoveTo, Interact or Attack and receive the same validation as a human client.

18.3 Online scripted mode

A logged-in player may enable the script while remaining connected and observing the game. Control mode explicitly determines whether manual input or the script is currently producing gameplay commands. The server remains authoritative either way.

18.4 Logout with active script

If a player has configured offline script execution, logout removes the network/controller connection but keeps the player entity alive. The entity changes to an offline script-controlled state and continues acting until it dies or its configured offline duration expires.

Player online Player + NetworkIdentity + ChunkLoader + Controller ↓ logout with offline scripting Player + ScriptController + ChunkLoader + OfflineUntil ↓ death OR expiry persist player state → remove runtime entity

18.5 Offline scripted players and loading

An offline scripted player must continue to stimulate the world it traverses, so it retains a ChunkLoader. This is powerful but potentially expensive: thousands of offline scripts could keep large parts of the world active. Offline duration, script CPU budget and concurrent offline-script limits therefore become explicit resource policy, not implementation accidents.

18.6 Restart continuity

A planned restart persists the offline-script state and expiry time, force-unloads the old process, and rehydrates still-valid offline scripted players during startup. This is why the startup index for persistent ChunkLoaders is part of the base architecture.

18.7 Scripting language safety requirements

When the language is implemented, it should be interpreted/compiled into a purpose-built sandbox rather than evaluated as JavaScript. At minimum it should enforce:

  • No file-system, operating-system, database or arbitrary network

access.

  • No eval or escape into Node.js objects.
  • Per-tick/per-event instruction budgets and bounded memory.
  • Rate-limited expensive operations such as path requests and world

queries.

  • Capability-based read APIs for nearby visible/known world state.
  • Action output only through the normal server command pipeline.
  • Persistable script variables/state if offline execution must survive

restarts.

  • Deterministic or tightly controlled timing semantics where practical.

An event-driven language is preferable to running every player script continuously at full simulation frequency. Events such as arrival, attack, nearby entity changes or timer expiration can wake scripts only when useful.

19. Security and administration

  • World-editor endpoints require an explicit admin role and separate

server-side authorisation checks.

  • Client-supplied entity/player IDs are never trusted as authority;

authenticated connection/session context identifies the actor.

  • World-editor data is validated against known ground, block, item and mob

definitions before database write.

  • Admin restart and deployment controls use the same authenticated

administration layer.

  • The Node.js game process should run as a dedicated unprivileged user.

Where practical, source-update permission belongs only to the systemd update hook (for example a privileged ExecStartPre helper), leaving the running Node.js process unable to modify its own checkout.

  • SQLite writes are parameterised and centralised through

persistence/editor services.

  • Inventory, vault, cheque and courier mutations are server-authoritative.

Clients cannot invent cheque IDs, forge cargo, or credit a vault.

  • Attack hit/miss and damage are server-authoritative. Clients cannot supply

a roll or a damage result. Shop purchase prices are computed at buy time on the server.

20. Recommended process topology

Clients
  |
  v
WebSocket/API Gateway
  |
  +-- Region Coordinator ----> Simulation Worker A
  |                              <--> Simulation Worker B
  |
  +-- Communication Service --> proximity speech
  |
  +-- CourierService ---------> pigeon cargo / transit
  |
  +-- BankService ------------> shared vaults / cheques / reservations
  |
  +-- MarketService ----------> order book / escrow / trades / last-sale index
  |
  +-- Persistence Service ----> state.sqlite
  |
  +-- Admin / World Editor ---> world.sqlite

External process supervision:
systemd ---> conditional deployment hook ---> Node.js relaunch

21. Player client architecture

21.1 FrameworkV3 as a git submodule

The player-facing client is built on the shared FrameworkV3 library:

<https://gitlab.com/Timfa/frameworkv3>

FrameworkV3 contains generic reusable client-side code. Game-specific rendering, UI, input, assets and protocol handling live in this repository, on top of that library. They are not patched into FrameworkV3 unless they are genuinely reusable across games.

This repository vendors FrameworkV3 as a git submodule rather than copying its source or depending on an unpublished global install.

mmo/
  client/
    frameworkv3/     # git submodule → gitlab.com/Timfa/frameworkv3
    src/             # this game's client: protocol, UI, world view, assets
  server/            # Node.js ECS backend; does not import FrameworkV3

The submodule path is client/frameworkv3. A clone of this repo is not client-buildable until submodules are present:

git clone --recurse-submodules <this-repo>
# or, in an existing checkout:
git submodule update --init --recursive

The submodule records a pinned commit. Bumping FrameworkV3 is an explicit commit in this repository (new submodule SHA). Game code must not rely on an uncommitted dirty checkout of the submodule.

Build order:

1. Build FrameworkV3 from client/frameworkv3
2. Build this game's client against that output
3. The Node.js server is a separate build and does not link FrameworkV3

The exact FrameworkV3 build command follows that project's own instructions. This game's client build must consume the framework's public/build artefacts, not fork its internals.

CI and developer machines check out submodules before the client job. A missing or uninitialized submodule is a failed client build, not a fallback to a system copy of FrameworkV3.

If this repo's master also ships the built web/desktop client from the same process that deploys the game server, a submodule bump is just another commit and follows the normal midnight restart/deploy path. The running Node.js game process still does not compile or import FrameworkV3.

The backend remains the authoritative Node.js ECS simulation described in this document. The client does not need to use ECS. It receives only a small 3×3-chunk view plus player/UI state, so a conventional object/view-model model is simpler and entirely appropriate.

21.2 Server/client model separation

Backend ECS components are not treated as a shared client object model. Network messages form the contract between the two sides.

Authoritative Node.js ECS
        |
        | snapshots / deltas / UI state
        v
Network protocol DTOs
        |
        v
Built FrameworkV3 (from client/frameworkv3 submodule)
        |
        v
This game's client code (client/src)

The two projects may share protocol schemas, enums or generated message types, but the client must not depend on the internal layout of ECS component storage. That allows server internals to be optimised without forcing corresponding client rewrites.

21.3 Sprite size, pivot and Y-sort

World sprites may be any pixel size. The gameplay tile remains 16×16. Each sprite is placed with an automatic pivot: horizontally centred, and 8 pixels up from the bottom of the sprite. That pivot sits on the tile centre, so a 16×16 sprite still fills the tile and a taller sprite stands on the same feet line and extends upward.

Blocks and mobiles with oversized sprites are Y-sorted: sprites higher on the screen draw behind sprites lower on the screen, using the pivot's world Y (the occupied tile, or the interpolated foot position while walking). Ground tiles and the night overlay stay behind and in front of that pass respectively.

Nearest-neighbour sampling still applies so pixels stay sharp under viewport zoom. Zoom scales the whole view uniformly; it is not a per-sprite size override.

21.4 Viewport, camera and zoom

In normal play the viewport is always centered on the local player's character. The camera does not free-pan. Scrolling the world happens only because the player moved.

The player may zoom in and out within configured minimum and maximum bounds (for example 1× to 4×; the exact numbers are a game setting). Zoom does not move the camera off the player and does not change server visibility: the client still receives only the 3×3 chunk window.

The admin world editor is the exception: it frames the selected 16×16 chunk and navigates by chunk, as in section 8.1.

21.5 Client movement interpolation

The server jumps mobiles from tile to tile. The client draws a visual lerp between the previous replicated tile and the new one over the interval implied by gait and WorldSettings (walk: 1 / walkTilesPerSecond, run: half of that). If a delta arrives late, clamp the remaining lerp. That lerp is presentation only:

  • Hit tests, range, pickup and occupancy use the authoritative tile.
  • A corrected server position snaps the interpolation target; the client

does not accumulate drift.

  • Interpolation does not entitle the client to send fractional positions.

21.6 Equipment layers and recolouring

A mob (including a player character) is drawn as a stack of sprites on the same tile: the body sprite (male or female from character sex, or the mob archetype body), then each piece of visible equipment. Overlays are not baked into the body art.

draw order (back → front, default)
  1. body / mob base
  2. boots
  3. legs
  4. chest
  5. head
  6. off-hand
  7. weapon

Slot draw order is data so a cloak or a two-handed sprite can be inserted without a renderer rewrite. Overlay sprites use the same automatic pivot as other world art (horizontal centre, 8 pixels from the bottom).

Equipment items stay in dedicated equipment slots, not in the 32 inventory slots, while worn. EquipItem(slotIndex) moves a legal item from inventory into the matching equipment slot, returning any previously worn item to inventory if there is space. UnequipItem(equipSlot) does the reverse. The weapon equipment slot is what combat uses; it replaces the older “wielded flag on an inventory slot” idea.

Non-player mobs may carry an Equipment component or a simpler appearance list on the mob definition so a guard can show armour without a player inventory.

Equipment
- slots: { head?, chest?, legs?, boots?, weapon?, offhand?, ... }

ItemDefinition.equipment?
- slot
- overlaySpriteId
- recolourableChannels?: ["metal"]   // omitted if the art is not recoloured
- materialId?                        // e.g. iron, steel; used with "metal"

Inventory icons and worn overlays may be different 16×16 files. Both are world sprites and both go through the size check.

Recolourable equipment

Some gear shares one overlay and is tinted per material. Metal armour is the initial case: iron, steel and later metals are not separate full-size art sets.

MaterialDefinition
- materialId            // iron, steel, ...
- displayName
- channel               // metal for armour; later channels may include cloth
- colour                // destination RGB for that channel

A recolourable overlay is authored as:

  • the 16×16 overlay sprite, with shading in the channel regions, and
  • an optional 16×16 channel mask of the same dimensions, whose pixels

name which recolour channel they belong to (for example a reserved mask colour meaning metal). Unmasked pixels are drawn unchanged.

At draw time, masked pixels keep the overlay’s relative brightness (highlights and shadows) and replace the hue/saturation with the item’s MaterialDefinition.colour. The client must not invent a colour; the server sends the material id (or the already-resolved colour) on the appearance layer.

Iron plate and steel plate therefore share overlaySpriteId = platebody and differ only by materialId. Non-metal unique art omits recolourableChannels and is blitted as authored.

Recolour happens on the client as a presentation step. It does not change item identity, combat stats or inventory. Nearby observers receive enough appearance data to apply the same layers and tints.

21.7 World time and night shading

The client treats world time as server time minus 1200 years (section 13.5). It uses that clock-of-day to shade the 3×3 view.

At night, tiles that the baked light map says are unreachable from any static light are drawn darker. Tiles a light can reach stay brighter. Light does not bleed through walls: the mask was raycast through passable tiles at editor save, including across chunk borders, so a torch on the edge of one chunk can light tiles in the next.

By day, ambient light is full and the baked mask does not darken the ground. The day/night curve (how dark “night” is, dusk length) can stay a world setting or a later tuning value; the invariant is that night uses baked reachability, not a per-frame raycast.

The world-editor night-to-day slider is the same shading function, driven by the slider instead of the clock, so an admin can preview a chunk at any light level without changing live world time.

22. Items, inventory and ground drops

22.1 Item definitions

Every obtainable object is an ItemDefinition. Stacking, uniqueness and later economy rules are data on that definition, not special cases in UI code.

ItemDefinition
- itemId
- displayName
- description
- seedValue               // base price before player-market adaptation
- stackable
- maxStackSize            // default 99 for stackable items
- uniqueInstance          // true for letters, filled cheques, and similar
- category: ingredient | intermediate | finished | document | other
- npcShopAllowed
- gatherSources
- craftingRecipe(s)
- dropTableSources
- attack?: AttackProfile  // weapons; omitted for non-weapons
- equipment?:             // worn/wielded visuals; see 21.6
    slot
    overlaySpriteId
    recolourableChannels?
    materialId?

A stackable item with no instance data merges with an identical itemId in the same container up to maxStackSize. Unique-instance items never merge; each occupies its own slot at quantity 1.

Currency is not an inventory item. Carried money is a numeric Currency balance on the player. Banked money is a numeric balance on that player's vault. Coins do not occupy inventory slots and cannot be dropped on the ground in this model.

How most items are obtained is specified later. Two source families already fit this model without changing it:

  • Ground-item spawners in the world editor, analogous to mob spawners.
  • Later harvesting from the environment by players.

Paper, blank cheques and letters are specified now because communication, banking and pigeons depend on them.

22.2 Player inventory

A player inventory has exactly 32 slots.

Inventory
- slots[32]: empty | ItemStack

ItemStack
- itemId
- quantity                 // 1 for unique-instance items
- instance?: ItemInstance  // present only when uniqueInstance is true
- origin?: ItemOrigin      // crafter or shop NPC; see 22.6

Rules:

  • A stack occupies exactly one slot, regardless of quantity.
  • Inserting a stackable item first tries to merge into an existing compatible

stack whose combined quantity would not exceed maxStackSize. Stacks are compatible only when itemId matches and origin matches (including both being empty). Any remainder needs an empty slot, or the whole action fails.

  • Moving, swapping and splitting stacks are ordinary server-validated

commands. The client never asserts the resulting inventory.

  • Inventory, wallet and vault contents are player-private UI state. They

are not part of 3×3 chunk replication. Other clients see ground items and pigeon entities, not another player's bags or a pigeon's cargo.

  • Logout and restart persist the full inventory and carried currency in

state.sqlite.

22.3 Paper and letters

Blank paper is a stackable item.

Writing consumes one paper and produces a letter: a unique-instance item whose instance data is text written by a player. A letter is not a mail record and has no inherent recipient. It is just paper with writing on it.

LetterInstance
- letterId
- authorPlayerId
- body
- writtenAt

If the paper stack's quantity is 1, the slot may be converted in place into the letter. If quantity is greater than 1, writing requires a free inventory slot for the new letter and decrements the paper stack.

Reading a letter inspects its instance data. Sending a letter is the same pigeon-cargo action used for any other item stack.

Maximum letter length is a defined game rule and can be chosen during implementation.

22.4 Dropping items

A player may drop an item stack, or part of a stack, onto their current tile.

GroundItem
- groundItemId
- tileX / tileY
- ItemStack
- droppedAt
- expiresAt               // droppedAt + WorldSettings.groundItemDespawnDuration
- source                  // player-drop | later: item-spawner
- droppedByPlayerId?

Rules:

  • Player-dropped items remain for WorldSettings.groundItemDespawnDuration

(default 10 minutes), then vanish forever.

  • Anyone may pick up a ground item. There is no owner lock and no loot-rights

delay.

  • Ground items do not block movement and do not prevent a player from

standing on that tile.

  • Pickup requires the player to stand on that tile. The command names the

groundItemId when several stacks share the tile.

  • Pickup fails if the player's inventory cannot accept the stack (no legal

merge and no empty slot). The ground item is unchanged.

  • Several distinct stacks may occupy one tile at once.
  • Later naturally spawned ground items use the same non-blocking

representation, but their lifetime and respawn belong to the item spawner rather than this 10-minute player-drop timer.

Dropped items are not ChunkLoaders and do not keep a chunk simulated.

They do survive chunk unload until expiresAt, using timestamp expiry rather than a per-tick countdown. On unload, unexpired ground items are written to state.sqlite. On load or wake, items whose expiresAt is in the past are discarded and never replicated. Simulating chunks also remove them when the timestamp elapses.

If a unique-instance item that encodes a bank reservation (a filled cheque) expires on the ground or is otherwise destroyed without being redeemed, that reservation is released and the reserved goods become available in the issuer's vault again.

22.5 Pickup and drop commands

DROP_ITEM(slotIndex, quantity?)
PICKUP_ITEM(groundItemId)

Both are intentions. The owning worker validates the actor's tile, inventory space and stack rules, then applies the result. Standing on a tile that has ground items does not pick them up automatically.

22.6 Item inspection, origin and displayed value

Hovering an item — in inventory, a shop stock list, or on the ground — shows at least:

ItemTooltip
- displayName
- description
- originLabel              // who crafted it, or the shop NPC if bought there
- currentValue             // undiscounted adapted value; see section 27

Origin is stored on the stack:

ItemOrigin
- kind: crafted | shop | unknown
- playerId?                // when crafted by a player
- npcId?                   // when bought from a shop NPC

The origin label is the crafting player's name, or the shop NPC's name when the stack was bought from that NPC. Harvested, looted or otherwise unstamped stacks use unknown and omit the origin line until later content says otherwise. Buying from a shop stamps that NPC as origin. Crafting stamps the crafter. Shop-bought goods are not treated as crafted by the NPC; the NPC name simply occupies that inspection field.

currentValue uses the same last-sale lerp as shopkeepers (section 27.6) but without the per-shop discount. It is informational. The client must not recompute it every simulation tick. The player UI may refresh displayed values at most once per minute, from the last-sale record plus seedValue. The actual shop purchase price is always computed server-side at the moment of purchase.

23. Player communication and carrier pigeons

23.1 Proximity chat is the default

Ordinary chat is spatial. A player speaks from a world position and only nearby players receive a useful version of the message. Legibility decreases as the recipient gets farther from the speaker.

For example:

Near:       I'm really far away
Farther:    I'm re...y far aw.y
Very far:   I'...re..ly..ar.aw.y
Beyond range: no message

The exact distance bands/function are configurable game rules.

Crucially, degradation is performed server-side. The server must not send the full plaintext to a distant client and merely ask that client to obscure it, because a modified client could then recover speech it was not supposed to understand.

A chat message therefore conceptually contains:

ChatSpeech
- messageId
- speakerEntityId
- originX / originY
- createdAt
- text

The communication service performs a spatial recipient query and derives the recipient-specific legible representation before routing it through the gateway. Chat routing is separate from normal 3×3 chunk replication, so the eventual hearing/text range does not have to equal the visual chunk-subscription radius.

23.2 Persistent player groups

Players can create permanent groups and invite other players into them. Groups are durable social entities stored in state.sqlite, with membership surviving logout and server restart.

A minimal model contains:

PlayerGroup
- groupId
- name
- owner / roles
- createdAt

PlayerGroupMember
- groupId
- playerId
- role
- joinedAt

Invite, accept, leave, kick and role-management operations are authoritative server actions.

Group membership does not create magical long-distance communication. If members are close enough, they can communicate through the normal proximity rules. Communication to distant group members means sending items — including letters — by carrier pigeon, the same mechanism available to any player.

If group-wide letter sending is later supported, it is an addressing convenience that still consumes one paper/letter item and one pigeon dispatch per recipient. The group is not a global instant chat channel.

23.3 Pigeons carry cargo, not messages

A carrier pigeon is a free physical courier. It does not send a chat packet. It carries either:

  • an amount of the sender's carried currency, or
  • exactly one item stack (a letter, a filled cheque, blank paper, or any

other stack)

One pigeon cannot carry both money and an item, and cannot carry two item stacks. Dispatching a pigeon is free, so a player who wants to move several stacks sends several pigeons one after another.

Cargo is removed from the sender immediately and placed into durable transit. A crash or restart cannot duplicate that cargo or silently erase it.

Pigeons are not inventory items. Any player may dispatch one from anywhere, provided they have valid cargo.

SendPigeon
- destination: Player(playerId) | Bank
- cargo: Money(amount) | Item(slotIndex, quantity?)

23.4 Destinations

Player destination. The pigeon flies toward the named player. On arrival:

  • Money is added to the recipient's carried Currency if they are online;

otherwise it is deposited into the recipient's bank.

  • An item stack is placed in the recipient's inventory if they are online and

have space (a legal merge or an empty slot). If they are offline or cannot accept the stack, the pigeon continues to the nearest bank and deposits the stack into the recipient's vault.

This keeps offline and full-inventory delivery durable without a separate mailbox object.

Bank destination. The pigeon flies to the nearest bank to the dispatch tile. Travel time is that aerial journey, even though every bank shares the same vault. On arrival the cargo is deposited into the sender's vault, except for the filled-cheque special case in section 24.7.

"Nearest bank" is computed from authored Bank block positions in the pinned world revision. If additional banks are added later, a pigeon sent to Bank still lands at whichever bank is closest to where it was dispatched; the goods then appear in the shared vault.

23.5 Carrier pigeon transit

A carrier pigeon must take time to cross the world; long-distance item and currency delivery is intentionally not instantaneous.

At MMO scale, however, every delivery should not keep an entire trail of regions fully stimulated merely so a pigeon can advance. The recommended model is a persistent courier transit record with world position/route/progress that can advance through dormant space using coarse path segments and timestamps.

CourierTransit
- courierId
- cargo                   // Money(amount) | ItemStack
- senderPlayerId
- destination             // Player(playerId) | Bank
- currentPosition
- route
- speed / timing state
- status

A carrier pigeon is part of the shared physical world, not a private visual belonging only to its sender or recipient. Whenever its calculated route passes through a simulating chunk, the courier should materialise there as a normal ECS Mob entity, regardless of whether the sender or recipient is nearby. Any client whose normal 3x3 chunk subscription includes that pigeon receives it like any other visible mobile entity and can therefore see unrelated pigeons flying past in the distance.

The visible pigeon does not receive ChunkLoader. It exists because the chunk is already simulating for some other reason. If it leaves the last relevant simulating chunk, its exact position/progress is folded back into the durable CourierTransit record and the ECS instance can disappear while the journey continues abstractly. If a dormant/unloaded part of its route later becomes simulated while the pigeon should currently be inside it, the owning worker materialises the pigeon at the position implied by the transit clock and route.

Dormant route                 Simulating chunk                 Dormant route

abstract transit  -------->  ECS pigeon visible to clients  -------->  abstract transit
                                  |       |       |
                               Player A Player B unrelated observer

This means a player standing halfway between sender and recipient can see the pigeon fly through their area even though the cargo has nothing to do with them. Unrelated clients receive the pigeon entity, not the cargo contents. It preserves the sense that deliveries physically cross the world without requiring thousands of deliveries to become thousands of permanent ChunkLoaders.

Because pigeons fly rather than use the ground navigation grid, their coarse route can initially be represented by direct or waypoint-based aerial segments. This makes deterministic materialisation from route + elapsed time considerably simpler than it would be for a ground-based courier.

If future gameplay allows pigeons to be intercepted, killed or rerouted anywhere along their journey, the transit model can be made progressively more detailed; that interaction is not required by the initial courier design.

23.6 Courier service

A dedicated CourierService should own durable cargo and delivery state. Simulation workers may own visible pigeon entities while the service owns the durable fact that a delivery exists.

Player action -> CourierService -> durable cargo/transit
                                  |
                                  +-> visible pigeon when needed
                                  |
                                  +-> inventory, wallet or BankService deposit

This separation is also useful for marketplace settlement, which uses the same carrier-pigeon delivery infrastructure for remote counterparties.

24. Bank, cheques and shared vaults

24.1 Bank location and access

A bank exists at or near the central marketplace as an authored Bank block. Deposit, withdraw, cheque issue and in-person cheque redemption require server-validated access to a bank interaction; the bank is not a global menu usable from anywhere.

Pigeon dispatch to Bank is the exception: that command may be issued from anywhere, and the goods become available only after the pigeon arrives.

24.2 One shared vault

Each character has a single vault in state.sqlite:

CharacterVault
- characterId
- bankedCurrency
- stacks[]
- reservations[]

Capacity is unlimited: there is no slot cap. Per-stack stacking rules still apply (maxStackSize; unique instances never merge), so 200 blank paper is stored as 99 + 99 + 2 rather than one unbounded pile.

If more banks are authored later, all banks are linked. Withdrawing at bank B can retrieve goods deposited at bank A. The vault is not per-branch.

Pigeon deposits affect when goods become available, not which vault they enter. After the pigeon arrives at the nearest bank, the goods appear in the same shared vault accessible from every bank.

24.3 Deposit and withdraw

While interacting with a bank, a player may:

  • Deposit any carried currency and any inventory stacks, in whole or in part.
  • Withdraw currency into the carried wallet.
  • Withdraw an item stack, or part of a stack, into inventory, subject to the

32-slot and merge rules.

  • Claim items or currency from the account inheritance tab into this

character's vault (section 24.9).

Goods reserved by an outstanding filled cheque cannot be withdrawn by the issuer until that cheque is redeemed or voided.

24.4 Blank cheques

A player at a bank may request blank cheques.

  • Blank cheques are a stackable item with maxStackSize 99.
  • The bank counts blank cheques already in the player's inventory (not

the vault) and issues only enough to bring that total to 99.

  • If the player already holds 99, the bank issues none.
  • Issued cheques go into inventory, merging into an existing blank-cheque

stack when possible. If the player holds none and has no empty slot, the request fails.

The bank will not issue more than 99 blank cheques into inventory, even on repeated requests.

24.5 Filling a cheque

Using a blank cheque at a bank lets the issuer pick vault goods and a quantity. For stackable items they choose an itemId and quantity; the quantity may be larger than one maxStackSize, and the reservation covers that many available (unreserved) items of that type in the vault. For unique-instance items they choose that exact instance and the quantity is 1.

FilledChequeInstance
- chequeId
- issuerPlayerId
- itemId
- quantity
- instance?: ItemInstance   // set when the reserved goods are unique
- createdAt

Filling:

1. Validates that the vault has at least quantity of that item available (not already reserved). Unique instances must still be present and unreserved. 2. Reserves those goods in the issuer's vault. Reserved goods cannot be withdrawn, sold or reserved again. 3. Consumes one blank cheque. If that was the last cheque in the slot, the slot becomes the filled cheque in place; otherwise a free slot is required for the filled cheque.

A filled cheque is a unique-instance bearer item. It does not stack. Whoever holds it may redeem it. Cheques specify vault items and a quantity, not carried currency. Money is moved with a pigeon, or by depositing and withdrawing at a bank.

24.6 Redeeming a cheque in person

The bearer interacts with any bank and redeems the filled cheque.

  • The server moves the reserved goods from the issuer's vault into the

bearer's inventory, subject to inventory space. A quantity larger than maxStackSize becomes as many stacks as needed.

  • The cheque item is consumed.
  • If inventory cannot accept the resulting stacks, redemption fails and both

cheque and reservation remain unchanged.

The bearer may then deposit those goods into their own vault if they wish.

24.7 Redeeming a cheque by pigeon

If the bearer dispatches a pigeon whose cargo is a filled cheque and whose destination is Bank:

  • The pigeon flies to the nearest bank from the dispatch tile.
  • On arrival, BankService transfers the reserved goods from the issuer's

vault into the pigeon's sender's vault.

  • The cheque is consumed in transit; it is not deposited as an item.

The receiver of the transfer is whoever sent that pigeon, not the original cheque issuer. This is how a cheque moves goods from one vault to another without the receiver standing at a bank.

Sending a filled cheque to a player delivers the cheque item itself (or into that player's bank if they cannot hold it). It does not redeem it.

24.8 Bank service

Vault mutation, cheque issue, reservation, in-person redemption and pigeon-arrival deposits are owned by a single authoritative BankService (or an equivalently serialised service) so two concurrent withdrawals, cheque fills or pigeon arrivals cannot double-spend the same goods.

Bank interaction or pigeon arrival
        |
        v
BankService
  - shared vault
  - reservations
  - cheque issue / redeem
        |
        +-> inventory / currency on the acting player when in person
        |
        +-> vault credit on pigeon arrival

Cheque identifiers are server-issued. A client cannot forge a claim against another player's vault.

24.9 Inheritance bank tab

Each account has one inheritance tab, separate from every character vault:

AccountInheritance
- accountId
- currency
- stacks[]

It is written only when a character of that account is permanently deleted (section 14.6). Any of that player's living characters can move stacks and currency from this tab into their own vault at a bank. They cannot deposit into inheritance except through character deletion.

25. Central marketplace and order matching

25.1 Marketplace location

A central marketplace exists at or near the centre of the game world. Creating, modifying or cancelling market orders requires server-validated access to the marketplace interaction; the marketplace is not intended to be a global menu that can be used from anywhere.

Orders themselves remain durable after the player leaves the marketplace or logs out.

25.2 No public list of sell orders

The market is an order book, but players do not browse a list of individual items currently offered for sale.

A seller submits:

SellOrder
- item / item definition
- quantity
- minimum unit/total price

A buyer submits:

BuyOrder
- requested item / matching criteria
- quantity
- maximum unit/total price

The UI may know which item types exist and may eventually show historical data, but it does not expose the live asks in a way that lets a buyer simply pick a listed seller.

25.3 Escrow

Market orders escrow the asset required to honour them. Escrow is taken from carried inventory and carried currency. The marketplace sits next to the bank, so a player can withdraw from the vault immediately before placing an order.

  • Creating a sell order removes/reserves the offered item stack from the

seller's inventory.

  • Creating a buy order removes/reserves the buyer's maximum offered currency.
  • Cancelling an unmatched order returns the escrowed asset through the defined

settlement/delivery rules.

This prevents double spending, selling the same item twice, or a buyer spending currency after placing a bid.

25.4 Matching rules

A buy and sell order match when:

buyerMaximum >= sellerMinimum

Sell orders are considered cheapest first. Within the same minimum price, a stable creation sequence/FIFO rule should be used unless later game rules choose otherwise.

For a symmetric order book, buy orders are naturally prioritised by highest maximum bid and then oldest sequence. This means a newly submitted sell order matches the best compatible existing bid, while a newly submitted buy order matches the cheapest compatible existing ask.

The trade price is exactly the midpoint between the two limits:

tradePrice = midpoint(buyerMaximum, sellerMinimum)

Example:

Seller minimum:  80
Buyer maximum:  100
Trade price:      90

The exact rounding rule when integer currency produces a half-unit midpoint is a defined-but-still-open game rule and must be deterministic.

25.5 Immediate side versus pigeon side

The order that is submitted last is the order that triggers the match.

The player who submitted that matching order receives the acquired asset immediately because they are currently present at the marketplace interaction (item stack into inventory, or currency into the carried wallet). The pre-existing counterparty receives their acquired item or currency through a carrier pigeon whose destination is Bank, landing at the nearest bank to the marketplace. On arrival the settlement is deposited into that counterparty's shared vault. This remains valid if they are offline.

Existing sell + new matching buy
-> new buyer receives item immediately
-> existing seller receives payment by pigeon to bank

Existing buy + new matching sell
-> new seller receives payment immediately
-> existing buyer receives item by pigeon to bank

If a trade requires more than one item stack (for example a quantity that does not fit in a single maxStackSize), the older counterparty receives as many free sequential pigeons as needed. Each pigeon still carries only one stack or only currency.

Any unused part of buy-order currency escrow caused by the midpoint price is returned immediately to the triggering player when they are the buyer, and returned by the settlement pigeon into the older counterparty's vault when they were the buyer.

25.6 Market service and atomicity

Marketplace matching should not live inside an arbitrary region worker. Use a single authoritative MarketService (or an equivalently serialised partitioned service later) so two simultaneous orders cannot both consume the same escrow.

Order insertion, matching, escrow movement and creation of the resulting settlement deliveries are committed atomically in state.sqlite.

Conceptually:

Marketplace interaction
        |
        v
MarketService
  - durable order book
  - escrow
  - deterministic matching
  - trade record
        |
        +-> immediate settlement to triggering player's inventory or wallet
        |
        +-> CourierService pigeon to Bank for the older counterparty
        |
        +-> last-sale index update for that itemId

The system should also retain an immutable trade record for auditing and recovery.

25.7 Last player-market sale per item

Each successful player-market match updates a single durable record for that itemId. There is no price history series — only the latest sale:

ItemLastMarketSale
- itemId
- lastTradePrice           // unit price of that match (the midpoint)
- lastTradeAt
- priceFrom                // evaluated undiscounted value at lastTradeAt

priceFrom is not a history log. It is the lerp origin captured at the moment of this sale so the displayed price does not jump back to seed when a new trade occurs:

1. Evaluate the current undiscounted value at now using the previous last-sale record (or seedValue if none exists). 2. Store that value as priceFrom, store the new trade's unit price as lastTradePrice, and store now as lastTradeAt.

Shopkeepers and item tooltips both read this record. They do not tick it; they evaluate it from timestamps when a shop is opened, a purchase is attempted, or a tooltip refresh is requested.

26. Combat

26.1 Every combatant can attack

Players, enemies, animals and any other mobile with a Combat component can attack. Shopkeepers and other non-fighting NPCs simply omit Combat, or never issue attack commands.

Attacking is an intention. The client (or AI, or a future script) sends ATTACK(targetEntityId). The owning worker validates range, line-of-use, the current attack profile and cooldown, then resolves hit and damage authoritatively. The client never supplies a hit result or a damage number.

Cross-worker attacks already use REMOTE_ACTION(attack intent): the worker that owns the target applies the authoritative result.

26.2 Attack profiles

The current attack comes from the wielder's selected profile: a wielded weapon's AttackProfile, a selected spell, or a default unarmed melee profile when nothing is wielded.

AttackProfile
- attackId
- mode: melee | ranged | magic
- rangeTiles               // melee is always 1; ranged/magic from the item or spell
- hitSkillId
- damageSkillId
SpellDefinition
- spellId
- displayName
- AttackProfile            // mode = magic, hitSkillId = Magic, damageSkillId = Mind
- other costs/effects      // later content

Typical weapon mappings:

Sword     -> melee,  range 1,           hit Swordfighting, damage Strength
Axe       -> melee,  range 1,           hit Axefighting,   damage Strength
Bow       -> ranged, range from item,   hit Archery,       damage Dexterity
Spell     -> magic,  range from spell,  hit Magic,         damage Mind
Unarmed   -> melee,  range 1,           hit Unarmed,       damage Strength

The exact weapon and spell catalogue is content. The pairing rule is not: melee weapons use a weapon skill plus Strength, ranged weapons use a weapon skill plus Dexterity, and spells use Magic plus Mind.

EquipItem(slotIndex) moves a legal item from inventory into the matching equipment slot (section 21.6). The weapon slot supplies the current AttackProfile. SelectSpell(spellId) selects a spell the actor is allowed to use. The selected profile determines range and both skills.

26.3 Melee range

A melee attack is legal only when the attacker stands on one of the eight tiles surrounding the target's tile: orthogonal or diagonal, Chebyshev distance exactly 1. The attacker cannot melee from the target's own tile.

. . .
. T .     attacker must occupy one of the eight `.` tiles
. . .

This adjacency rule is independent of whether ordinary walking is four- or eight-directional.

26.4 Ranged attacks and spells

Ranged weapons and spells may fire from further away. Maximum Chebyshev distance is rangeTiles on that item or spell. Distance 0 (same tile) is not a legal ranged/spell attack unless a later exception is defined.

The attacker must still occupy a simulating chunk and satisfy any later line-of-sight rule. Exact obstruction rules are an open content decision; range itself is not.

26.5 Hit roll

Whether the attack lands is a server-side roll driven by the hit skill of the current profile (Swordfighting, Axefighting, Archery, Magic, Unarmed, and so on). The client does not roll.

The exact hit curve, any defender contribution from Defence, and the RNG are later tuning. The invariant is that the hit chance is a function of the attacker's hit-skill level, not of Strength, Dexterity or Mind.

A miss deals no damage.

26.6 Damage

On a hit, damage is determined by the damage skill:

  • Melee → Strength
  • Ranged → Dexterity
  • Magic → Mind

Weapon or spell base damage and the defender's mitigation (including whether Defence reduces damage) are later tuning. The governing damage skill is not.

26.7 Experience split

When a player successfully hits, the attack's XP award is split equally between the hit skill and the damage skill:

totalXp = attack xp formula for this successful hit
hitSkill     += totalXp / 2
damageSkill  += totalXp / 2

Example: a sword hit awards half its XP to Swordfighting and half to Strength. A bow hit splits Archery and Dexterity. A spell hit splits Magic and Mind.

If an unusual profile ever named the same skill twice, XP is awarded once, not doubled. Misses award no combat XP. Ordinary mobs do not earn XP; their Skills component is filled from the mob archetype and stays at those levels.

Non-combat actions remain single-skill as in section 27.4.

26.8 Mob combat stats

MobDefinition
- ...
- skillLevels: { skillId → level }
- defaultAttack: attackId | unarmed

A wolf might have Unarmed and Strength. An archer guard might have Archery and Dexterity. Those levels feed the same hit and damage resolution as players.

27. Player-driven economy and skill progression

27.1 Item-source philosophy

The economy is intentionally player-driven.

Normal NPC shops should sell only basic ingredients. The vast majority of materials are gathered directly from the world by players. Finished goods are normally produced by player crafting/professions.

The only normal non-player source of finished items is enemy or boss loot.

This gives four broad source paths, with ground-item spawners as an additional early world source once content defines them:

World gathering / harvesting -> ingredients
Ground-item spawners --------> some world items, later specified
Basic NPC shops -------------> limited basic ingredients
Player production -----------> intermediate/final products
Enemies and bosses ----------> loot, including possible finished items

Stacking, unique instances, letters and cheques are defined in section 22. Economy-facing fields remain on the same ItemDefinition:

ItemDefinition
- itemId
- displayName / description / seedValue
- stackable / maxStackSize / uniqueInstance
- category: ingredient | intermediate | finished | document | other
- npcShopAllowed
- gatherSources
- craftingRecipe(s)
- dropTableSources
- attack?: AttackProfile
- equipment?: slot / overlaySpriteId / recolourableChannels / materialId

Content validation can then reject an ordinary shop inventory that accidentally contains a finished product unless explicitly permitted by a future exception.

27.2 No player classes

Players do not choose a class. Capabilities and progression come from independent skills.

Examples include:

  • Swordfighting, Axefighting, Archery, Magic, Unarmed
  • Strength, Dexterity, Mind
  • Defence
  • Lumbering
  • Fishing
  • Smithing

The final skill list is game content and is not limited to skills found in any particular inspiration game.

27.3 Skill state

Skill progression is persistent player state.

SkillProgress
- skillId
- xp

Level should preferably be derived from XP and the skill's level curve rather than stored as an independent source of truth, although it may be cached.

SkillDefinition
- skillId
- displayName
- levelCurve
- maxLevel (if any)

27.4 Actions are governed by skills

Every gameplay action that participates in progression is associated with a governing skill. Combat attacks are the explicit exception: they have a hit skill and a damage skill, and split XP equally between them (section 26.7).

ActionDefinition
- actionId
- governingSkillId
- requiredLevel
- xpAward / xpFormula
- other requirements

Examples:

Cut tree        -> Lumbering
Catch fish      -> Fishing
Forge sword     -> Smithing
Sword hit       -> Swordfighting + Strength (equal split)
Bow hit         -> Archery + Dexterity (equal split)
Spell hit       -> Magic + Mind (equal split)
Defensive act   -> Defence

The server validates the action, performs the authoritative outcome, and then awards XP according to the action result. A client cannot claim XP independently.

27.5 Skills replace class restrictions

Equipment, recipes, actions, gathering nodes and other content may require skill levels, but there is no permanent class gate. A player can train any combination of skills over time.

This also fits the future scripting model: scripts issue normal actions, and successful scripted actions use exactly the same skill checks and XP rules as manual player actions.

27.6 NPC shops and market-adapted prices

Named shop NPCs can sell items to players. They are not the player marketplace and they do not expose live sell orders. A shop interaction requires being at that NPC.

Stock remains constrained by npcShopAllowed and the ingredient-only rule in 27.1. Each shop NPC has a hidden discount that players never see:

ShopNpc
- npcId
- hiddenDiscount           // multiplier, e.g. 0.9; not shown to clients
- stock[]                  // itemIds this NPC sells

Until an itemId has a player-market last-sale record, the undiscounted value is seedValue from the item definition.

When a last-sale record exists, both tooltips and shops evaluate a timestamp lerp that does not require a per-tick update:

t = min(1, (now - lastTradeAt) / WorldSettings.shopPriceLerpDuration)
undiscounted = lerp(priceFrom, lastTradePrice, t)
shopPrice    = undiscounted * thatNpc.hiddenDiscount

lerp(a, b, t) = a + (b - a) * t. After the configured lerp duration (default one hour), t is capped at 100% and the value rests on the last player-market unit price (times discount, for shops) until another player-market sale occurs.

A new player-market sale captures the then-current undiscounted value as priceFrom (section 25.7), so the lerp restarts toward the new last price without jumping back to seed.

Integer currency must be rounded deterministically at evaluation time. Shop purchase price is computed on the server at the instant of BuyFromShop. Displayed tooltip value is the undiscounted figure and may be refreshed at most once per minute (section 22.6).

Buying from a shop removes the listed price from the player's carried currency, puts the stack in inventory subject to the 32-slot rules, and stamps ItemOrigin.kind = shop with that NPC. Shops in this model sell to players; they do not buy player goods unless a later iteration adds that.

28. Suggested implementation phases

Phase 1 — Single-worker playable core

  • World coordinate helpers, 16×16 chunks and 4×4-chunk regions.
  • Ground/block tile model and chunk spatial occupancy.
  • Basic ECS and fixed simulation tick.
  • ChunkLoader reference counting and sleeping/unloading.
  • Single simulation worker behind the same worker interface planned for

later scaling.

  • world.sqlite read path and state.sqlite persistence service.
  • Admin world editor: chunk navigation, open/closed flag, default grass for

unsaved chunks, ground/block paint, light-emitting blocks, baked cross-chunk light maps, night-to-day preview slider, world settings modal, per-chunk changelog, save to pending revision.

  • SpawnerSystem for at least one non-persistent mob archetype.
  • WebSocket gateway, stub admin-<n> auth until auth.timfalken.com,

character create/select/delete, authoritative command queue and 3×3 chunk replication.

  • Click-to-move with server-side A\*, global walk/run cadence (default 2

tiles/s walk, run every movement tick, walk every other), and SetGait.

  • FrameworkV3 git submodule at client/frameworkv3, built first, then a

game-specific client on top of it with 16×16 sprites, load-time and CI rejection of wrong-sized art (including equipment overlays and recolour masks), layered worn equipment with material recolouring, a player-centered viewport with bounded zoom, client-only lerp of tile-to-tile movement, and night shading from baked light maps.

  • 32-slot player inventory, stack merging, drop/pickup, and 10-minute

non-blocking ground items.

  • Paper items that can be written into unique letter items.
  • Basic proximity chat with server-side distance degradation.
  • Persistent player skill state, including Strength, Dexterity and Mind, and

at least a small initial set of skill-governed actions.

  • Melee and ranged/spell attack validation (8-tile melee adjacency, item/spell

range), server-side hit rolls, damage from the matching damage skill, and equal XP split on a successful player hit.

  • Graceful forced-unload shutdown.

Phase 2 — Operations and live deployment

  • RestartScheduler and player-visible scheduled restart state.
  • origin/master change detection.
  • systemd service supervision and conditional deployment hook.
  • World-revision activation on restart.
  • Admin immediate restart.
  • Migration, backup and startup readiness checks.

Phase 3 — Multi-worker world

  • Multiple worker_threads simulation workers.
  • Region coordinator and dynamic region ownership.
  • Cross-worker entity transfers.
  • Border ghosts and remote actions.
  • Gateway subscriptions spanning multiple workers.
  • Load metrics and neighbour-aware region balancing.

Phase 4 — World depth, social systems and economy

  • Persistent named NPCs and other persistent mob archetypes.
  • Spawner persistent-instance index and duplicate prevention.
  • Optional durable gameplay chunk overrides, written only on unload.
  • Hierarchical pathfinding if long-distance autonomous travel needs it.
  • Persistent player groups and invitations.
  • Carrier-pigeon cargo transit: free dispatch, money or one item stack,

player or nearest-bank destinations, including offline/full-inventory fallback to the recipient vault.

  • Shared unlimited character bank near the marketplace, account

inheritance tab on character delete, blank cheques filled to 99, reserved filled cheques, in-person redemption and pigeon-to-bank cheque transfers.

  • Central marketplace, escrow, deterministic order matching, pigeon-to-bank

settlement for the older counterparty, and a per-item last-sale record for shop/tooltip adaptation.

  • NPC shops that sell npcShopAllowed stock at seed value lerped toward the

last player-market price over shopPriceLerpDuration, with a hidden per-shop discount.

  • Item inspection: name, description, origin (crafter or shop NPC) and

undiscounted current value, refreshed at most once per minute.

  • Player crafting/gathering economy rules and shop-content validation.
  • Broader skill catalogue, progression curves and skill-gated content.

Phase 5 — Player scripting

  • Custom language grammar/compiler/interpreter.
  • ScriptController and event API.
  • CPU/memory/query quotas and sandboxing.
  • Online scripted control mode.
  • Offline retained player entities with expiry and ChunkLoader

behaviour.

  • Persisted/restart-safe script state.

29. Core invariants

InvariantRule
Server authorityClients send intent; the server computes and owns outcomes.
Region ownershipExactly one simulation worker authoritatively owns a region.
Entity ownershipExactly one worker authoritatively owns an entity.
Remote mutationWorkers never directly mutate remote authoritative state.
Spatial separationRegion residency, chunk simulation and client visibility remain distinct.
Persistence separationPersistent and ChunkLoader are independent entity traits.
Chunk persistenceNormal dirty chunk state is written on unload, not periodically.
World authoringEditor changes create pending authored state; the running server stays pinned to its startup revision. Each chunk save appends an admin-attributed diff changelog.
Restart pathPlanned restart force-unloads the world and reuses the ordinary unload save path.
ControlHuman and future scripted control both emit validated action commands.
DeploymentThe game exits gracefully; systemd relaunches it and only pulls/builds when an intentional deployment manifest requests it.
Client architectureFrameworkV3 is a git submodule under client/frameworkv3, built before game client code; backend ECS internals do not become the client object model.
SpritesWorld sprites may be any size. Pivot is horizontal centre and 8px from the sprite bottom, on the tile centre. Blocks and mobiles Y-sort north-behind-south.
AppearanceVisible gear is layered 16×16 overlays on the mob; recolourable channels (such as metal) use material colour without duplicate art sets. Nearby clients receive appearance layers, not another player's inventory.
Play cameraThe play viewport is centered on the local player. Only the admin world editor uses a free chunk camera.
MovementAll ground mobiles share a global walk/run cadence from world settings; the server commits integer tiles; clients lerp for presentation only.
World timeWorld calendar time is server time minus 1200 years. Night darkens tiles the baked light map cannot reach.
World settingsTick timers and global constants are authored in the editor modal, pinned to the world revision, and not hot-patched into a live process.
Baked lightStatic light reach is raycast through passable tiles on chunk save, may cross chunks, and is not recomputed every tick.
Ground itemsPlayer drops last groundItemDespawnDuration (default 10 minutes), block nobody, and are picked up only by a player standing on that tile.
Shop pricesNPC shop prices lerp from the captured pre-sale value toward the last player-market unit price over shopPriceLerpDuration (default one hour), times a hidden per-shop discount.
Proximity speechDistant clients never receive unobscured plaintext that game rules say they cannot understand.
Courier cargoPigeons carry money or one item stack, never a chat packet; cargo is durable in transit and remains delayed.
InventoryA player has 32 slots; a stack occupies one slot; the client never asserts inventory, wallet or vault results.
Shared bankEvery bank reads the same character vault; pigeon deposits become available only after arrival at the nearest bank.
Closed chunksClosed or never-edited chunks are visible but not enterable; never-edited terrain is default grass with no blocks.
AccountsLogin is auth.timfalken.com (or admin-<n> stub). Characters belong to an account; one may be in the world at a time.
NamesSurnames are globally unique per account; first+last is unique per account; names free only after permanent delete.
InheritanceDeleted characters dump inventory, equipment, wallet and vault into an account inheritance tab other characters can claim.
ChequesFilling a cheque reserves vault goods; the bearer item is the claim; destruction without redemption releases the reservation.
Marketplace escrowEvery open order is fully backed by escrow and matching/settlement is atomic and deterministic.
CombatMelee requires an 8-neighbour tile; ranged/spell range comes from the item or spell; hit uses the weapon skill; damage uses Strength, Dexterity or Mind.
ProgressionPlayers have no classes; non-combat actions award XP to one governing skill; a successful attack splits XP equally between hit and damage skills.

30. Important edge cases to preserve during implementation

  • A ChunkLoader crossing a region boundary can change

residency/simulation references and worker ownership in the same tick; ordering must avoid temporary double ownership.

  • A player at a worker boundary may receive visible chunks from multiple

workers without moving ownership solely for rendering.

  • A planned restart must ignore normal ChunkLoader retention when

forcing the world to unload.

  • A world-editor save must never cause newly loaded chunks in the

current process to use the pending revision. It must append a changelog record naming the admin, timestamp and tile diffs.

  • Pathfinding and player movement must reject tiles in closed or

never-edited chunks even when those chunks are in the 3×3 view.

  • Two accounts must not claim the same surname. One account may reuse its

surname; first+last must stay unique on that account until permanent delete.

  • Marking a character for deletion must not free the name or move items

until the delay elapses. Cancelling must restore playability.

  • Character deletion must notify the account email (or log, on stub auth).

Permanent delete must void that character's issued cheques, then move inventory, equipment, wallet and vault into the account inheritance tab.

  • Saving a chunk must rebake that chunk's light map and any neighbour

chunks within max light range, using passable-tile raycasts. Light from a source in chunk A may appear in chunk B.

  • A mob definition must not carry its own walk/run speed; gait only

selects every-other vs every movement tick on the global cadence.

  • World-settings saves must not apply to the live process; they wait for

the same pending-revision restart as chunk edits.

  • Night shading must not light a tile the baked mask marks unreachable,

even if a torch is nearby through a wall.

  • Oversized block and mob sprites must Y-sort so objects higher on the

screen draw behind objects lower on the screen. Closed-chunk edges facing an open chunk must show a red border in the client.

  • Equipping must not leave two items in the same equipment slot. Unequip

into a full inventory must fail and leave the item worn.

  • Nearby clients must not receive another player's inventory in order to

draw their armour; appearance layers and material ids are sufficient.

  • A client build without client/frameworkv3 initialized must fail rather

than silently using some other FrameworkV3 install.

  • Client interpolation of movement must not be treated as authority. Combat

range and pickup use the server tile, not the lerped draw position.

  • The play camera must remain centered on the local player. Zoom must not

expand the subscribed chunk set.

  • A persistent mob spawned by a spawner must not be duplicated merely

because it moved out of the spawner’s loaded area.

  • A non-persistent mob disappears when its chunk is actually unloaded,

not merely when it becomes dormant.

  • If a persistent ChunkLoader or offline scripted player exists after

restart, startup must discover it from an index without loading the entire world.

  • A pending code update followed by an unrelated Node.js crash must

restart the currently deployed commit rather than deploying early.

  • Negative coordinates, daylight-saving midnight calculation, duplicate

transfer messages and failed deployment migrations should all have explicit tests.

  • Proximity chat degradation must happen before plaintext reaches an unauthorised

distant client; rendering-only obfuscation is not sufficient.

  • Carrier-pigeon deliveries must survive restarts and recipient logout without

requiring every traversed chunk to remain stimulated.

  • A pigeon carrying an item to a player whose inventory cannot accept it must

not destroy the cargo; it deposits into that player's vault via the nearest bank.

  • Two concurrent bank withdrawals, cheque fills or pigeon-arrival deposits must

not spend the same vault goods twice.

  • Filling two cheques against the same vault stack must reserve disjoint

quantities or reject the second fill.

  • A filled cheque that expires on the ground must release its reservation and

must not remain redeemable.

  • A player-dropped ground item must not block movement, must not keep its chunk

loaded, and must still be present after a chunk unload/reload if expiresAt has not passed.

  • Pickup of a ground item from a tile the player is not standing on must fail.
  • Requesting blank cheques must never raise the player's carried blank-cheque

count above 99.

  • A marketplace match must atomically consume both escrows exactly once, even if

two compatible orders arrive concurrently.

  • A matching market order from an online player may settle immediately for that

player while the older/offline counterparty's delivery remains durable.

  • Skill XP is awarded only after authoritative action resolution, never directly

from a client-reported result. A successful player attack splits that XP; a miss awards none.

  • A melee attack from the target's own tile, or from Chebyshev distance greater

than 1, must fail. A ranged or spell attack beyond that item or spell's rangeTiles must fail.

  • A new player-market sale must capture the then-current undiscounted lerp

value as priceFrom so shop and tooltip prices do not jump back to seed.

  • Two shop NPCs may charge different prices for the same item at the same

instant because each applies its own hidden discount to the same lerp.

  • Item tooltip value must not be recomputed every tick; a one-minute refresh

is sufficient. Purchase price is still evaluated at the moment of buy.

31. Decisions through version 0.12

  • Chunk persistence is unload-driven rather than periodic.
  • The authored tile model has separate visual ground and functional

block layers.

  • Mobile actors remain ECS entities and are not authored as painted tile

contents.

  • Spawner blocks are editor-placeable and configurable per instance;

persistence belongs to the spawned mob type.

  • world.sqlite is an authored, revisioned world source; state.sqlite

holds runtime durable state.

  • Editor changes are staged for activation on restart instead of

hot-patching the running world.

  • Code/world changes schedule a player-visible midnight restart; admins

can trigger the same graceful pipeline immediately.

  • Git pull/build/relaunch belongs to systemd supervision after the

game process has safely exited.

  • Deployment is manifest-driven: crash recovery restarts the currently

checked-out commit, while only an intentional deployment restart may fast-forward master.

  • Future player scripting is modelled as an alternative controller

producing normal server action commands.

  • Offline scripted players may remain in-world as ChunkLoaders until

death or expiry and must survive planned restarts through persistence.

  • The player client is built on FrameworkV3, included as the git submodule

client/frameworkv3 and built first so this game's client code can layer on top. The client does not need an ECS and consumes protocol state independently of backend ECS storage. The Node.js server does not import FrameworkV3.

  • World sprites may be any pixel size. Each is placed with a pivot at

horizontal centre and 8 pixels from the sprite bottom, on the tile centre. Blocks and mobiles are Y-sorted. The player may zoom the whole viewport within configured bounds; sprites are not scaled individually.

  • Visible equipment is drawn as extra 16×16 layers on the mob, including

players. Worn items occupy equipment slots, not the 32 inventory slots. Nearby clients replicate appearance layers only, never another player's inventory.

  • Recolourable gear (metal armour) shares one overlay sprite and a 16×16

channel mask. Material definitions supply the metal colour; luminance of the overlay is preserved. Iron and steel plate are different items with the same art and different materialId.

  • The play camera is always centered on the local player. The admin world

editor is the only exception, and it frames one chunk at a time.

  • Authoritative movement is a tile-to-tile jump on a global cadence:

default walk 2 tiles/s, run double. Walk steps every other movement tick; run steps every movement tick. Mobs do not set their own speed. Clients lerp for visuals only and never send interpolated positions.

  • Admins edit global tick timers and constants in a world-settings modal.

Those values live in the pending world revision and apply on the next process start, like other editor saves.

  • World calendar time is server time minus 1200 years, same IANA zone as

midnight restarts. At night the client darkens tiles the baked light map cannot reach.

  • Static light is baked on chunk save by raycast through passable tiles,

including across chunk borders. The editor has a night-to-day slider for preview only.

  • Each world-editor chunk save stores who edited it, when, and a bullet

diff of ground changes, block placements, block replacements and block removals at world tile coordinates.

  • Default speech is proximity-based and becomes less legible with distance.

Long-distance exchange is physical: a pigeon carries money or one item stack. A letter is paper with player-written text, not a separate mail record.

  • Permanent player groups are social/addressing structures and do not create an

instant global chat channel.

  • Carrier-pigeon transit is persistent but does not automatically keep every

traversed chunk simulated. Whenever a pigeon passes through a chunk that is already simulating, it materialises as an ECS Mob and is visible to any nearby client whose normal chunk subscription includes it, even if that client is unrelated to the delivery. Unrelated clients do not receive cargo contents.

  • A player has a 32-slot inventory. Stackable items occupy one slot. Currency is

a numeric wallet/vault balance, not an inventory item.

  • Player-dropped items lie on the tile for groundItemDespawnDuration

(default 10 minutes), block nobody, and may be picked up by anyone standing on that tile. They survive unload until expiry via timestamps.

  • The bank near the marketplace holds an unlimited character vault.

Later banks are linked to the same vault. Pigeons may deposit money or one stack into the sender's vault after arriving at the nearest bank. An account-level inheritance tab receives a deleted character's goods.

  • Blank cheques are issued at a bank up to a carried total of 99. Filling a

cheque reserves a vault item quantity. The filled cheque is a bearer item. In-person redemption withdraws into the bearer's inventory. Sending the cheque to the bank by pigeon transfers the reserved goods into the pigeon's sender's vault.

  • The central marketplace hides individual live sell listings and matches durable

escrowed buy/sell orders at the midpoint of compatible bid/ask limits. Quantities are item stacks.

  • The newest matching market participant receives the trade result locally; the

older counterparty receives theirs by pigeon into their bank.

  • NPC shops remain restricted to npcShopAllowed basic ingredients. They sell

to players at lerp(priceFrom, lastTradePrice, min(1, (now - lastTradeAt) / shopPriceLerpDuration)) times a hidden per-shop discount. With no player-market sale yet, the undiscounted value is seedValue. Tooltips use the same lerp without the discount and refresh at most once per minute.

  • Hovering an item shows name, description, origin (crafter, or shop NPC name

if bought there) and current undiscounted value.

  • All combatants can attack. Melee requires standing on one of the eight

neighbouring tiles. Ranged attacks and spells use the item's or spell's range. The hit roll uses the weapon skill; damage uses Strength (melee), Dexterity (ranged) or Mind (magic). Successful player-attack XP is split equally between those two skills.

  • Player progression is skill-based rather than class-based. Non-combat

actions award XP to one governing skill; combat hits split XP as above.

  • Never-edited chunks are default grass, no blocks, and closed. The

editor opens or closes each chunk. Closed chunks are visible but not enterable.

  • Accounts authenticate at auth.timfalken.com. Until that service is up,

each connection is stub admin-<n> (n = connected client count including this one) and is treated as admin.

  • An account has unlimited characters and plays one at a time. Creation

takes first name (not globally unique), last name (globally unique to the account, reusable on that account's other characters), and male/female. first+last must be unique for that account. This setup may change later.

  • Character deletion is a 24-hour (configurable) delay with email notify

and cancel. Permanent delete frees names and moves inventory, equipment, wallet and vault to the account inheritance tab, which any of that player's characters can claim into their own vault.

32. Open design decisions for later iterations

These do not block the initial implementation, but should eventually be specified explicitly:

  • Whether multiple mobile entities may occupy one tile and, if so, which

categories can overlap.

  • Whether player movement is four-direction only or also supports

diagonals. Combat melee adjacency already includes diagonals.

  • Exact hit-chance and damage curves, attack intervals/cooldowns, whether

Defence modifies incoming hit chance or damage, and ranged/spell line-of-sight or obstruction rules.

  • Deterministic rounding when shop discount or lerp produces a fractional

currency amount.

  • Exact equipment slot list, per-slot draw order exceptions (cloaks,

two-handed weapons), and whether worn overlays have facing frames to match the mob.

  • Additional recolour channels beyond metal (for example cloth dyes) and

the exact luminance-preserving remap function.

  • Exact camera zoom minimum, maximum and whether zoom is restricted to

integer steps.

  • Exact night ambient curve (how dark, dusk length) and whether baked light

stores a boolean reach mask or a distance/falloff value per tile.

  • Whether opening a door at runtime should rebake or ignore static light.
  • Exact simulation tick rate stays a world setting; lower-frequency AI and

spawner cadences can still be tuned independently.

  • Exact world/chunk binary serialisation format and schema/version

migration strategy.

  • Whether gameplay can permanently modify ground/block tiles in the

initial release.

  • Spawner timing rules, spawn-point restrictions and behaviour when

persistent spawned mobs travel very far away.

  • World-editor undo/redo and rollback UI. The per-chunk changelog is an audit

log, not by itself an undo stack.

  • Exact restart warning intervals and whether admins can

cancel/reschedule a planned restart.

  • Worker rebalance thresholds and whether regions may migrate while

players are actively crossing their boundaries.

  • Future scripting language syntax, event model and resource quotas.
  • Exact proximity-chat distance curve, maximum range and character degradation

algorithm.

  • Group naming/roles, membership limits and whether group-wide letter sending

is offered as an addressing convenience that still dispatches one pigeon and consumes one paper/letter per recipient.

  • Whether pigeons can eventually be intercepted, killed or redirected in transit.
  • Marketplace partial fills, cancellation rules, fees/taxes (if any),

tie-breaking details and midpoint rounding for indivisible currency.

  • Whether market price history or aggregate statistics are visible despite live

order listings remaining hidden.

  • Initial skill catalogue, XP curves, level caps, action XP formulas and the

remaining interpretation of skills such as Defence.

  • Maximum letter body length and whether writing paper requires a desk or can be

done from inventory anywhere.

  • Exact item catalogue, which items stack, per-item maxStackSize exceptions,

harvest interactions and ground-item spawner parameters.

  • Whether death drops inventory, and whether dropped unique items other than

cheques have destruction side-effects.

  • Whether the issuer can void a filled cheque without the bearer item being

destroyed, and whether cheques can ever represent currency rather than items.

  • Whether a short dispatch interval is needed so many pigeons cannot leave in a

single tick, even though sending remains free.

  • New-character spawn location (must be an open chunk) and name length /

allowed-character rules.

  • Later changes to character creation beyond first name, last name and sex.

33. Architectural summary

ECS → what an entity is and what systems can act on it Chunk → tile data, spatial lookup, simulation and client subscription Region → residency and simulation-worker ownership Coordinator→ where regions execute Gateway → stable client connections, auth, character select, and command/update routing world.sqlite→ authored versioned ground/block/spawner/light/settings world; unedited chunks are closed grass state.sqlite→ accounts, characters, vaults, inheritance, and other durable live-game state systemd → process supervision and relaunch Deployment hook → conditional Git update/build only for intentional deployment restarts Controller → manual client input today; sandboxed player scripts later FrameworkV3 → git submodule at client/frameworkv3; built first; game client code layers on top Sprites → any size; pivot at horizontal centre, 8px from bottom; Y-sort blocks/mobs Equipment → layered 16×16 overlays on mobs; metal armour shares art and recolours by material Camera → play view centered on the local player; bounded zoom; editor is chunk-framed Movement → global walk/run cadence (default 2 tiles/s walk, run double); server tile steps; client visual lerp World time → server clock minus 1200 years; night darkens unlit tiles Light → baked passable-tile raycast on editor save; shines across chunks World settings → admin modal for tick timers and global constants; pending revision Inventory → 32 slots; stacks occupy one slot; letters are written paper items Bank → per-character vault; account inheritance tab on character delete Auth → auth.timfalken.com, stub admin-<n> until live; unlimited characters, one in world Chunks → editor open/closed; default grass and closed until painted Ground items → non-blocking, 10-minute player drops, pickup only while standing on the tile Communication service → proximity speech CourierService → pigeons carrying money or one item stack through durable transit BankService → shared unlimited vaults, cheque reservations and redemption MarketService → durable escrowed order book, matching, last-sale index and pigeon-to-bank settlement Shop NPCs → sell allowed stock; price lerps toward last player-market sale over shopPriceLerpDuration, times a hidden discount Combat → 8-tile melee, item/spell ranged range; hit skill roll; Strength / Dexterity / Mind damage; equal XP split Skills → classless progression; non-combat XP to one skill; attack XP split hit/damage

34. Version history

0.12

  • Chunks are open or closed in the world editor. Closed chunks stay visible

but cannot be entered. Never-edited chunks are default grass with no blocks and are closed.

  • Login uses auth.timfalken.com; until that is live, connections are stub

admin-<n> (connected-client count including this one) and are admins.

  • Accounts have unlimited characters, one in the world at a time. Creation

is first name, unique account-owned last name, and male/female.

  • Character deletion waits 24 hours with email and cancel. Permanent delete

frees names and moves goods to an account inheritance bank tab.

0.11

  • Made walk/run a global cadence from world settings (default 2 tiles/s

walk, run double): walk steps every other movement tick, run every tick. Mob definitions do not set move speed.

  • Added an admin world-settings modal for tick timers and global constants

(shop lerp duration, drop lifetime, simulation tick, and the same class of values). Settings ride the pending world revision.

  • World calendar time is server time minus 1200 years.
  • Baked static lighting by passable-tile raycast on chunk save, including

across chunk borders. Clients darken unreachable tiles at night. The editor has a night-to-day preview slider.

0.10

  • Drew visible equipment as 16×16 overlay layers on mobs (including players),

with worn items in equipment slots rather than the 32-slot inventory.

  • Replicated compact appearance layers to nearby clients instead of another

player's inventory.

  • Recolourable metal armour shares one overlay plus a 16×16 channel mask;

material definitions supply the metal colour while preserving shading.

0.9

  • Vendored FrameworkV3 as the git submodule client/frameworkv3. The game

client builds that library first and implements game-specific code on top of it. The Node.js server does not import the submodule.

0.8

  • Required all world sprites (tiles, blocks, mobs, items) to be 16×16 pixels,

rejected at load, with a CI unit test that reports and fails on any other size. Sprites are not individually scaled; the player may zoom the viewport within configured bounds.

  • Locked the play camera to the local player. The admin world editor remains

the only non-player-centered view.

  • Made authoritative movement integer tile-to-tile steps. Clients lerp

mobiles for presentation only.

  • Added a per-chunk world-editor changelog: admin, timestamp, and bullet

diffs for ground changes, block place/change/remove.

0.7

  • Added combat for all mobs including players: melee from any of the eight

neighbouring tiles, ranged and spells from the item or spell range.

  • Hit rolls use the weapon skill (Swordfighting, Axefighting, Archery, Magic,

and so on). Damage uses Strength, Dexterity or Mind according to melee, ranged or magic.

  • Successful player-attack XP is split equally between the hit skill and the

damage skill. Ordinary mobs use archetype skill levels and do not earn XP.

  • Shop NPCs sell items at seed value adapted to the last player-market unit

price, lerping over one hour, multiplied by a hidden per-shop discount.

  • Only the latest player-market sale per item is stored (price, timestamp, and

lerp origin). No historical series.

  • Item hover shows name, description, origin (crafter or shop NPC) and the

undiscounted current value, refreshed at most once per minute.

0.6

  • Added a 32-slot player inventory, stackable items, carried currency as a

numeric wallet, and unique-instance items for letters and filled cheques.

  • Redefined letters as paper items with player-written text rather than a

separate mail record.

  • Redefined carrier pigeons as free couriers that carry money or one item

stack to a player or to the nearest bank.

  • Added a shared unlimited bank near the marketplace, blank cheques filled to

99, vault reservations on fill, in-person redemption and pigeon-to-bank cheque transfers between vaults.

  • Added player-dropped ground items: 10-minute lifetime, non-blocking, pickup

only while standing on the tile, timestamp persistence across unload.

  • Specified later ground-item spawners and harvesting as content that reuses

this item model.

  • Routed offline/full-inventory pigeon delivery and older-side market

settlement into the recipient's shared bank vault.

0.5

  • Made carrier pigeons shared world-visible entities whenever their route crosses an already-simulating chunk.
  • Unrelated nearby players can see pigeons in their normal 3x3 chunk view; pigeons do not keep chunks loaded themselves.
  • Added deterministic materialisation/dematerialisation between durable abstract transit and worker-owned ECS pigeon entities.

0.4

  • Added FrameworkV3 as the shared player-client foundation while keeping backend ECS internal to the server.
  • Added server-side proximity chat degradation, persistent player groups and durable carrier-pigeon letters.
  • Added scalable courier transit that can cross dormant world space without forcing normal chunk simulation.
  • Added the central marketplace, escrowed hidden order book, midpoint pricing and pigeon-based remote settlement.
  • Added the player-driven item-source philosophy and restrictions on NPC shop inventories.
  • Added classless, skill-based player progression and authoritative skill XP.

0.3

  • Converted the living design document to Markdown as the canonical format.
  • Defined systemd as the production process supervisor.
  • Added a conditional, manifest-driven deployment path so crashes do not deploy pending code early.
  • Added a concrete example systemd service shape and clarified privilege separation.

0.2

  • Added unload-driven chunk persistence, authored world revisions, the admin world editor, spawner blocks, graceful scheduled restarts and future player scripting hooks.
Source
1---
2title: Tile MMO Server Technical Design
3version: 0.12
4status: proposed
5format: living-design-document
6---
7
8# Tile MMO Server Technical Design
9
10**Version:** 0.12
11**Status:** Proposed architecture; intended to be iterated as implementation decisions are made.
12**Scope:** Authoritative Node.js/ECS backend, FrameworkV3-based game client (16×16 sprites, player-centered viewport), chunk/region streaming, SQLite persistence, admin world editor with per-chunk changelogs, player inventory and items, combat, player communication, banking/cheques, shopkeepers, marketplace/economy systems, skill progression, automatic restart/update orchestration, and future player scripting hooks.
13
14# 1. Design goals
15
16- Support a large tile-based MMO world without simulating unused areas.
17
18- Keep the server fully authoritative: clients send actions and
19 intentions, never authoritative state changes.
20
21- Authenticate accounts via auth.timfalken.com (with an `admin-<n>` stub
22 until that service is live). An account may have unlimited characters,
23 one in the world at a time, with delayed deletion and an inheritance
24 bank tab.
25
26- Use ECS composition for entities and systems, while using chunks and
27 regions for spatial ownership and simulation lifecycle.
28
29- Allow simulation work to scale across Node.js workers and permit
30 entities to cross worker-managed region boundaries safely.
31
32- Keep client replication small: a player receives only the current
33 16×16 chunk and the eight neighbouring chunks.
34
35- Keep authored world data separate from ephemeral simulation state.
36
37- Persist only entities that explicitly need persistence; ordinary
38 spawned mobs disappear when their chunk is unloaded.
39
40- Avoid constant chunk writes. Normal chunk persistence occurs on
41 unload; graceful shutdown is implemented as a forced unload of all
42 resident chunks.
43
44- Provide an admin-only graphical world editor for painting tiles,
45 opening or closing chunks, and placing/configuring spawners, with a
46 per-chunk changelog of who changed what and when. Unedited chunks are
47 grass-only and closed.
48
49- Automatically schedule a graceful midnight restart when live code or
50 authored world data changes, with an admin-triggered immediate restart
51 path.
52
53- Reserve a clean control abstraction for a later sandboxed player
54 scripting language without requiring the scripting system in the
55 initial release.
56
57- Build the player-facing client on the shared FrameworkV3 library, vendored
58 as a git submodule and built first so game-specific client code can layer
59 on top of it, while keeping the server-side ECS an implementation detail of
60 the backend. World sprites may be any size; each uses a centred pivot
61 8 pixels from the sprite bottom. The play viewport stays
62 centered on the local player.
63
64- Authoritative movement is tile-to-tile at a **global** walk/run cadence
65 (default walk 2 tiles/s, run double), not a per-mob speed. Admins edit
66 that cadence and other tick timers in a world-settings modal. World
67 calendar time is server time minus 1200 years. At night the client
68 darkens unlit tiles; static light reach is baked by raycast when a
69 chunk is saved.
70
71- Give every player a 32-slot inventory in which stackable items occupy a
72 single slot, and treat dropped items as temporary, non-blocking ground
73 objects rather than tile occupancy.
74
75- Make ordinary communication spatial rather than global: nearby speech is
76 progressively degraded by distance, while long-distance exchange is a
77 physical item or currency delivery by carrier pigeon. A letter is simply a
78 paper item with player-written text.
79
80- Support persistent player groups without turning them into an instant
81 long-distance chat channel.
82
83- Provide a shared, unlimited player bank near the marketplace, with later
84 banks all reading the same vault, plus bearer cheques and free pigeon
85 deposits.
86
87- Make the central marketplace an order-matching service rather than a public
88 auction list, with durable escrow and asynchronous pigeon delivery.
89
90- Keep the economy predominantly player-driven: most ingredients are gathered,
91 final goods are normally crafted by players, and finished-item drops come from
92 enemies/bosses rather than ordinary NPC shops.
93
94- Let every combatant — players and other mobs — attack. Melee requires an
95 adjacent tile including diagonals; ranged attacks and spells use the range
96 of the weapon or spell. A hit roll uses the weapon skill; damage uses
97 Strength, Dexterity or Mind. Attack XP is split equally between those two
98 skills.
99
100- Let shop NPCs sell items at a seed value that lerps toward the last
101 player-market sale price over a configurable duration (default one hour),
102 with a hidden per-shop discount.
103 Item inspection shows name, description, origin and the undiscounted
104 current value, refreshed at most once per minute.
105
106- Use skill-based progression with no player classes. Every gameplay action is
107 governed by a skill and awards XP to that skill when successfully performed.
108 Combat is the explicit dual-skill exception: hit skill and damage skill
109 share the XP.
110
111# 2. Core world model
112
113## 2.1 Spatial hierarchy
114
115World
116└── Region: 4 × 4 chunks
117└── Chunk: 16 × 16 tiles
118└── Tile
119
120One chunk contains 256 tiles. One region is 64×64 tiles and contains 16
121chunks (4,096 tiles). World tile coordinates are canonical; chunk and
122region coordinates are derived from them.
123
124chunkX = floor(tileX / 16)
125chunkY = floor(tileY / 16)
126regionX = floor(chunkX / 4)
127regionY = floor(chunkY / 4)
128
129If negative world coordinates are allowed, use true floor division
130rather than JavaScript integer truncation.
131
132## 2.2 Three independent spatial states
133
134The design deliberately separates region residency, chunk simulation,
135and client visibility.
136
137| **Concern** | **Unit** | **Meaning** |
138|-------------|----------|------------------------------------------------------------------------------------------------|
139| Residency | Region | Whether the region and its required chunk data exist in server memory and have a worker owner. |
140| Simulation | Chunk | Whether ECS systems actively simulate entities and gameplay in this chunk. |
141| Visibility | Chunk | Whether a specific client is subscribed to the chunk and receives its snapshot/deltas. |
142
143## 2.3 Region states
144
145UNLOADED
146↓ load
147RESIDENT
148↓ no residency references + grace period
149UNLOADED
150
151A resident region is assigned to exactly one simulation worker. An
152unloaded region has no active ECS representation.
153
154## 2.4 Chunk states
155
156DORMANT ⇄ SIMULATING
157
158A dormant chunk can remain resident in memory while normal gameplay
159systems ignore it. A simulating chunk participates in movement, combat,
160AI, spawners and other active systems.
161
162# 3. Tile layers and occupancy
163
164## 3.1 Ground layer
165
166Every tile has a ground type. Ground is visual only. It does not by
167itself block movement, cause collision, or create gameplay behaviour.
168
169TileGround {
170groundTypeId: GroundTypeId
171}
172
173## 3.2 Block layer
174
175A tile may also contain one block. The block is the actual world object
176standing on the tile and can determine collision and behaviour.
177
178TileBlock {
179blockTypeId: BlockTypeId \| null
180config?: BlockConfig
181}
182
183Examples include walls, doors, trees, torches and other lights, containers,
184spawners, marketplace counters and banks. Block definitions determine
185properties such as passability, interaction behaviour, whether a block
186participates in navigation, and whether it emits light (`lightRangeTiles`).
187
188## 3.3 MOBile entities
189
190A moving game entity — player, enemy, animal, NPC or any other mobile
191actor — is represented by an ECS entity rather than being painted into
192the static tile map. A mobile entity may inhabit a tile in addition to
193the tile’s ground and block layers, subject to collision rules.
194
195Tile
196├── Ground (visual layer)
197├── Block (static/world-object layer; optional)
198├── Ground item stacks (ephemeral, non-blocking)
199└── Mobile ECS entities (dynamic occupancy)
200
201The spatial chunk index maintains which mobile entity IDs currently
202occupy each tile, allowing collision, nearby queries and replication
203without scanning the global ECS. Ground item stacks are indexed per
204tile as well, but they never contribute to movement collision and never
205prevent a mobile entity from standing on that tile.
206
207# 4. ECS model
208
209## 4.1 Entity composition
210
211Entities are numeric identities plus components. Behaviour comes from
212systems querying component combinations rather than deep class
213inheritance.
214
215Player
216Position
217Movement
218Health
219Combat
220Skills
221Inventory
222Currency
223Equipment
224Player
225NetworkIdentity
226ChunkLoader
227Persistent
228
229Ordinary enemy
230Position
231Movement
232Health
233Combat
234Skills
235Creature
236AI
237
238Named NPC
239Position
240Movement
241Health
242NPC
243AI
244Persistent
245
246## 4.2 Global identity versus local ECS handle
247
248Use a globally meaningful EntityId for storage, networking and
249cross-worker transfer, and a compact worker-local EntityHandle for hot
250ECS arrays. A transferred entity keeps its EntityId but may receive a
251different local handle on the destination worker.
252
253## 4.3 Recommended initial components
254
255| **Category** | **Components** |
256|----------------|----------------------------------------------|
257| Spatial | Position, Movement, Path, Collision |
258| Living | Health, Combat, Creature, Mob, Skills |
259| Player | Player, NetworkIdentity, Inventory, Currency, Equipment |
260| AI | AI, Target, BehaviourState |
261| Lifecycle | ChunkLoader, Persistent, SpawnOrigin |
262| Presentation | Renderable / Appearance |
263| Future control | Controller / ScriptController / OfflineUntil |
264
265# 5. ChunkLoader and simulation activation
266
267## 5.1 Generic ChunkLoader component
268
269World activation is component-driven rather than player-specific. Any
270entity may carry a ChunkLoader component that says “keep the surrounding
271world resident and simulated”.
272
273ChunkLoader {
274simulationRadiusChunks: 1,
275regionLoadRadius: 1
276}
277
278A normal player can therefore stimulate a 3×3 chunk area while keeping
279the surrounding 3×3 regions resident. Bosses, travelling NPCs, machines,
280scripted actors or administrative anchors can use the same mechanism.
281
282## 5.2 Reference counting
283
284Chunk simulation and region residency should use reference counts.
285Overlapping loaders increment the same references; leaving decrements
286them. A chunk sleeps only when its simulation reference count reaches
287zero. A region becomes eligible for unload only when its residency
288references reach zero.
289
290## 5.3 Grace period
291
292After the last residency reference disappears, retain the region briefly
293before unloading. This prevents repeated SQLite reads and writes when a
294loader oscillates around a boundary. The delay should be configurable.
295
296# 6. Chunk lifecycle and persistence
297
298## 6.1 No periodic chunk saves
299
300Normal gameplay does not periodically rewrite loaded chunks. A chunk is
301saved as part of the unload path only.
302
303Resident chunk
304↓ last residency / forced shutdown unload
305Prepare unload
306↓
307Persist required chunk state once
308↓
309Persist required entities
310↓
311Remove ECS/runtime representation
312
313A graceful server restart does not introduce a second save mechanism. It
314force-unloads every resident region/chunk, so the normal unload
315persistence path remains the single source of truth.
316
317## 6.2 Persistent versus non-persistent entities
318
319Persistence is an entity property, not a property of the chunk or
320spawner. An entity with Persistent is serialised when its owning
321chunk/region unloads. A non-persistent entity is simply discarded.
322
323Non-persistent wolf
324spawn → simulate → chunk unload → disappear
325
326Persistent named NPC
327load → simulate → chunk unload → save → recreate when area loads
328
329## 6.3 Persistent is independent of ChunkLoader
330
331These traits must remain independent. A persistent entity does not
332automatically keep its area active, and a ChunkLoader does not
333automatically become persistent.
334
335# 7. Storage architecture
336
337## 7.1 Separate authored world and runtime state
338
339Use two SQLite databases with different responsibilities.
340
341| **Database** | **Responsibility** |
342|--------------|-----------------------------------------------------------------------------------------------------------------------------------------|
343| world.sqlite | Admin-authored ground tiles, block tiles, light maps, world settings, spawner configuration, per-chunk editor changelogs, world revisions and world metadata. |
344| state.sqlite | Accounts, characters, inventories, carried currency, character vaults, inheritance tabs, cheque reservations, skills, groups, courier cargo/transit, unexpired ground items, market orders/escrow/trades, per-item last player-market sale, persistent ECS entities, offline-script state, optional persistent runtime chunk overrides, and other durable live-game state. |
345
346This prevents editor authoring changes from becoming entangled with live
347player/entity persistence.
348
349## 7.2 Chunk writes in runtime state
350
351If initial gameplay does not allow permanent tile/block modification,
352runtime chunks require no writes at all. If permanent runtime world
353changes are later added, dirty chunk overrides are held in memory and
354written to state.sqlite only when that chunk unloads. Shutdown uses
355forced unload and therefore follows the same rule.
356
357## 7.3 Central persistence service
358
359Simulation workers should not independently compete for SQLite writes. A
360persistence service owns the write connection, batches transactions, and
361receives logical save requests from workers.
362
363Simulation workers
364│ save/unload messages
365▼
366Persistence service
367│
368▼
369SQLite (WAL)
370
371Live ECS state remains authoritative while loaded; SQLite is durable
372state, not a per-tick synchronisation mechanism.
373
374# 8. World authoring and revision model
375
376## 8.1 Admin-only world editor
377
378The server includes a separate admin-only world editor UI. It is not
379part of the normal player client.
380
381- Display a 3×3 of 16×16 chunks, with the currently selected
382 chunk in the centre and a red border around that chunk.
383 Painting, open/closed, and changelog apply only to the
384 selected chunk; neighbours are visible for alignment and
385 baked lighting context.
386
387- Provide Up, Down, Left and Right navigation buttons that move the
388 editor exactly one chunk in that direction.
389
390- Show the current chunk coordinates prominently, and whether the chunk
391 is **open** or **closed**.
392
393- Toggle the current chunk open or closed. Closed chunks remain visible
394 to nearby players but cannot be entered.
395
396- Allow painting a ground type on a tile.
397
398- Allow painting, replacing or erasing the block type on a tile.
399
400- Render both layers together so the block appears on top of the ground.
401
402- Do not display ordinary mobile entities as editable map paint.
403
404- Allow selecting/configuring special block types such as Spawner, Bank,
405 Marketplace and light-emitting blocks (`lightRangeTiles`).
406
407- Open a **world settings** modal for global tick timers and constants
408 (movement cadence, shop lerp duration, drop lifetime, and other values
409 listed in section 8.5).
410
411- Provide a **night-to-day slider** that only previews lighting; it does
412 not change live world time. Preview uses the same baked light maps as
413 play, including light that reaches this chunk from neighbouring chunks.
414
415- Later: allow configuring ground-item spawners analogously to mob
416 spawners. Exact item tables remain a later content decision.
417
418- Save changes through an authenticated admin API; the browser never
419 opens SQLite directly.
420
421- Show that chunk's changelog: a chronological list of saves, each with
422 which admin made the edit, when, and a bullet-point diff of the change.
423
424The editor camera is **not** locked to a player character. It frames the
425currently selected chunk. This is the only intended exception to the
426player-centered play viewport in section 21.4.
427
428## 8.2 World editor save behaviour
429
430Saving a chunk **or world settings** writes the authored result to
431world.sqlite. It does not live-patch the currently running simulation.
432Instead, the change creates or updates a pending world revision and
433schedules a server restart for the next server-local midnight.
434
435The running game remains pinned to the world revision selected at its
436own startup. This avoids a dangerous mixed state where some loaded
437chunks use old authored data and newly loaded chunks use newer editor
438data.
439
440## 8.3 Versioned authored chunks
441
442A practical schema is to give every editor change a monotonically
443increasing world revision. The game process pins one active revision for
444its entire lifetime. Chunk lookup selects the latest authored version
445not newer than that pinned revision.
446
447world_revisions
448revision_id
449created_at
450created_by
451status // pending / active / superseded
452
453world_chunk_versions
454chunk_x
455chunk_y
456revision_id
457open // player-enterable; default false until set
458data_blob
459
460world_meta
461active_revision
462pending_revision
463
464world_settings
465revision_id
466settings_blob // walk speed, tick timers, shop lerp, drop TTL, ...
467
468world_chunk_edit_log
469log_id
470chunk_x
471chunk_y
472revision_id
473editor_admin_id
474edited_at
475diff_entries // structured bullets for this save
476
477On the next planned restart, startup promotes/selects the latest valid
478pending revision before world loading begins.
479
480## 8.4 Per-chunk changelog
481
482Every successful chunk save appends one changelog record for that chunk.
483The record is durable in `world.sqlite` and is not gameplay state.
484
485The server diffs the newly saved chunk against the previous authored
486version of that same chunk (the latest `world_chunk_versions` row for
487those coordinates that this save replaces). Unchanged tiles produce no
488bullets. Each changed tile becomes one of:
489
490```text
491- Ground at X, Y changed from Prev to New.
492- Block <type> placed at X, Y.
493- Block at X, Y changed from Prev to New.
494- Chunk opened.
495- Chunk closed.
496```
497
498`X, Y` are world tile coordinates. `Prev` / `New` / `<type>` are the
499ground or block definition display names. A block paint on an empty block
500layer is a placement. Replacing one block type (or its config, such as a
501spawner) with another is a change. Erasing a block is a removal. Ground is
502never absent; a ground paint is always a change from one type to another.
503
504The editor UI lists records newest-last or newest-first consistently, each
505headed by admin identity and timestamp, with that save's bullets underneath.
506The changelog is an audit trail, not an undo stack. Undo/redo remains an
507open editor-UX decision. Derived light maps are not changelog bullets;
508they are regenerated on save (section 8.6).
509
510## 8.5 World settings
511
512Global gameplay constants live in authored `world_settings` for the world
513revision. They are **not** per-mob and **not** client-authored. Admins
514edit them from a modal in the world-editor UI. Saving the modal writes
515into the pending world revision and schedules the same midnight restart
516as a chunk save. The running process keeps the settings it loaded at
517startup.
518
519Minimum initial settings and defaults:
520
521```text
522WorldSettings
523- walkTilesPerSecond // default 2
524- simulationTickHz // default 20; implementation default, still a setting
525- shopPriceLerpDuration // default 1 hour
526- groundItemDespawnDuration // default 10 minutes
527- regionUnloadGracePeriod // configurable grace after last residency
528- defaultGroundTypeId // grass used for never-edited chunks
529- characterDeletionDelay // default 24 hours
530```
531
532Running is always **double** walking speed. It is not a separate per-entity
533field. From `walkTilesPerSecond`:
534
535```text
536runTilesPerSecond = walkTilesPerSecond * 2 // default 4
537movementTickHz = runTilesPerSecond // default 4 Hz
538walk: commit a tile every 2 movement ticks
539run: commit a tile every 1 movement tick
540```
541
542All ground mobiles — players, enemies, NPCs — use this same cadence. A
543mob definition does not set move speed. Gait (`walk` | `run`) is the only
544per-entity choice; it selects every-other vs every movement tick.
545
546Other tick-duration constants that already exist in this document (shop
547lerp, ground-item despawn, residency grace, and later ones of the same
548kind) are edited here rather than hardcoded. Adding a new global timer
549means adding a field to `WorldSettings` and a row in this modal.
550
551## 8.6 Baked lighting
552
553Light from authored blocks is precomputed when a chunk is saved, not
554raytraced every simulation tick.
555
556A block definition may set `lightRangeTiles > 0`. That tile is a static
557light source. Light travels only through **passable** tiles (the same
558passability as walking). Ground type does not block light. Mobiles and
559ground items do not block light.
560
561For every tile within a source's range, the baker runs a simple grid
562raycast (for example Bresenham through tile centres). If the ray hits an
563impassable block before the destination, that source does not light that
564tile. A tile is lit if **any** source can reach it. Light **does** shine
565across chunk boundaries.
566
567Saving a chunk rebakes:
568
5691. that chunk's 16×16 light map, and
5702. every neighbouring chunk that could be affected (chunks within the
571 maximum `lightRangeTiles` of the saved chunk).
572
573Neighbor rebakes use light sources and walls from the pending revision,
574including the chunk just saved. Those neighbor light maps are written
575into the same pending revision so play never mixes old and new lighting.
576
577The light map is stored in the chunk `data_blob` as a 16×16 intensity
578(0 = unreachable, 1–255 = falloff by distance from the strongest
579reaching source). The client darkens tiles by that intensity at night,
580so a torch fades tile-by-tile rather than lighting a hard disc. It is
581replicated to clients in `CHUNK_SNAPSHOT` / `CHUNK_DELTA`.
582
583Runtime door open/close does not rebake static light unless a later
584iteration adds live lighting. Baked light is authored geometry.
585
586The editor night-to-day slider interpolates preview ambient from full
587night (dark except baked-lit tiles) to full day (no ambient darkening).
588It does not persist and does not change server/world clock.
589
590## 8.7 Default chunks and open / closed
591
592A chunk the editor has never saved does not exist in `world_chunk_versions`.
593At runtime it is synthesised as:
594
595- every tile `defaultGroundTypeId` (grass),
596- no blocks,
597- **closed**,
598- no baked lights.
599
600The world is therefore an infinite grass field until admins paint it, and
601players cannot walk onto it until an admin **opens** the chunk.
602
603**Closed** chunks can still appear in a player's 3×3 view. They cannot be
604entered: `MOVE_TO`, pathfinding, spawning, and other player-entry actions
605treat every tile in a closed chunk as impassable. Visibility and lighting
606previews are unchanged. Where an **open** chunk shares an edge with a
607closed (or never-edited) chunk, the client draws a red border on that
608edge so players can see they cannot cross.
609
610**Open** chunks are the playable map. Opening or closing is an authored
611chunk flag, saved with the pending revision like paint.
612
613Spawners in a closed chunk do not spawn. Ground movement, including AI,
614does not step into a closed chunk. If a future bug or admin tool places an
615entity there, it can still be replicated to observers, but players cannot
616walk in after it.
617
618# 9. Spawner blocks
619
620## 9.1 Spawner data
621
622A Spawner is a block in the authored block layer, with per-instance
623configuration stored as part of the chunk data.
624
625SpawnerConfig {
626spawnerId: SpawnerId,
627mobTypeId: MobTypeId,
628maxAlive: number,
629spawnRangeTiles: number
630}
631
632Additional parameters such as minimum/maximum spawn delay can be added
633later without changing the core model.
634
635## 9.2 Spawner editor
636
637Selecting a Spawner tile in the world editor opens a configuration panel
638containing at minimum: mob type, maximum alive count and spawn range.
639Validation happens server-side before the pending world revision is
640written.
641
642## 9.3 Spawned entity persistence
643
644The spawner never decides whether its mob is persistent. The mob
645definition/archetype does. When the spawner creates an entity, the
646entity receives Persistent only if that mob type is defined as
647persistent.
648
649MobDefinition: deer
650persistent = false
651
652MobDefinition: named_guard_captain
653persistent = true
654
655## 9.4 SpawnOrigin
656
657Spawned mobs receive a SpawnOrigin component referencing the spawner.
658This lets maxAlive count only entities belonging to that spawner and
659avoids expensive geometric searches.
660
661SpawnOrigin {
662spawnerId: SpawnerId
663}
664
665For non-persistent mobs, disappearance on chunk unload naturally
666decreases the count. For persistent mobs, SpawnOrigin is persisted so
667the spawner can recognise an existing persistent instance even after it
668has moved or been unloaded elsewhere. A lightweight persistence index by
669spawnerId prevents duplicate persistent spawns.
670
671## 9.5 Spawner simulation
672
673SpawnerSystem runs only while the spawner’s chunk is simulating **and
674open**, and at a much lower frequency than movement. A spawn candidate
675must satisfy block collision, bounds, an open chunk, and mobile-occupancy
676rules. Ground type does not affect passability unless a later gameplay
677system explicitly introduces a separate rule for it.
678
679## 9.6 Future ground-item spawners
680
681Some items will later spawn naturally on the ground, using a world-editor
682block analogous to a mob spawner. Those spawned stacks should use the same
683non-blocking ground-item representation as player drops, but their lifetime,
684respawn and `maxOnGround` rules belong to the spawner configuration rather
685than the 10-minute player-drop timer.
686
687Exact item lists, harvest interactions and spawner parameters are later
688content decisions and do not block the inventory/bank model.
689
690# 10. Startup and loading order
691
692Loading order is explicit so authored world state exists before
693persistent entities are instantiated into it.
694
695> **1.** Start process and load configuration, including server time
696> zone and storage paths.
697>
698> **2.** Open world.sqlite and validate/migrate its schema.
699>
700> **3.** Select/promote the world revision to use for this process and
701> pin it for the lifetime of the process.
702>
703> **4.** Load static registries: ground definitions, block definitions,
704> item definitions, material definitions, spell definitions, mob archetypes and component serializers.
705>
706> **5.** Open state.sqlite and run runtime-state migrations.
707>
708> **6.** Start the persistence service, durable domain services (such as courier, bank, market and shop-price services when enabled), region coordinator and simulation workers.
709>
710> **7.** Load the index of persistent entities that themselves require
711> world activation (for example persistent ChunkLoaders or future
712> offline scripted players).
713>
714> **8.** For each required region, load authored chunk data from the
715> pinned world revision first.
716>
717> **9.** Apply any durable runtime chunk override state, if the game
718> supports such modifications.
719>
720> **10.** Instantiate persistent entities into the already-created
721> world/chunks.
722>
723> **11.** Recalculate ChunkLoader references and begin chunk simulation.
724>
725> **12.** Only after the world reports READY does the gateway accept
726> normal player logins.
727
728This ordering solves the bootstrap problem for persistent entities that
729keep their own chunks active: a compact persistence index can locate
730them without first loading the entire world.
731
732# 11. Simulation workers and region ownership
733
734## 11.1 Ownership invariant
735
736Exactly one worker authoritatively owns a region at any instant. Every
737authoritative entity belongs to the worker that owns the entity’s
738current region.
739
740## 11.2 Coordinator
741
742A central region coordinator maintains RegionId → WorkerId and
743assigns/migrates regions based on actual measured simulation effort,
744while preferring neighbouring regions on the same worker when load
745permits.
746
747## 11.3 Work measurement
748
749- Average and high-percentile tick execution time.
750
751- Number of simulating chunks.
752
753- Number of active entities and AI entities.
754
755- Pathfinding work and queued searches.
756
757- Cross-worker boundary message volume.
758
759- Backlog / tick lateness.
760
761Actual time spent simulating is more important than raw player count or
762raw region count.
763
764## 11.4 Node.js implementation
765
766Start with Node.js worker_threads for simulation workers. Keep mutable
767ECS worlds isolated per worker and use message passing between them. Do
768not begin with a shared mutable ECS in SharedArrayBuffer.
769
770# 12. Cross-worker communication
771
772## 12.1 No remote mutation
773
774A worker may inspect a limited read-only representation of neighbouring
775entities but never directly mutates authoritative state owned by another
776worker.
777
778## 12.2 Border ghosts
779
780Neighbouring workers can exchange compact border/ghost entity data for
781nearby interaction and AI: EntityId, position, collision footprint, type
782and minimal combat metadata. Ghosts are not full ECS entities and are
783never authoritative.
784
785## 12.3 Remote actions
786
787Worker A goblin targets Player 42 (owned by Worker B)
788Worker A → REMOTE_ACTION(attack intent) → Worker B
789Worker B validates range/state and applies authoritative result
790
791## 12.4 Entity transfer
792
793When an entity crosses from a region owned by Worker A into one owned by
794Worker B, ownership is handed off at a simulation tick boundary using a
795sequence-numbered transfer protocol. There is never more than one
796authoritative copy.
797
798A: prepare transfer
799B: validate / accept
800A: freeze at handoff boundary
801B: instantiate authoritative entity at effective tick
802Coordinator: update ownership mapping
803A: remove authoritative copy
804
805# 13. Server tick and stimulation
806
807## 13.1 Fixed simulation tick
808
809Use a fixed server simulation tick. The default is 20 Hz (50 ms), stored
810as `WorldSettings.simulationTickHz`. This is not a protocol promise.
811
812Movement does **not** commit a new tile on every simulation tick. See
813section 13.4.
814
8151\. Drain validated incoming commands
8162. Apply completed worker/entity transfers
8173. Recalculate activation changes
8184. Movement / collision
8195. Combat
8206. Scheduled AI
8217. Scheduled spawners/environment, including ground-item expiry in simulating chunks
8228. Produce cross-worker messages
8239. Produce client replication deltas
82410. Queue unload/persistence work
825
826## 13.2 Different system frequencies
827
828Not every ECS system should run every tick. Ground movement commits only
829on the global movement cadence (section 13.4). AI decisions, target
830searches and spawner checks can run at lower frequencies. Sleeping chunks
831are not “slow ticked”; they are omitted from normal simulation.
832
833## 13.3 Timestamp-based inactive progression
834
835Long-lived timers such as growth, cooldowns, ground-item expiry and shop
836price lerps should store future timestamps where possible. When an area
837wakes, the system catches up from the timestamp instead of executing missed
838ticks. An expired ground item is discarded on catch-up without ever
839reappearing. Shop and tooltip prices are evaluated from last-sale timestamps
840when observed; they are not ticked. Durations such as shop lerp and
841ground-item despawn come from `WorldSettings`, not from hardcoded
842literals in systems.
843
844## 13.4 Global movement cadence
845
846All ground-moving entities share one walk speed and one run speed.
847
848- Default walk: **2 tiles per second** (`walkTilesPerSecond`).
849- Run: always **double** walk (default 4 tiles per second).
850- Movement ticks fire at `runTilesPerSecond` (default 4 Hz).
851- **Walk:** the entity may advance one path tile on every other movement
852 tick.
853- **Run:** the entity may advance one path tile on every movement tick.
854
855Mobs do not define their own move speed. `Movement.gait` is `walk` or
856`run`. Players send `SetGait`. AI may set gait; it still uses the global
857cadence. Flying pigeon transit is not this cadence; it keeps its own
858route clock.
859
860If the path is blocked on a movement tick, the entity stays on its tile
861and retries on a later legal tick. Occupancy, combat range and pickup
862always use the last committed tile.
863
864## 13.5 World calendar time
865
866World time is server time **1:1**, in the same configured IANA zone used
867for midnight restarts, with **1200 years subtracted** from the calendar
868date. A server clock of 24 Aug 2026 21:00 is world 24 Aug 826 21:00.
869Clock-of-day, including night, therefore matches the host's zone.
870
871The gateway includes current world time (or server unix time plus the
872year offset) in the status sent to clients so shading does not depend on
873the player's device clock. Lighting is presentation; combat and movement
874do not wait on the day/night overlay.
875
876# 14. Client gateway and authority
877
878## 14.1 Stable connection ownership
879
880Client WebSocket/TCP connections belong to a gateway rather than
881simulation workers. When the player crosses into a region owned by
882another worker, the socket stays connected to the same gateway; only
883internal routing changes.
884
885## 14.2 Client commands are intentions
886
887A client sends commands such as MoveTo, Interact, Attack, UseItem,
888EquipItem, UnequipItem, SelectSpell, SetGait, DropItem, PickupItem, BankDeposit,
889BankWithdraw, BuyFromShop or SendPigeon. The authenticated **account**
890determines the actor; after character select, commands apply to that
891account's **active character**. The
892client never supplies an authoritative resulting position, health
893value or inventory result.
894
895## 14.3 Input queue
896
897Socket handlers validate message shape and enqueue commands. Simulation
898workers consume commands at tick boundaries. WebSocket callbacks do not
899mutate ECS state directly.
900
901## 14.4 Authentication
902
903Live login uses **auth.timfalken.com**. The game server never stores a
904password. It receives an authenticated account identity (and email) from
905that service and maps it to a durable `accountId` in `state.sqlite`.
906
907Until auth.timfalken.com is available, the gateway uses a **stub identity**:
908each new connection is `admin-<n>`, where `n` is the number of currently
909connected clients **including this one** (the first connection is
910`admin-1`). Stub accounts are treated as admins so the world editor can be
911used during development. Stub accounts have no email; deletion “emails”
912are logged instead of sent.
913
914When real auth ships, the stub is removed. Admin rights come from that
915service, not from the `admin-` name prefix.
916
917An account may have only **one active play session** at a time (one
918character in the world).
919
920## 14.5 Characters
921
922An account has unlimited characters and plays **one** at a time. First
923login with no characters must create one before entering the world. Later
924logins show a character-selection menu: create, choose, mark for deletion,
925or cancel deletion.
926
927Initial character setup (may change later):
928
929```text
930CreateCharacter
931- firstName // not globally unique
932- lastName // unique surname, owned by this account
933- sex // male | female
934```
935
936Rules:
937
938- **Last names** are globally unique. The first character to take a surname
939 claims it for that **account**. The same player may reuse that last name
940 on their other characters. Another account cannot use it.
941- **First names** need not be unique globally.
942- For a given account, `firstName` + `lastName` must be unique among
943 characters that still exist (including those pending deletion).
944- Uniqueness is case-insensitive; display uses the casing the player typed.
945
946```text
947Account
948- accountId
949- authSubject // from auth.timfalken.com, or stub admin-<n>
950- email? // from auth; absent on stub
951- surnameClaims[]
952
953Character
954- characterId
955- accountId
956- firstName
957- lastName
958- sex
959- deletionScheduledAt? // null if not deleting
960- inventory, equipment, currency, vault, skills, ...
961```
962
963The in-world ECS player entity is a **character**, not the account.
964
965## 14.6 Character deletion and inheritance
966
967From character select, the player may mark a character for deletion.
968
969- The character cannot be played while deletion is pending.
970- Permanent delete happens after `characterDeletionDelay` (default **24
971 hours**). Until then the player may cancel.
972- The server **always** notifies the account email when deletion is
973 marked (and should notify again on cancel and on actual delete). Stub
974 auth logs the message instead.
975- On permanent delete, the name pair is freed. If this account has no
976 remaining characters with that last name, the surname claim is released.
977- Before the vault is moved, `BankService` voids outstanding filled
978 cheques **issued by** this character (reservations return to the vault).
979- All items in inventory, equipment, carried currency, and the character
980 vault are moved to that **account's inheritance bank tab**.
981
982Any living character of the same account may, at a bank, **claim**
983inheritance stacks (and currency) into that character's own vault. Claiming
984is a move from the account tab to the character vault, not a second copy.
985
986# 15. Client chunk subscription and replication
987
988## 15.1 3×3 visibility
989
990A player receives the current chunk and the eight surrounding chunks, a
991maximum viewport of 48×48 tiles. Neighbouring **closed** chunks are still
992sent so scenery remains visible; the player simply cannot walk onto them.
993
994┌───┬───┬───┐
995│ V │ V │ V │
996├───┼───┼───┤
997│ V │ P │ V │
998├───┼───┼───┤
999│ V │ V │ V │
1000└───┴───┴───┘
1001
1002## 15.2 Incremental subscription changes
1003
1004Crossing one chunk east subscribes only the three newly visible eastern
1005chunks and unsubscribes only the three old western chunks. The rest of
1006the 3×3 view remains subscribed.
1007
1008## 15.3 Snapshots and deltas
1009
1010Initial subscription sends a CHUNK_SNAPSHOT containing authored/runtime
1011tile state, currently visible entities and unexpired ground item stacks.
1012Afterwards, revisioned CHUNK_DELTA messages report tile changes, entity
1013spawn/move/change/despawn events and ground-item appear/change/despawn
1014events. Full chunks are not retransmitted every tick.
1015
1016Entity `move` events carry the new integer tile and the current gait so
1017the client can lerp over the walk or run interval. They do not carry a
1018fractional in-between position. Smooth walking is a client visual lerp
1019(section 21.5), not part of the replication payload.
1020
1021Chunk snapshots include the baked light map (section 8.6).
1022
1023Visible equipment is replicated as a compact appearance payload (body
1024sprite plus worn overlay layers and recolour parameters), not as the
1025entity's full inventory. Nearby clients can draw another player's armour
1026without receiving their bags.
1027
1028## 15.4 Visibility can span workers
1029
1030The gateway can source visible chunks from multiple workers. A player
1031may be authoritative on Worker A while one or more of the eight
1032neighbouring visible chunks are owned by Worker B. Client visibility
1033must never force simulation-region reassignment.
1034
1035# 16. Click-to-move and A\* pathfinding
1036
1037## 16.1 Command flow
1038
1039Client: MOVE_TO(tileX, tileY)
1040↓
1041Gateway validates/authenticates
1042↓
1043Owning worker validates target
1044↓
1045A\* calculates authoritative route
1046↓
1047Path component attached/updated
1048↓
1049MovementSystem advances the entity **one tile at a time** on the global
1050walk/run cadence (section 13.4)
1051
1052Authoritative `Position` is always an integer `tileX`, `tileY`. The server
1053does not store a sub-tile location for walking mobiles. When a movement
1054tick allows this gait to step, `MovementSystem` commits the next path
1055tile in a single jump. Combat, occupancy, pickup and interaction all use
1056that committed tile.
1057
1058Flying pigeons still ignore the ground navigation grid, but their
1059replicated ECS position is likewise a tile. The transit clock determines
1060which tile they occupy at a given time; the client may lerp the sprite
1061between those tiles like any other mobile.
1062
1063## 16.2 Initial A\* implementation
1064
1065For normal player clicks within the visible 3×3 chunks, the search space
1066is at most 48×48 = 2,304 tiles, so conventional A\* is a strong starting
1067point.
1068
1069- Binary heap priority queue for the open set.
1070
1071- Manhattan heuristic for four-direction movement; octile heuristic if
1072 diagonal movement is later allowed.
1073
1074- Reusable typed-array or pooled search buffers for hot paths to reduce
1075 allocation and garbage collection.
1076
1077- Rate-limit path requests per player and avoid recalculation every
1078 tick.
1079
1080- Use block passability, **open-chunk** bounds, and dynamic occupancy;
1081 ground is visual only. Tiles in closed or never-edited chunks are not
1082 legal path targets for players.
1083
1084## 16.3 Navigation revisions
1085
1086Each chunk maintains a navigation revision that increments when a
1087movement-affecting block changes. A path records the relevant revisions.
1088Static geometry changes can invalidate paths; temporary mobile occupancy
1089normally causes a short wait or small local re-path rather than
1090rebuilding every path.
1091
1092## 16.4 Long-distance extension
1093
1094If long-distance autonomous travel is added later, introduce
1095hierarchical pathfinding: region graph → chunk portals/edges → local
1096tile A\*. The client movement command interface does not need to change.
1097Server movement remains discrete tile steps; only the path length changes.
1098
1099# 17. Automatic update and restart scheduler
1100
1101## 17.1 Restart triggers
1102
1103A graceful restart is scheduled for the next midnight in configured
1104server-local time when either of these conditions occurs:
1105
1106- A new commit is detected on origin/master. The master branch is the
1107 live branch.
1108
1109- An administrator saves a world-editor change, creating/updating a
1110 pending authored world revision.
1111
1112Multiple triggers coalesce into one scheduled restart. The scheduler
1113stores all reasons so players and admins can see why a restart is
1114pending.
1115
1116## 17.2 Detecting live-code changes
1117
1118The running server periodically performs a non-destructive remote check,
1119for example git fetch origin master followed by comparison of the
1120running commit with origin/master. It does not update the checked-out
1121code while the game is live.
1122
1123## 17.3 Server-local midnight
1124
1125Midnight is calculated in a configured IANA time zone rather than by
1126adding 24 hours to the current time. This keeps behaviour correct across
1127daylight-saving transitions.
1128
1129## 17.4 Player-visible restart state
1130
1131Restart status is part of the server status sent to clients. Connected
1132players see that a restart is scheduled and the scheduled local time.
1133The server can also issue configurable countdown notices as the restart
1134approaches and includes the state immediately when a player logs in.
1135
1136RestartStatus {
1137scheduled: true,
1138scheduledAt: timestamp,
1139reasons: \["code-update", "world-update"\]
1140}
1141
1142## 17.5 Manual admin restart
1143
1144An authorised admin action can invoke the same graceful restart pipeline
1145immediately. This is not a separate “hard restart” path; it differs only
1146in scheduled time.
1147
1148## 17.6 Graceful restart sequence
1149
1150> **1.** Enter `DRAINING` / `RESTARTING` state and reject new logins.
1151>
1152> **2.** Broadcast the final restart notice.
1153>
1154> **3.** Disconnect player sessions cleanly and persist session state.
1155> Shutdown handling overrides normal offline-script retention so chunk
1156> unload cannot be blocked by a retiring process.
1157>
1158> **4.** Stop accepting new gameplay commands and finish the current
1159> safe tick boundary.
1160>
1161> **5.** Force-unload every resident region/chunk, ignoring normal
1162> `ChunkLoader` references. This invokes the ordinary chunk/entity unload
1163> persistence path exactly once.
1164>
1165> **6.** Flush the persistence service and close SQLite connections
1166> cleanly.
1167>
1168> **7.** Atomically write a restart request manifest. It records the
1169> restart reasons, whether a code deployment is requested, the target Git
1170> commit if known, and the pending world revision if one exists.
1171>
1172> **8.** Exit the Node.js game process cleanly. At this point the game
1173> process has no responsibility for updating or relaunching itself.
1174
1175## 17.7 systemd process supervisor
1176
1177The production Node.js process is owned by a `systemd` service. `systemd`
1178therefore already knows when the process has **fully exited**; no separate
1179polling process is needed. Only after the previous `ExecStart` process is
1180gone does `systemd` begin the next service start.
1181
1182The preferred lifecycle is:
1183
1184```text
1185Running Node.js server
1186 |
1187 | graceful planned restart or crash
1188 v
1189Node.js process fully exits
1190 |
1191 v
1192systemd starts the service again
1193 |
1194 +--> conditional update hook
1195 | |
1196 | +--> planned code deployment: git fetch/pull --ff-only
1197 | +--> world-only restart: no Git mutation
1198 | +--> crash/no restart manifest: no Git mutation
1199 |
1200 +--> optional dependency/build step if deployment changed code
1201 |
1202 v
1203Start Node.js server
1204 |
1205 v
1206Startup selects the new active world revision
1207 |
1208 v
1209Gateway opens when the world reports READY
1210```
1211
1212### 17.7.1 Why Git pull must be conditional
1213
1214A naive `ExecStartPre=git pull` on **every** restart is unsafe. Suppose a
1215new commit is detected at 14:00 and correctly scheduled for midnight, but
1216the game process crashes at 16:00. An unconditional pull would deploy the
1217new commit immediately during crash recovery, bypassing the scheduled
1218maintenance window.
1219
1220Therefore the restart manifest distinguishes an intentional deployment
1221restart from an ordinary process failure:
1222
1223```json
1224{
1225 "reason": ["code-update", "world-update"],
1226 "deployCode": true,
1227 "targetCommit": "<optional commit hash>",
1228 "pendingWorldRevision": 184
1229}
1230```
1231
1232The manifest should be written using a temporary file plus atomic rename
1233so the supervisor never consumes a half-written request. The supervisor
1234consumes/removes the request only after it has successfully interpreted
1235it.
1236
1237If the Node.js process dies without a valid deployment request, `systemd`
1238restarts the **currently checked-out version**. This gives fast crash
1239recovery without prematurely deploying pending code.
1240
1241### 17.7.2 Suggested systemd shape
1242
1243A production unit can conceptually look like this:
1244
1245```ini
1246[Unit]
1247Description=Tile MMO Server
1248After=network-online.target
1249Wants=network-online.target
1250
1251[Service]
1252Type=simple
1253User=tilemmo
1254Group=tilemmo
1255WorkingDirectory=/srv/tile-mmo/current
1256
1257# This hook checks the restart manifest. It pulls/builds only when an
1258# intentional deployment was requested. Prefixing with '+' optionally
1259# allows the hook to run with privileges different from the game user.
1260ExecStartPre=+/usr/local/sbin/tile-mmo-update-if-requested
1261ExecStart=/usr/bin/node /srv/tile-mmo/current/dist/server.js
1262
1263Restart=always
1264RestartSec=5s
1265TimeoutStopSec=120s
1266KillSignal=SIGTERM
1267
1268[Install]
1269WantedBy=multi-user.target
1270```
1271
1272`Restart=always` is appropriate here because an explicit
1273`systemctl stop tile-mmo` does not cause systemd to restart the unit,
1274while a clean in-game restart exit and an unexpected crash both do.
1275
1276The exact paths, build command and privilege split are deployment
1277details, but the important invariant is that the **Node.js process does
1278not pull Git itself**.
1279
1280### 17.7.3 Code-update, world-update and crash behaviour
1281
1282| Situation | Restart manifest | Git pull before restart | World revision |
1283|---|---|---|---|
1284| Scheduled code update | `deployCode=true` | Yes, fast-forward only | Activate pending revision if present |
1285| World-editor-only update | `deployCode=false` | No | Activate pending revision |
1286| Manual deployment restart | Explicit admin intent | As requested | Activate pending revision if present |
1287| Unexpected Node.js crash | Missing/invalid | **No** | Continue current active revision |
1288| `systemctl stop` | Irrelevant | No automatic restart | N/A |
1289
1290This preserves the midnight deployment promise even when the game crashes
1291before the scheduled maintenance window.
1292
1293## 17.8 Failure behaviour
1294
1295Deployment should fail closed. If Git cannot fast-forward, a build or
1296migration fails, or startup validation fails, the game must not open to
1297players on a partially updated state. The update hook should log the
1298failure clearly and return non-zero; systemd may retry according to its
1299restart/start-limit policy. Databases remain intact, and backups or
1300snapshots before schema migrations are recommended.
1301
1302A failed **crash recovery** that did not request deployment must not
1303silently switch to a newer Git commit as a recovery strategy.
1304
1305# 18. Future player scripting architecture
1306
1307## 18.1 Scope
1308
1309The custom scripting language is explicitly a later feature. Version 1
1310only needs architectural hooks so adding scripts does not require
1311replacing the player-control or simulation model.
1312
1313## 18.2 Controller abstraction
1314
1315All player actions should already pass through an internal command
1316interface. Manual client input is therefore one possible controller. A
1317future script is another controller that emits the same validated action
1318intentions.
1319
1320```text
1321ClientController ─┐
1322 ├─> ActionCommand queue ─> authoritative game systems
1323ScriptController ─┘
1324```
1325
1326Scripts never mutate ECS components directly. They request actions such
1327as MoveTo, Interact or Attack and receive the same validation as a human
1328client.
1329
1330## 18.3 Online scripted mode
1331
1332A logged-in player may enable the script while remaining connected and
1333observing the game. Control mode explicitly determines whether manual
1334input or the script is currently producing gameplay commands. The server
1335remains authoritative either way.
1336
1337## 18.4 Logout with active script
1338
1339If a player has configured offline script execution, logout removes the
1340network/controller connection but keeps the player entity alive. The
1341entity changes to an offline script-controlled state and continues
1342acting until it dies or its configured offline duration expires.
1343
1344Player online
1345Player + NetworkIdentity + ChunkLoader + Controller
1346↓ logout with offline scripting
1347Player + ScriptController + ChunkLoader + OfflineUntil
1348↓ death OR expiry
1349persist player state → remove runtime entity
1350
1351## 18.5 Offline scripted players and loading
1352
1353An offline scripted player must continue to stimulate the world it
1354traverses, so it retains a ChunkLoader. This is powerful but potentially
1355expensive: thousands of offline scripts could keep large parts of the
1356world active. Offline duration, script CPU budget and concurrent
1357offline-script limits therefore become explicit resource policy, not
1358implementation accidents.
1359
1360## 18.6 Restart continuity
1361
1362A planned restart persists the offline-script state and expiry time,
1363force-unloads the old process, and rehydrates still-valid offline
1364scripted players during startup. This is why the startup index for
1365persistent ChunkLoaders is part of the base architecture.
1366
1367## 18.7 Scripting language safety requirements
1368
1369When the language is implemented, it should be interpreted/compiled into
1370a purpose-built sandbox rather than evaluated as JavaScript. At minimum
1371it should enforce:
1372
1373- No file-system, operating-system, database or arbitrary network
1374 access.
1375
1376- No eval or escape into Node.js objects.
1377
1378- Per-tick/per-event instruction budgets and bounded memory.
1379
1380- Rate-limited expensive operations such as path requests and world
1381 queries.
1382
1383- Capability-based read APIs for nearby visible/known world state.
1384
1385- Action output only through the normal server command pipeline.
1386
1387- Persistable script variables/state if offline execution must survive
1388 restarts.
1389
1390- Deterministic or tightly controlled timing semantics where practical.
1391
1392An event-driven language is preferable to running every player script
1393continuously at full simulation frequency. Events such as arrival,
1394attack, nearby entity changes or timer expiration can wake scripts only
1395when useful.
1396
1397# 19. Security and administration
1398
1399- World-editor endpoints require an explicit admin role and separate
1400 server-side authorisation checks.
1401
1402- Client-supplied entity/player IDs are never trusted as authority;
1403 authenticated connection/session context identifies the actor.
1404
1405- World-editor data is validated against known ground, block, item and mob
1406 definitions before database write.
1407
1408- Admin restart and deployment controls use the same authenticated
1409 administration layer.
1410
1411- The Node.js game process should run as a dedicated unprivileged user.
1412 Where practical, source-update permission belongs only to the systemd
1413 update hook (for example a privileged `ExecStartPre` helper), leaving
1414 the running Node.js process unable to modify its own checkout.
1415
1416- SQLite writes are parameterised and centralised through
1417 persistence/editor services.
1418
1419- Inventory, vault, cheque and courier mutations are server-authoritative.
1420 Clients cannot invent cheque IDs, forge cargo, or credit a vault.
1421
1422- Attack hit/miss and damage are server-authoritative. Clients cannot supply
1423 a roll or a damage result. Shop purchase prices are computed at buy time
1424 on the server.
1425
1426# 20. Recommended process topology
1427
1428```text
1429Clients
1430 |
1431 v
1432WebSocket/API Gateway
1433 |
1434 +-- Region Coordinator ----> Simulation Worker A
1435 | <--> Simulation Worker B
1436 |
1437 +-- Communication Service --> proximity speech
1438 |
1439 +-- CourierService ---------> pigeon cargo / transit
1440 |
1441 +-- BankService ------------> shared vaults / cheques / reservations
1442 |
1443 +-- MarketService ----------> order book / escrow / trades / last-sale index
1444 |
1445 +-- Persistence Service ----> state.sqlite
1446 |
1447 +-- Admin / World Editor ---> world.sqlite
1448
1449External process supervision:
1450systemd ---> conditional deployment hook ---> Node.js relaunch
1451```
1452
1453# 21. Player client architecture
1454
1455## 21.1 FrameworkV3 as a git submodule
1456
1457The player-facing client is built on the shared FrameworkV3 library:
1458
1459<https://gitlab.com/Timfa/frameworkv3>
1460
1461FrameworkV3 contains generic reusable client-side code. Game-specific rendering,
1462UI, input, assets and protocol handling live in this repository, on top of
1463that library. They are not patched into FrameworkV3 unless they are genuinely
1464reusable across games.
1465
1466This repository vendors FrameworkV3 as a **git submodule** rather than
1467copying its source or depending on an unpublished global install.
1468
1469```text
1470mmo/
1471 client/
1472 frameworkv3/ # git submodule → gitlab.com/Timfa/frameworkv3
1473 src/ # this game's client: protocol, UI, world view, assets
1474 server/ # Node.js ECS backend; does not import FrameworkV3
1475```
1476
1477The submodule path is `client/frameworkv3`. A clone of this repo is not
1478client-buildable until submodules are present:
1479
1480```text
1481git clone --recurse-submodules <this-repo>
1482# or, in an existing checkout:
1483git submodule update --init --recursive
1484```
1485
1486The submodule records a **pinned commit**. Bumping FrameworkV3 is an explicit
1487commit in this repository (new submodule SHA). Game code must not rely on an
1488uncommitted dirty checkout of the submodule.
1489
1490Build order:
1491
1492```text
14931. Build FrameworkV3 from client/frameworkv3
14942. Build this game's client against that output
14953. The Node.js server is a separate build and does not link FrameworkV3
1496```
1497
1498The exact FrameworkV3 build command follows that project's own instructions.
1499This game's client build must consume the framework's public/build artefacts,
1500not fork its internals.
1501
1502CI and developer machines check out submodules before the client job. A
1503missing or uninitialized submodule is a failed client build, not a fallback
1504to a system copy of FrameworkV3.
1505
1506If this repo's `master` also ships the built web/desktop client from the
1507same process that deploys the game server, a submodule bump is just another
1508commit and follows the normal midnight restart/deploy path. The running
1509Node.js game process still does not compile or import FrameworkV3.
1510
1511The backend remains the authoritative Node.js ECS simulation described in this
1512document. The client does **not** need to use ECS. It receives only a small
15133×3-chunk view plus player/UI state, so a conventional object/view-model model is
1514simpler and entirely appropriate.
1515
1516## 21.2 Server/client model separation
1517
1518Backend ECS components are not treated as a shared client object model. Network
1519messages form the contract between the two sides.
1520
1521```text
1522Authoritative Node.js ECS
1523 |
1524 | snapshots / deltas / UI state
1525 v
1526Network protocol DTOs
1527 |
1528 v
1529Built FrameworkV3 (from client/frameworkv3 submodule)
1530 |
1531 v
1532This game's client code (client/src)
1533```
1534
1535The two projects may share protocol schemas, enums or generated message types,
1536but the client must not depend on the internal layout of ECS component storage.
1537That allows server internals to be optimised without forcing corresponding
1538client rewrites.
1539
1540## 21.3 Sprite size, pivot and Y-sort
1541
1542World sprites may be any pixel size. The gameplay tile remains 16×16.
1543Each sprite is placed with an automatic pivot: **horizontally centred**,
1544and **8 pixels up from the bottom** of the sprite. That pivot sits on the
1545tile centre, so a 16×16 sprite still fills the tile and a taller sprite
1546stands on the same feet line and extends upward.
1547
1548Blocks and mobiles with oversized sprites are **Y-sorted**: sprites
1549higher on the screen draw behind sprites lower on the screen, using the
1550pivot's world Y (the occupied tile, or the interpolated foot position
1551while walking). Ground tiles and the night overlay stay behind and in
1552front of that pass respectively.
1553
1554Nearest-neighbour sampling still applies so pixels stay sharp under
1555viewport zoom. Zoom scales the whole view uniformly; it is not a
1556per-sprite size override.
1557
1558## 21.4 Viewport, camera and zoom
1559
1560In normal play the viewport is **always centered on the local player's
1561character**. The camera does not free-pan. Scrolling the world happens
1562only because the player moved.
1563
1564The player may zoom in and out within configured minimum and maximum
1565bounds (for example 1× to 4×; the exact numbers are a game setting). Zoom
1566does not move the camera off the player and does not change server
1567visibility: the client still receives only the 3×3 chunk window.
1568
1569The admin world editor is the exception: it frames the selected 16×16
1570chunk and navigates by chunk, as in section 8.1.
1571
1572## 21.5 Client movement interpolation
1573
1574The server jumps mobiles from tile to tile. The client draws a visual
1575lerp between the previous replicated tile and the new one over the
1576interval implied by gait and `WorldSettings` (walk: `1 / walkTilesPerSecond`,
1577run: half of that). If a delta arrives late, clamp the remaining lerp.
1578That lerp is presentation only:
1579
1580- Hit tests, range, pickup and occupancy use the authoritative tile.
1581- A corrected server position snaps the interpolation target; the client
1582 does not accumulate drift.
1583- Interpolation does not entitle the client to send fractional positions.
1584
1585## 21.6 Equipment layers and recolouring
1586
1587A mob (including a player character) is drawn as a **stack of sprites**
1588on the same tile: the body sprite (male or female from character
1589sex, or the mob archetype body), then each piece of visible equipment.
1590Overlays are not baked into the body art.
1591
1592```text
1593draw order (back → front, default)
1594 1. body / mob base
1595 2. boots
1596 3. legs
1597 4. chest
1598 5. head
1599 6. off-hand
1600 7. weapon
1601```
1602
1603Slot draw order is data so a cloak or a two-handed sprite can be inserted
1604without a renderer rewrite. Overlay sprites use the same automatic pivot
1605as other world art (horizontal centre, 8 pixels from the bottom).
1606
1607Equipment items stay in dedicated **equipment slots**, not in the 32
1608inventory slots, while worn. `EquipItem(slotIndex)` moves a legal item
1609from inventory into the matching equipment slot, returning any previously
1610worn item to inventory if there is space. `UnequipItem(equipSlot)` does
1611the reverse. The weapon equipment slot is what combat uses; it replaces
1612the older “wielded flag on an inventory slot” idea.
1613
1614Non-player mobs may carry an `Equipment` component or a simpler appearance
1615list on the mob definition so a guard can show armour without a player
1616inventory.
1617
1618```text
1619Equipment
1620- slots: { head?, chest?, legs?, boots?, weapon?, offhand?, ... }
1621
1622ItemDefinition.equipment?
1623- slot
1624- overlaySpriteId
1625- recolourableChannels?: ["metal"] // omitted if the art is not recoloured
1626- materialId? // e.g. iron, steel; used with "metal"
1627```
1628
1629Inventory icons and worn overlays may be different 16×16 files. Both are
1630world sprites and both go through the size check.
1631
1632### Recolourable equipment
1633
1634Some gear shares one overlay and is tinted per material. Metal armour is
1635the initial case: iron, steel and later metals are not separate full-size
1636art sets.
1637
1638```text
1639MaterialDefinition
1640- materialId // iron, steel, ...
1641- displayName
1642- channel // metal for armour; later channels may include cloth
1643- colour // destination RGB for that channel
1644```
1645
1646A recolourable overlay is authored as:
1647
1648- the 16×16 overlay sprite, with shading in the channel regions, and
1649- an optional 16×16 **channel mask** of the same dimensions, whose pixels
1650 name which recolour channel they belong to (for example a reserved mask
1651 colour meaning `metal`). Unmasked pixels are drawn unchanged.
1652
1653At draw time, masked pixels keep the overlay’s relative brightness
1654(highlights and shadows) and replace the hue/saturation with the
1655item’s `MaterialDefinition.colour`. The client must not invent a colour;
1656the server sends the material id (or the already-resolved colour) on the
1657appearance layer.
1658
1659Iron plate and steel plate therefore share `overlaySpriteId = platebody`
1660and differ only by `materialId`. Non-metal unique art omits
1661`recolourableChannels` and is blitted as authored.
1662
1663Recolour happens on the client as a presentation step. It does not change
1664item identity, combat stats or inventory. Nearby observers receive enough
1665appearance data to apply the same layers and tints.
1666
1667## 21.7 World time and night shading
1668
1669The client treats **world time** as server time minus 1200 years (section
167013.5). It uses that clock-of-day to shade the 3×3 view.
1671
1672At night, tiles that the baked light map says are unreachable from any
1673static light are drawn darker. Tiles a light can reach stay brighter.
1674Light does not bleed through walls: the mask was raycast through passable
1675tiles at editor save, including across chunk borders, so a torch on the
1676edge of one chunk can light tiles in the next.
1677
1678By day, ambient light is full and the baked mask does not darken the
1679ground. The day/night curve (how dark “night” is, dusk length) can stay a
1680world setting or a later tuning value; the invariant is that night uses
1681baked reachability, not a per-frame raycast.
1682
1683The world-editor night-to-day slider is the same shading function, driven
1684by the slider instead of the clock, so an admin can preview a chunk at
1685any light level without changing live world time.
1686
1687# 22. Items, inventory and ground drops
1688
1689## 22.1 Item definitions
1690
1691Every obtainable object is an `ItemDefinition`. Stacking, uniqueness and
1692later economy rules are data on that definition, not special cases in UI
1693code.
1694
1695```text
1696ItemDefinition
1697- itemId
1698- displayName
1699- description
1700- seedValue // base price before player-market adaptation
1701- stackable
1702- maxStackSize // default 99 for stackable items
1703- uniqueInstance // true for letters, filled cheques, and similar
1704- category: ingredient | intermediate | finished | document | other
1705- npcShopAllowed
1706- gatherSources
1707- craftingRecipe(s)
1708- dropTableSources
1709- attack?: AttackProfile // weapons; omitted for non-weapons
1710- equipment?: // worn/wielded visuals; see 21.6
1711 slot
1712 overlaySpriteId
1713 recolourableChannels?
1714 materialId?
1715```
1716
1717A stackable item with no instance data merges with an identical `itemId` in
1718the same container up to `maxStackSize`. Unique-instance items never merge;
1719each occupies its own slot at quantity 1.
1720
1721**Currency is not an inventory item.** Carried money is a numeric `Currency`
1722balance on the player. Banked money is a numeric balance on that player's
1723vault. Coins do not occupy inventory slots and cannot be dropped on the
1724ground in this model.
1725
1726How most items are obtained is specified later. Two source families already
1727fit this model without changing it:
1728
1729- Ground-item spawners in the world editor, analogous to mob spawners.
1730- Later harvesting from the environment by players.
1731
1732Paper, blank cheques and letters are specified now because communication,
1733banking and pigeons depend on them.
1734
1735## 22.2 Player inventory
1736
1737A player inventory has exactly **32 slots**.
1738
1739```text
1740Inventory
1741- slots[32]: empty | ItemStack
1742
1743ItemStack
1744- itemId
1745- quantity // 1 for unique-instance items
1746- instance?: ItemInstance // present only when uniqueInstance is true
1747- origin?: ItemOrigin // crafter or shop NPC; see 22.6
1748```
1749
1750Rules:
1751
1752- A stack occupies exactly one slot, regardless of quantity.
1753- Inserting a stackable item first tries to merge into an existing compatible
1754 stack whose combined quantity would not exceed `maxStackSize`. Stacks are
1755 compatible only when `itemId` matches and `origin` matches (including both
1756 being empty). Any remainder needs an empty slot, or the whole action fails.
1757- Moving, swapping and splitting stacks are ordinary server-validated
1758 commands. The client never asserts the resulting inventory.
1759- Inventory, wallet and vault contents are **player-private UI state**. They
1760 are not part of 3×3 chunk replication. Other clients see ground items and
1761 pigeon entities, not another player's bags or a pigeon's cargo.
1762- Logout and restart persist the full inventory and carried currency in
1763 `state.sqlite`.
1764
1765## 22.3 Paper and letters
1766
1767Blank paper is a stackable item.
1768
1769Writing consumes one paper and produces a **letter**: a unique-instance item
1770whose instance data is text written by a player. A letter is not a mail
1771record and has no inherent recipient. It is just paper with writing on it.
1772
1773```text
1774LetterInstance
1775- letterId
1776- authorPlayerId
1777- body
1778- writtenAt
1779```
1780
1781If the paper stack's quantity is 1, the slot may be converted in place into
1782the letter. If quantity is greater than 1, writing requires a free inventory
1783slot for the new letter and decrements the paper stack.
1784
1785Reading a letter inspects its instance data. Sending a letter is the same
1786pigeon-cargo action used for any other item stack.
1787
1788Maximum letter length is a defined game rule and can be chosen during
1789implementation.
1790
1791## 22.4 Dropping items
1792
1793A player may drop an item stack, or part of a stack, onto their current tile.
1794
1795```text
1796GroundItem
1797- groundItemId
1798- tileX / tileY
1799- ItemStack
1800- droppedAt
1801- expiresAt // droppedAt + WorldSettings.groundItemDespawnDuration
1802- source // player-drop | later: item-spawner
1803- droppedByPlayerId?
1804```
1805
1806Rules:
1807
1808- Player-dropped items remain for `WorldSettings.groundItemDespawnDuration`
1809 (default **10 minutes**), then vanish forever.
1810- Anyone may pick up a ground item. There is no owner lock and no loot-rights
1811 delay.
1812- Ground items **do not block movement** and do not prevent a player from
1813 standing on that tile.
1814- Pickup requires the player to **stand on that tile**. The command names the
1815 `groundItemId` when several stacks share the tile.
1816- Pickup fails if the player's inventory cannot accept the stack (no legal
1817 merge and no empty slot). The ground item is unchanged.
1818- Several distinct stacks may occupy one tile at once.
1819- Later naturally spawned ground items use the same non-blocking
1820 representation, but their lifetime and respawn belong to the item spawner
1821 rather than this 10-minute player-drop timer.
1822
1823Dropped items are not `ChunkLoader`s and do not keep a chunk simulated.
1824
1825They **do** survive chunk unload until `expiresAt`, using timestamp expiry
1826rather than a per-tick countdown. On unload, unexpired ground items are
1827written to `state.sqlite`. On load or wake, items whose `expiresAt` is in
1828the past are discarded and never replicated. Simulating chunks also remove
1829them when the timestamp elapses.
1830
1831If a unique-instance item that encodes a bank reservation (a filled cheque)
1832expires on the ground or is otherwise destroyed without being redeemed, that
1833reservation is released and the reserved goods become available in the
1834issuer's vault again.
1835
1836## 22.5 Pickup and drop commands
1837
1838```text
1839DROP_ITEM(slotIndex, quantity?)
1840PICKUP_ITEM(groundItemId)
1841```
1842
1843Both are intentions. The owning worker validates the actor's tile, inventory
1844space and stack rules, then applies the result. Standing on a tile that has
1845ground items does not pick them up automatically.
1846
1847## 22.6 Item inspection, origin and displayed value
1848
1849Hovering an item — in inventory, a shop stock list, or on the ground — shows
1850at least:
1851
1852```text
1853ItemTooltip
1854- displayName
1855- description
1856- originLabel // who crafted it, or the shop NPC if bought there
1857- currentValue // undiscounted adapted value; see section 27
1858```
1859
1860Origin is stored on the stack:
1861
1862```text
1863ItemOrigin
1864- kind: crafted | shop | unknown
1865- playerId? // when crafted by a player
1866- npcId? // when bought from a shop NPC
1867```
1868
1869The origin label is the crafting player's name, or the shop NPC's name when
1870the stack was bought from that NPC. Harvested, looted or otherwise unstamped
1871stacks use `unknown` and omit the origin line until later content says
1872otherwise. Buying from a shop stamps that NPC as origin. Crafting stamps the
1873crafter. Shop-bought goods are not treated as crafted by the NPC; the NPC
1874name simply occupies that inspection field.
1875
1876`currentValue` uses the same last-sale lerp as shopkeepers (section 27.6) but
1877**without** the per-shop discount. It is informational. The client must not
1878recompute it every simulation tick. The player UI may refresh displayed
1879values at most once per minute, from the last-sale record plus `seedValue`.
1880The actual shop purchase price is always computed server-side at the moment
1881of purchase.
1882
1883# 23. Player communication and carrier pigeons
1884
1885## 23.1 Proximity chat is the default
1886
1887Ordinary chat is spatial. A player speaks from a world position and only nearby
1888players receive a useful version of the message. Legibility decreases as the
1889recipient gets farther from the speaker.
1890
1891For example:
1892
1893```text
1894Near: I'm really far away
1895Farther: I'm re...y far aw.y
1896Very far: I'...re..ly..ar.aw.y
1897Beyond range: no message
1898```
1899
1900The exact distance bands/function are configurable game rules.
1901
1902Crucially, degradation is performed **server-side**. The server must not send the
1903full plaintext to a distant client and merely ask that client to obscure it,
1904because a modified client could then recover speech it was not supposed to
1905understand.
1906
1907A chat message therefore conceptually contains:
1908
1909```text
1910ChatSpeech
1911- messageId
1912- speakerEntityId
1913- originX / originY
1914- createdAt
1915- text
1916```
1917
1918The communication service performs a spatial recipient query and derives the
1919recipient-specific legible representation before routing it through the gateway.
1920Chat routing is separate from normal 3×3 chunk replication, so the eventual
1921hearing/text range does not have to equal the visual chunk-subscription radius.
1922
1923## 23.2 Persistent player groups
1924
1925Players can create permanent groups and invite other players into them. Groups
1926are durable social entities stored in `state.sqlite`, with membership surviving
1927logout and server restart.
1928
1929A minimal model contains:
1930
1931```text
1932PlayerGroup
1933- groupId
1934- name
1935- owner / roles
1936- createdAt
1937
1938PlayerGroupMember
1939- groupId
1940- playerId
1941- role
1942- joinedAt
1943```
1944
1945Invite, accept, leave, kick and role-management operations are authoritative
1946server actions.
1947
1948Group membership does **not** create magical long-distance communication. If
1949members are close enough, they can communicate through the normal proximity
1950rules. Communication to distant group members means sending items — including
1951letters — by carrier pigeon, the same mechanism available to any player.
1952
1953If group-wide letter sending is later supported, it is an addressing
1954convenience that still consumes one paper/letter item and one pigeon dispatch
1955per recipient. The group is not a global instant chat channel.
1956
1957## 23.3 Pigeons carry cargo, not messages
1958
1959A carrier pigeon is a free physical courier. It does not send a chat packet.
1960It carries **either**:
1961
1962- an amount of the sender's carried currency, or
1963- exactly one item stack (a letter, a filled cheque, blank paper, or any
1964 other stack)
1965
1966One pigeon cannot carry both money and an item, and cannot carry two item
1967stacks. Dispatching a pigeon is **free**, so a player who wants to move
1968several stacks sends several pigeons one after another.
1969
1970Cargo is removed from the sender immediately and placed into durable transit.
1971A crash or restart cannot duplicate that cargo or silently erase it.
1972
1973Pigeons are not inventory items. Any player may dispatch one from anywhere,
1974provided they have valid cargo.
1975
1976```text
1977SendPigeon
1978- destination: Player(playerId) | Bank
1979- cargo: Money(amount) | Item(slotIndex, quantity?)
1980```
1981
1982## 23.4 Destinations
1983
1984**Player destination.** The pigeon flies toward the named player. On arrival:
1985
1986- Money is added to the recipient's carried `Currency` if they are online;
1987 otherwise it is deposited into the recipient's bank.
1988- An item stack is placed in the recipient's inventory if they are online and
1989 have space (a legal merge or an empty slot). If they are offline or cannot
1990 accept the stack, the pigeon continues to the **nearest bank** and deposits
1991 the stack into the recipient's vault.
1992
1993This keeps offline and full-inventory delivery durable without a separate
1994mailbox object.
1995
1996**Bank destination.** The pigeon flies to the **nearest bank** to the dispatch
1997tile. Travel time is that aerial journey, even though every bank shares the
1998same vault. On arrival the cargo is deposited into the **sender's** vault,
1999except for the filled-cheque special case in section 24.7.
2000
2001"Nearest bank" is computed from authored Bank block positions in the pinned
2002world revision. If additional banks are added later, a pigeon sent to `Bank`
2003still lands at whichever bank is closest to where it was dispatched; the
2004goods then appear in the shared vault.
2005
2006## 23.5 Carrier pigeon transit
2007
2008A carrier pigeon must take time to cross the world; long-distance item and
2009currency delivery is intentionally not instantaneous.
2010
2011At MMO scale, however, every delivery should not keep an entire trail of regions
2012fully stimulated merely so a pigeon can advance. The recommended model is a
2013persistent courier transit record with world position/route/progress that can
2014advance through dormant space using coarse path segments and timestamps.
2015
2016```text
2017CourierTransit
2018- courierId
2019- cargo // Money(amount) | ItemStack
2020- senderPlayerId
2021- destination // Player(playerId) | Bank
2022- currentPosition
2023- route
2024- speed / timing state
2025- status
2026```
2027
2028A carrier pigeon is part of the shared physical world, not a private visual
2029belonging only to its sender or recipient. Whenever its calculated route passes
2030through a **simulating chunk**, the courier should materialise there as a normal
2031ECS `Mob` entity, regardless of whether the sender or recipient is nearby. Any
2032client whose normal 3x3 chunk subscription includes that pigeon receives it like
2033any other visible mobile entity and can therefore see unrelated pigeons flying
2034past in the distance.
2035
2036The visible pigeon does **not** receive `ChunkLoader`. It exists because the chunk
2037is already simulating for some other reason. If it leaves the last relevant
2038simulating chunk, its exact position/progress is folded back into the durable
2039`CourierTransit` record and the ECS instance can disappear while the journey
2040continues abstractly. If a dormant/unloaded part of its route later becomes
2041simulated while the pigeon should currently be inside it, the owning worker
2042materialises the pigeon at the position implied by the transit clock and route.
2043
2044```text
2045Dormant route Simulating chunk Dormant route
2046
2047abstract transit --------> ECS pigeon visible to clients --------> abstract transit
2048 | | |
2049 Player A Player B unrelated observer
2050```
2051
2052This means a player standing halfway between sender and recipient can see the
2053pigeon fly through their area even though the cargo has nothing to do with
2054them. Unrelated clients receive the pigeon entity, not the cargo contents. It
2055preserves the sense that deliveries physically cross the world without
2056requiring thousands of deliveries to become thousands of permanent
2057`ChunkLoader`s.
2058
2059Because pigeons fly rather than use the ground navigation grid, their coarse
2060route can initially be represented by direct or waypoint-based aerial segments.
2061This makes deterministic materialisation from route + elapsed time considerably
2062simpler than it would be for a ground-based courier.
2063
2064If future gameplay allows pigeons to be intercepted, killed or rerouted anywhere
2065along their journey, the transit model can be made progressively more detailed;
2066that interaction is not required by the initial courier design.
2067
2068## 23.6 Courier service
2069
2070A dedicated `CourierService` should own durable cargo and delivery state.
2071Simulation workers may own visible pigeon entities while the service owns the
2072durable fact that a delivery exists.
2073
2074```text
2075Player action -> CourierService -> durable cargo/transit
2076 |
2077 +-> visible pigeon when needed
2078 |
2079 +-> inventory, wallet or BankService deposit
2080```
2081
2082This separation is also useful for marketplace settlement, which uses the same
2083carrier-pigeon delivery infrastructure for remote counterparties.
2084
2085# 24. Bank, cheques and shared vaults
2086
2087## 24.1 Bank location and access
2088
2089A bank exists at or near the central marketplace as an authored Bank block.
2090Deposit, withdraw, cheque issue and in-person cheque redemption require
2091server-validated access to a bank interaction; the bank is not a global menu
2092usable from anywhere.
2093
2094Pigeon dispatch to `Bank` is the exception: that command may be issued from
2095anywhere, and the goods become available only after the pigeon arrives.
2096
2097## 24.2 One shared vault
2098
2099Each **character** has a single vault in `state.sqlite`:
2100
2101```text
2102CharacterVault
2103- characterId
2104- bankedCurrency
2105- stacks[]
2106- reservations[]
2107```
2108
2109Capacity is unlimited: there is no slot cap. Per-stack stacking rules still
2110apply (`maxStackSize`; unique instances never merge), so 200 blank paper is
2111stored as 99 + 99 + 2 rather than one unbounded pile.
2112
2113If more banks are authored later, **all banks are linked**. Withdrawing at
2114bank B can retrieve goods deposited at bank A. The vault is not per-branch.
2115
2116Pigeon deposits affect *when* goods become available, not *which* vault they
2117enter. After the pigeon arrives at the nearest bank, the goods appear in the
2118same shared vault accessible from every bank.
2119
2120## 24.3 Deposit and withdraw
2121
2122While interacting with a bank, a player may:
2123
2124- Deposit any carried currency and any inventory stacks, in whole or in part.
2125- Withdraw currency into the carried wallet.
2126- Withdraw an item stack, or part of a stack, into inventory, subject to the
2127 32-slot and merge rules.
2128- Claim items or currency from the account **inheritance tab** into this
2129 character's vault (section 24.9).
2130
2131Goods reserved by an outstanding filled cheque cannot be withdrawn by the
2132issuer until that cheque is redeemed or voided.
2133
2134## 24.4 Blank cheques
2135
2136A player at a bank may request blank cheques.
2137
2138- Blank cheques are a stackable item with `maxStackSize` 99.
2139- The bank counts blank cheques already in the player's **inventory** (not
2140 the vault) and issues only enough to bring that total to 99.
2141- If the player already holds 99, the bank issues none.
2142- Issued cheques go into inventory, merging into an existing blank-cheque
2143 stack when possible. If the player holds none and has no empty slot, the
2144 request fails.
2145
2146The bank will not issue more than 99 blank cheques into inventory, even on
2147repeated requests.
2148
2149## 24.5 Filling a cheque
2150
2151Using a blank cheque at a bank lets the issuer pick vault goods and a
2152**quantity**. For stackable items they choose an `itemId` and quantity; the
2153quantity may be larger than one `maxStackSize`, and the reservation covers
2154that many available (unreserved) items of that type in the vault. For
2155unique-instance items they choose that exact instance and the quantity is 1.
2156
2157```text
2158FilledChequeInstance
2159- chequeId
2160- issuerPlayerId
2161- itemId
2162- quantity
2163- instance?: ItemInstance // set when the reserved goods are unique
2164- createdAt
2165```
2166
2167Filling:
2168
21691. Validates that the vault has at least `quantity` of that item available
2170 (not already reserved). Unique instances must still be present and unreserved.
21712. Reserves those goods in the issuer's vault. Reserved goods cannot be
2172 withdrawn, sold or reserved again.
21733. Consumes one blank cheque. If that was the last cheque in the slot, the
2174 slot becomes the filled cheque in place; otherwise a free slot is required
2175 for the filled cheque.
2176
2177A filled cheque is a unique-instance **bearer** item. It does not stack.
2178Whoever holds it may redeem it. Cheques specify vault items and a quantity,
2179not carried currency. Money is moved with a pigeon, or by depositing and
2180withdrawing at a bank.
2181
2182## 24.6 Redeeming a cheque in person
2183
2184The bearer interacts with any bank and redeems the filled cheque.
2185
2186- The server moves the reserved goods from the **issuer's** vault into the
2187 **bearer's inventory**, subject to inventory space. A quantity larger than
2188 `maxStackSize` becomes as many stacks as needed.
2189- The cheque item is consumed.
2190- If inventory cannot accept the resulting stacks, redemption fails and both
2191 cheque and reservation remain unchanged.
2192
2193The bearer may then deposit those goods into their own vault if they wish.
2194
2195## 24.7 Redeeming a cheque by pigeon
2196
2197If the bearer dispatches a pigeon whose cargo is a filled cheque and whose
2198destination is `Bank`:
2199
2200- The pigeon flies to the nearest bank from the dispatch tile.
2201- On arrival, `BankService` transfers the reserved goods from the **issuer's**
2202 vault into the **pigeon's sender's** vault.
2203- The cheque is consumed in transit; it is not deposited as an item.
2204
2205The receiver of the transfer is whoever sent that pigeon, not the original
2206cheque issuer. This is how a cheque moves goods from one vault to another
2207without the receiver standing at a bank.
2208
2209Sending a filled cheque to a **player** delivers the cheque item itself (or
2210into that player's bank if they cannot hold it). It does not redeem it.
2211
2212## 24.8 Bank service
2213
2214Vault mutation, cheque issue, reservation, in-person redemption and
2215pigeon-arrival deposits are owned by a single authoritative `BankService`
2216(or an equivalently serialised service) so two concurrent withdrawals,
2217cheque fills or pigeon arrivals cannot double-spend the same goods.
2218
2219```text
2220Bank interaction or pigeon arrival
2221 |
2222 v
2223BankService
2224 - shared vault
2225 - reservations
2226 - cheque issue / redeem
2227 |
2228 +-> inventory / currency on the acting player when in person
2229 |
2230 +-> vault credit on pigeon arrival
2231```
2232
2233Cheque identifiers are server-issued. A client cannot forge a claim against
2234another player's vault.
2235
2236## 24.9 Inheritance bank tab
2237
2238Each **account** has one inheritance tab, separate from every character
2239vault:
2240
2241```text
2242AccountInheritance
2243- accountId
2244- currency
2245- stacks[]
2246```
2247
2248It is written only when a character of that account is permanently deleted
2249(section 14.6). Any of that player's living characters can move stacks and
2250currency from this tab into their own vault at a bank. They cannot deposit
2251into inheritance except through character deletion.
2252
2253# 25. Central marketplace and order matching
2254
2255## 25.1 Marketplace location
2256
2257A central marketplace exists at or near the centre of the game world. Creating,
2258modifying or cancelling market orders requires server-validated access to the
2259marketplace interaction; the marketplace is not intended to be a global menu
2260that can be used from anywhere.
2261
2262Orders themselves remain durable after the player leaves the marketplace or
2263logs out.
2264
2265## 25.2 No public list of sell orders
2266
2267The market is an order book, but players do not browse a list of individual
2268items currently offered for sale.
2269
2270A seller submits:
2271
2272```text
2273SellOrder
2274- item / item definition
2275- quantity
2276- minimum unit/total price
2277```
2278
2279A buyer submits:
2280
2281```text
2282BuyOrder
2283- requested item / matching criteria
2284- quantity
2285- maximum unit/total price
2286```
2287
2288The UI may know which item types exist and may eventually show historical data,
2289but it does not expose the live asks in a way that lets a buyer simply pick a
2290listed seller.
2291
2292## 25.3 Escrow
2293
2294Market orders escrow the asset required to honour them. Escrow is taken from
2295carried inventory and carried currency. The marketplace sits next to the bank,
2296so a player can withdraw from the vault immediately before placing an order.
2297
2298- Creating a sell order removes/reserves the offered item stack from the
2299 seller's inventory.
2300- Creating a buy order removes/reserves the buyer's maximum offered currency.
2301- Cancelling an unmatched order returns the escrowed asset through the defined
2302 settlement/delivery rules.
2303
2304This prevents double spending, selling the same item twice, or a buyer spending
2305currency after placing a bid.
2306
2307## 25.4 Matching rules
2308
2309A buy and sell order match when:
2310
2311```text
2312buyerMaximum >= sellerMinimum
2313```
2314
2315Sell orders are considered cheapest first. Within the same minimum price, a
2316stable creation sequence/FIFO rule should be used unless later game rules choose
2317otherwise.
2318
2319For a symmetric order book, buy orders are naturally prioritised by highest
2320maximum bid and then oldest sequence. This means a newly submitted sell order
2321matches the best compatible existing bid, while a newly submitted buy order
2322matches the cheapest compatible existing ask.
2323
2324The trade price is exactly the midpoint between the two limits:
2325
2326```text
2327tradePrice = midpoint(buyerMaximum, sellerMinimum)
2328```
2329
2330Example:
2331
2332```text
2333Seller minimum: 80
2334Buyer maximum: 100
2335Trade price: 90
2336```
2337
2338The exact rounding rule when integer currency produces a half-unit midpoint is a
2339defined-but-still-open game rule and must be deterministic.
2340
2341## 25.5 Immediate side versus pigeon side
2342
2343The order that is submitted last is the order that triggers the match.
2344
2345The player who submitted that matching order receives the acquired asset
2346immediately because they are currently present at the marketplace interaction
2347(item stack into inventory, or currency into the carried wallet). The
2348pre-existing counterparty receives their acquired item or currency through a
2349carrier pigeon whose destination is `Bank`, landing at the nearest bank to the
2350marketplace. On arrival the settlement is deposited into that counterparty's
2351shared vault. This remains valid if they are offline.
2352
2353```text
2354Existing sell + new matching buy
2355-> new buyer receives item immediately
2356-> existing seller receives payment by pigeon to bank
2357
2358Existing buy + new matching sell
2359-> new seller receives payment immediately
2360-> existing buyer receives item by pigeon to bank
2361```
2362
2363If a trade requires more than one item stack (for example a quantity that does
2364not fit in a single `maxStackSize`), the older counterparty receives as many
2365free sequential pigeons as needed. Each pigeon still carries only one stack or
2366only currency.
2367
2368Any unused part of buy-order currency escrow caused by the midpoint price is
2369returned immediately to the triggering player when they are the buyer, and
2370returned by the settlement pigeon into the older counterparty's vault when
2371they were the buyer.
2372
2373## 25.6 Market service and atomicity
2374
2375Marketplace matching should not live inside an arbitrary region worker. Use a
2376single authoritative `MarketService` (or an equivalently serialised partitioned
2377service later) so two simultaneous orders cannot both consume the same escrow.
2378
2379Order insertion, matching, escrow movement and creation of the resulting
2380settlement deliveries are committed atomically in `state.sqlite`.
2381
2382Conceptually:
2383
2384```text
2385Marketplace interaction
2386 |
2387 v
2388MarketService
2389 - durable order book
2390 - escrow
2391 - deterministic matching
2392 - trade record
2393 |
2394 +-> immediate settlement to triggering player's inventory or wallet
2395 |
2396 +-> CourierService pigeon to Bank for the older counterparty
2397 |
2398 +-> last-sale index update for that itemId
2399```
2400
2401The system should also retain an immutable trade record for auditing and recovery.
2402
2403## 25.7 Last player-market sale per item
2404
2405Each successful player-market match updates a single durable record for that
2406`itemId`. There is no price history series — only the latest sale:
2407
2408```text
2409ItemLastMarketSale
2410- itemId
2411- lastTradePrice // unit price of that match (the midpoint)
2412- lastTradeAt
2413- priceFrom // evaluated undiscounted value at lastTradeAt
2414```
2415
2416`priceFrom` is not a history log. It is the lerp origin captured at the
2417moment of this sale so the displayed price does not jump back to seed when
2418a new trade occurs:
2419
24201. Evaluate the current undiscounted value at `now` using the previous
2421 last-sale record (or `seedValue` if none exists).
24222. Store that value as `priceFrom`, store the new trade's unit price as
2423 `lastTradePrice`, and store `now` as `lastTradeAt`.
2424
2425Shopkeepers and item tooltips both read this record. They do not tick it;
2426they evaluate it from timestamps when a shop is opened, a purchase is
2427attempted, or a tooltip refresh is requested.
2428
2429# 26. Combat
2430
2431## 26.1 Every combatant can attack
2432
2433Players, enemies, animals and any other mobile with a `Combat` component can
2434attack. Shopkeepers and other non-fighting NPCs simply omit `Combat`, or
2435never issue attack commands.
2436
2437Attacking is an intention. The client (or AI, or a future script) sends
2438`ATTACK(targetEntityId)`. The owning worker validates range, line-of-use,
2439the current attack profile and cooldown, then resolves hit and damage
2440authoritatively. The client never supplies a hit result or a damage number.
2441
2442Cross-worker attacks already use `REMOTE_ACTION(attack intent)`: the worker
2443that owns the target applies the authoritative result.
2444
2445## 26.2 Attack profiles
2446
2447The current attack comes from the wielder's selected profile: a wielded
2448weapon's `AttackProfile`, a selected spell, or a default unarmed melee
2449profile when nothing is wielded.
2450
2451```text
2452AttackProfile
2453- attackId
2454- mode: melee | ranged | magic
2455- rangeTiles // melee is always 1; ranged/magic from the item or spell
2456- hitSkillId
2457- damageSkillId
2458```
2459
2460```text
2461SpellDefinition
2462- spellId
2463- displayName
2464- AttackProfile // mode = magic, hitSkillId = Magic, damageSkillId = Mind
2465- other costs/effects // later content
2466```
2467
2468Typical weapon mappings:
2469
2470```text
2471Sword -> melee, range 1, hit Swordfighting, damage Strength
2472Axe -> melee, range 1, hit Axefighting, damage Strength
2473Bow -> ranged, range from item, hit Archery, damage Dexterity
2474Spell -> magic, range from spell, hit Magic, damage Mind
2475Unarmed -> melee, range 1, hit Unarmed, damage Strength
2476```
2477
2478The exact weapon and spell catalogue is content. The pairing rule is not:
2479melee weapons use a weapon skill plus **Strength**, ranged weapons use a
2480weapon skill plus **Dexterity**, and spells use **Magic** plus **Mind**.
2481
2482`EquipItem(slotIndex)` moves a legal item from inventory into the matching
2483equipment slot (section 21.6). The **weapon** slot supplies the current
2484`AttackProfile`. `SelectSpell(spellId)` selects a spell the actor is
2485allowed to use. The selected profile determines range and both skills.
2486
2487## 26.3 Melee range
2488
2489A melee attack is legal only when the attacker stands on **one of the eight
2490tiles surrounding** the target's tile: orthogonal or diagonal, Chebyshev
2491distance exactly 1. The attacker cannot melee from the target's own tile.
2492
2493```text
2494. . .
2495. T . attacker must occupy one of the eight `.` tiles
2496. . .
2497```
2498
2499This adjacency rule is independent of whether ordinary walking is four- or
2500eight-directional.
2501
2502## 26.4 Ranged attacks and spells
2503
2504Ranged weapons and spells may fire from further away. Maximum Chebyshev
2505distance is `rangeTiles` on that item or spell. Distance 0 (same tile) is
2506not a legal ranged/spell attack unless a later exception is defined.
2507
2508The attacker must still occupy a simulating chunk and satisfy any later
2509line-of-sight rule. Exact obstruction rules are an open content decision;
2510range itself is not.
2511
2512## 26.5 Hit roll
2513
2514Whether the attack lands is a server-side roll driven by the **hit skill**
2515of the current profile (Swordfighting, Axefighting, Archery, Magic, Unarmed,
2516and so on). The client does not roll.
2517
2518The exact hit curve, any defender contribution from Defence, and the RNG
2519are later tuning. The invariant is that the hit chance is a function of the
2520attacker's hit-skill level, not of Strength, Dexterity or Mind.
2521
2522A miss deals no damage.
2523
2524## 26.6 Damage
2525
2526On a hit, damage is determined by the **damage skill**:
2527
2528- Melee → Strength
2529- Ranged → Dexterity
2530- Magic → Mind
2531
2532Weapon or spell base damage and the defender's mitigation (including whether
2533Defence reduces damage) are later tuning. The governing damage skill is not.
2534
2535## 26.7 Experience split
2536
2537When a **player** successfully hits, the attack's XP award is split equally
2538between the hit skill and the damage skill:
2539
2540```text
2541totalXp = attack xp formula for this successful hit
2542hitSkill += totalXp / 2
2543damageSkill += totalXp / 2
2544```
2545
2546Example: a sword hit awards half its XP to Swordfighting and half to
2547Strength. A bow hit splits Archery and Dexterity. A spell hit splits Magic
2548and Mind.
2549
2550If an unusual profile ever named the same skill twice, XP is awarded once,
2551not doubled. Misses award no combat XP. Ordinary mobs do not earn XP; their
2552`Skills` component is filled from the mob archetype and stays at those
2553levels.
2554
2555Non-combat actions remain single-skill as in section 27.4.
2556
2557## 26.8 Mob combat stats
2558
2559```text
2560MobDefinition
2561- ...
2562- skillLevels: { skillId → level }
2563- defaultAttack: attackId | unarmed
2564```
2565
2566A wolf might have Unarmed and Strength. An archer guard might have Archery
2567and Dexterity. Those levels feed the same hit and damage resolution as
2568players.
2569
2570# 27. Player-driven economy and skill progression
2571
2572## 27.1 Item-source philosophy
2573
2574The economy is intentionally player-driven.
2575
2576Normal NPC shops should sell only basic ingredients. The vast majority of
2577materials are gathered directly from the world by players. Finished goods are
2578normally produced by player crafting/professions.
2579
2580The only normal non-player source of finished items is enemy or boss loot.
2581
2582This gives four broad source paths, with ground-item spawners as an additional
2583early world source once content defines them:
2584
2585```text
2586World gathering / harvesting -> ingredients
2587Ground-item spawners --------> some world items, later specified
2588Basic NPC shops -------------> limited basic ingredients
2589Player production -----------> intermediate/final products
2590Enemies and bosses ----------> loot, including possible finished items
2591```
2592
2593Stacking, unique instances, letters and cheques are defined in section 22.
2594Economy-facing fields remain on the same `ItemDefinition`:
2595
2596```text
2597ItemDefinition
2598- itemId
2599- displayName / description / seedValue
2600- stackable / maxStackSize / uniqueInstance
2601- category: ingredient | intermediate | finished | document | other
2602- npcShopAllowed
2603- gatherSources
2604- craftingRecipe(s)
2605- dropTableSources
2606- attack?: AttackProfile
2607- equipment?: slot / overlaySpriteId / recolourableChannels / materialId
2608```
2609
2610Content validation can then reject an ordinary shop inventory that accidentally
2611contains a finished product unless explicitly permitted by a future exception.
2612
2613## 27.2 No player classes
2614
2615Players do not choose a class. Capabilities and progression come from independent
2616skills.
2617
2618Examples include:
2619
2620- Swordfighting, Axefighting, Archery, Magic, Unarmed
2621- Strength, Dexterity, Mind
2622- Defence
2623- Lumbering
2624- Fishing
2625- Smithing
2626
2627The final skill list is game content and is not limited to skills found in any
2628particular inspiration game.
2629
2630## 27.3 Skill state
2631
2632Skill progression is persistent player state.
2633
2634```text
2635SkillProgress
2636- skillId
2637- xp
2638```
2639
2640Level should preferably be derived from XP and the skill's level curve rather
2641than stored as an independent source of truth, although it may be cached.
2642
2643```text
2644SkillDefinition
2645- skillId
2646- displayName
2647- levelCurve
2648- maxLevel (if any)
2649```
2650
2651## 27.4 Actions are governed by skills
2652
2653Every gameplay action that participates in progression is associated with a
2654governing skill. Combat attacks are the explicit exception: they have a hit
2655skill and a damage skill, and split XP equally between them (section 26.7).
2656
2657```text
2658ActionDefinition
2659- actionId
2660- governingSkillId
2661- requiredLevel
2662- xpAward / xpFormula
2663- other requirements
2664```
2665
2666Examples:
2667
2668```text
2669Cut tree -> Lumbering
2670Catch fish -> Fishing
2671Forge sword -> Smithing
2672Sword hit -> Swordfighting + Strength (equal split)
2673Bow hit -> Archery + Dexterity (equal split)
2674Spell hit -> Magic + Mind (equal split)
2675Defensive act -> Defence
2676```
2677
2678The server validates the action, performs the authoritative outcome, and then
2679awards XP according to the action result. A client cannot claim XP independently.
2680
2681## 27.5 Skills replace class restrictions
2682
2683Equipment, recipes, actions, gathering nodes and other content may require skill
2684levels, but there is no permanent class gate. A player can train any combination
2685of skills over time.
2686
2687This also fits the future scripting model: scripts issue normal actions, and
2688successful scripted actions use exactly the same skill checks and XP rules as
2689manual player actions.
2690
2691## 27.6 NPC shops and market-adapted prices
2692
2693Named shop NPCs can sell items to players. They are not the player marketplace
2694and they do not expose live sell orders. A shop interaction requires being at
2695that NPC.
2696
2697Stock remains constrained by `npcShopAllowed` and the ingredient-only rule in
269827.1. Each shop NPC has a hidden discount that players never see:
2699
2700```text
2701ShopNpc
2702- npcId
2703- hiddenDiscount // multiplier, e.g. 0.9; not shown to clients
2704- stock[] // itemIds this NPC sells
2705```
2706
2707Until an `itemId` has a player-market last-sale record, the undiscounted
2708value is `seedValue` from the item definition.
2709
2710When a last-sale record exists, both tooltips and shops evaluate a timestamp
2711lerp that does not require a per-tick update:
2712
2713```text
2714t = min(1, (now - lastTradeAt) / WorldSettings.shopPriceLerpDuration)
2715undiscounted = lerp(priceFrom, lastTradePrice, t)
2716shopPrice = undiscounted * thatNpc.hiddenDiscount
2717```
2718
2719`lerp(a, b, t) = a + (b - a) * t`. After the configured lerp duration
2720(default one hour), `t` is capped at 100% and the value rests on the last
2721player-market unit price (times discount, for shops) until another
2722player-market sale occurs.
2723
2724A new player-market sale captures the then-current `undiscounted` value as
2725`priceFrom` (section 25.7), so the lerp restarts toward the new last price
2726without jumping back to seed.
2727
2728Integer currency must be rounded deterministically at evaluation time. Shop
2729purchase price is computed on the server at the instant of `BuyFromShop`.
2730Displayed tooltip value is the undiscounted figure and may be refreshed at
2731most once per minute (section 22.6).
2732
2733Buying from a shop removes the listed price from the player's carried
2734currency, puts the stack in inventory subject to the 32-slot rules, and
2735stamps `ItemOrigin.kind = shop` with that NPC. Shops in this model sell to
2736players; they do not buy player goods unless a later iteration adds that.
2737
2738# 28. Suggested implementation phases
2739
2740## Phase 1 — Single-worker playable core
2741
2742- World coordinate helpers, 16×16 chunks and 4×4-chunk regions.
2743
2744- Ground/block tile model and chunk spatial occupancy.
2745
2746- Basic ECS and fixed simulation tick.
2747
2748- ChunkLoader reference counting and sleeping/unloading.
2749
2750- Single simulation worker behind the same worker interface planned for
2751 later scaling.
2752
2753- world.sqlite read path and state.sqlite persistence service.
2754
2755- Admin world editor: chunk navigation, open/closed flag, default grass for
2756 unsaved chunks, ground/block paint, light-emitting blocks, baked
2757 cross-chunk light maps, night-to-day preview slider, world settings modal,
2758 per-chunk changelog, save to pending revision.
2759
2760- SpawnerSystem for at least one non-persistent mob archetype.
2761
2762- WebSocket gateway, stub `admin-<n>` auth until auth.timfalken.com,
2763 character create/select/delete, authoritative command queue and 3×3 chunk
2764 replication.
2765
2766- Click-to-move with server-side A\*, global walk/run cadence (default 2
2767 tiles/s walk, run every movement tick, walk every other), and `SetGait`.
2768
2769- FrameworkV3 git submodule at `client/frameworkv3`, built first, then a
2770 game-specific client on top of it with 16×16 sprites, load-time and CI
2771 rejection of wrong-sized art (including equipment overlays and recolour
2772 masks), layered worn equipment with material recolouring, a
2773 player-centered viewport with bounded zoom, client-only lerp of
2774 tile-to-tile movement, and night shading from baked light maps.
2775
2776- 32-slot player inventory, stack merging, drop/pickup, and 10-minute
2777 non-blocking ground items.
2778
2779- Paper items that can be written into unique letter items.
2780
2781- Basic proximity chat with server-side distance degradation.
2782
2783- Persistent player skill state, including Strength, Dexterity and Mind, and
2784 at least a small initial set of skill-governed actions.
2785
2786- Melee and ranged/spell attack validation (8-tile melee adjacency, item/spell
2787 range), server-side hit rolls, damage from the matching damage skill, and
2788 equal XP split on a successful player hit.
2789
2790- Graceful forced-unload shutdown.
2791
2792## Phase 2 — Operations and live deployment
2793
2794- RestartScheduler and player-visible scheduled restart state.
2795
2796- origin/master change detection.
2797
2798- `systemd` service supervision and conditional deployment hook.
2799
2800- World-revision activation on restart.
2801
2802- Admin immediate restart.
2803
2804- Migration, backup and startup readiness checks.
2805
2806## Phase 3 — Multi-worker world
2807
2808- Multiple worker_threads simulation workers.
2809
2810- Region coordinator and dynamic region ownership.
2811
2812- Cross-worker entity transfers.
2813
2814- Border ghosts and remote actions.
2815
2816- Gateway subscriptions spanning multiple workers.
2817
2818- Load metrics and neighbour-aware region balancing.
2819
2820## Phase 4 — World depth, social systems and economy
2821
2822- Persistent named NPCs and other persistent mob archetypes.
2823
2824- Spawner persistent-instance index and duplicate prevention.
2825
2826- Optional durable gameplay chunk overrides, written only on unload.
2827
2828- Hierarchical pathfinding if long-distance autonomous travel needs it.
2829
2830- Persistent player groups and invitations.
2831
2832- Carrier-pigeon cargo transit: free dispatch, money or one item stack,
2833 player or nearest-bank destinations, including offline/full-inventory
2834 fallback to the recipient vault.
2835
2836- Shared unlimited **character** bank near the marketplace, account
2837 inheritance tab on character delete, blank cheques filled to 99, reserved
2838 filled cheques, in-person redemption and pigeon-to-bank cheque transfers.
2839
2840- Central marketplace, escrow, deterministic order matching, pigeon-to-bank
2841 settlement for the older counterparty, and a per-item last-sale record for
2842 shop/tooltip adaptation.
2843
2844- NPC shops that sell `npcShopAllowed` stock at seed value lerped toward the
2845 last player-market price over `shopPriceLerpDuration`, with a hidden per-shop discount.
2846
2847- Item inspection: name, description, origin (crafter or shop NPC) and
2848 undiscounted current value, refreshed at most once per minute.
2849
2850- Player crafting/gathering economy rules and shop-content validation.
2851
2852- Broader skill catalogue, progression curves and skill-gated content.
2853
2854## Phase 5 — Player scripting
2855
2856- Custom language grammar/compiler/interpreter.
2857
2858- ScriptController and event API.
2859
2860- CPU/memory/query quotas and sandboxing.
2861
2862- Online scripted control mode.
2863
2864- Offline retained player entities with expiry and ChunkLoader
2865 behaviour.
2866
2867- Persisted/restart-safe script state.
2868
2869# 29. Core invariants
2870
2871| **Invariant** | **Rule** |
2872|------------------------|--------------------------------------------------------------------------------------------------------|
2873| Server authority | Clients send intent; the server computes and owns outcomes. |
2874| Region ownership | Exactly one simulation worker authoritatively owns a region. |
2875| Entity ownership | Exactly one worker authoritatively owns an entity. |
2876| Remote mutation | Workers never directly mutate remote authoritative state. |
2877| Spatial separation | Region residency, chunk simulation and client visibility remain distinct. |
2878| Persistence separation | Persistent and ChunkLoader are independent entity traits. |
2879| Chunk persistence | Normal dirty chunk state is written on unload, not periodically. |
2880| World authoring | Editor changes create pending authored state; the running server stays pinned to its startup revision. Each chunk save appends an admin-attributed diff changelog. |
2881| Restart path | Planned restart force-unloads the world and reuses the ordinary unload save path. |
2882| Control | Human and future scripted control both emit validated action commands. |
2883| Deployment | The game exits gracefully; systemd relaunches it and only pulls/builds when an intentional deployment manifest requests it. |
2884| Client architecture | FrameworkV3 is a git submodule under `client/frameworkv3`, built before game client code; backend ECS internals do not become the client object model. |
2885| Sprites | World sprites may be any size. Pivot is horizontal centre and 8px from the sprite bottom, on the tile centre. Blocks and mobiles Y-sort north-behind-south. |
2886| Appearance | Visible gear is layered 16×16 overlays on the mob; recolourable channels (such as metal) use material colour without duplicate art sets. Nearby clients receive appearance layers, not another player's inventory. |
2887| Play camera | The play viewport is centered on the local player. Only the admin world editor uses a free chunk camera. |
2888| Movement | All ground mobiles share a global walk/run cadence from world settings; the server commits integer tiles; clients lerp for presentation only. |
2889| World time | World calendar time is server time minus 1200 years. Night darkens tiles the baked light map cannot reach. |
2890| World settings | Tick timers and global constants are authored in the editor modal, pinned to the world revision, and not hot-patched into a live process. |
2891| Baked light | Static light reach is raycast through passable tiles on chunk save, may cross chunks, and is not recomputed every tick. |
2892| Ground items | Player drops last `groundItemDespawnDuration` (default 10 minutes), block nobody, and are picked up only by a player standing on that tile. |
2893| Shop prices | NPC shop prices lerp from the captured pre-sale value toward the last player-market unit price over `shopPriceLerpDuration` (default one hour), times a hidden per-shop discount. |
2894| Proximity speech | Distant clients never receive unobscured plaintext that game rules say they cannot understand. |
2895| Courier cargo | Pigeons carry money or one item stack, never a chat packet; cargo is durable in transit and remains delayed. |
2896| Inventory | A player has 32 slots; a stack occupies one slot; the client never asserts inventory, wallet or vault results. |
2897| Shared bank | Every bank reads the same **character** vault; pigeon deposits become available only after arrival at the nearest bank. |
2898| Closed chunks | Closed or never-edited chunks are visible but not enterable; never-edited terrain is default grass with no blocks. |
2899| Accounts | Login is auth.timfalken.com (or `admin-<n>` stub). Characters belong to an account; one may be in the world at a time. |
2900| Names | Surnames are globally unique per account; first+last is unique per account; names free only after permanent delete. |
2901| Inheritance | Deleted characters dump inventory, equipment, wallet and vault into an account inheritance tab other characters can claim. |
2902| Cheques | Filling a cheque reserves vault goods; the bearer item is the claim; destruction without redemption releases the reservation. |
2903| Marketplace escrow | Every open order is fully backed by escrow and matching/settlement is atomic and deterministic. |
2904| Combat | Melee requires an 8-neighbour tile; ranged/spell range comes from the item or spell; hit uses the weapon skill; damage uses Strength, Dexterity or Mind. |
2905| Progression | Players have no classes; non-combat actions award XP to one governing skill; a successful attack splits XP equally between hit and damage skills. |
2906
2907# 30. Important edge cases to preserve during implementation
2908
2909- A ChunkLoader crossing a region boundary can change
2910 residency/simulation references and worker ownership in the same tick;
2911 ordering must avoid temporary double ownership.
2912
2913- A player at a worker boundary may receive visible chunks from multiple
2914 workers without moving ownership solely for rendering.
2915
2916- A planned restart must ignore normal ChunkLoader retention when
2917 forcing the world to unload.
2918
2919- A world-editor save must never cause newly loaded chunks in the
2920 current process to use the pending revision. It must append a changelog
2921 record naming the admin, timestamp and tile diffs.
2922
2923- Pathfinding and player movement must reject tiles in closed or
2924 never-edited chunks even when those chunks are in the 3×3 view.
2925
2926- Two accounts must not claim the same surname. One account may reuse its
2927 surname; first+last must stay unique on that account until permanent
2928 delete.
2929
2930- Marking a character for deletion must not free the name or move items
2931 until the delay elapses. Cancelling must restore playability.
2932
2933- Character deletion must notify the account email (or log, on stub auth).
2934 Permanent delete must void that character's issued cheques, then move
2935 inventory, equipment, wallet and vault into the account inheritance tab.
2936
2937- Saving a chunk must rebake that chunk's light map and any neighbour
2938 chunks within max light range, using passable-tile raycasts. Light from
2939 a source in chunk A may appear in chunk B.
2940
2941- A mob definition must not carry its own walk/run speed; gait only
2942 selects every-other vs every movement tick on the global cadence.
2943
2944- World-settings saves must not apply to the live process; they wait for
2945 the same pending-revision restart as chunk edits.
2946
2947- Night shading must not light a tile the baked mask marks unreachable,
2948 even if a torch is nearby through a wall.
2949
2950- Oversized block and mob sprites must Y-sort so objects higher on the
2951 screen draw behind objects lower on the screen. Closed-chunk edges
2952 facing an open chunk must show a red border in the client.
2953
2954- Equipping must not leave two items in the same equipment slot. Unequip
2955 into a full inventory must fail and leave the item worn.
2956
2957- Nearby clients must not receive another player's inventory in order to
2958 draw their armour; appearance layers and material ids are sufficient.
2959
2960- A client build without `client/frameworkv3` initialized must fail rather
2961 than silently using some other FrameworkV3 install.
2962
2963- Client interpolation of movement must not be treated as authority. Combat
2964 range and pickup use the server tile, not the lerped draw position.
2965
2966- The play camera must remain centered on the local player. Zoom must not
2967 expand the subscribed chunk set.
2968
2969- A persistent mob spawned by a spawner must not be duplicated merely
2970 because it moved out of the spawner’s loaded area.
2971
2972- A non-persistent mob disappears when its chunk is actually unloaded,
2973 not merely when it becomes dormant.
2974
2975- If a persistent ChunkLoader or offline scripted player exists after
2976 restart, startup must discover it from an index without loading the
2977 entire world.
2978
2979- A pending code update followed by an unrelated Node.js crash must
2980 restart the currently deployed commit rather than deploying early.
2981
2982- Negative coordinates, daylight-saving midnight calculation, duplicate
2983 transfer messages and failed deployment migrations should all have
2984 explicit tests.
2985
2986- Proximity chat degradation must happen before plaintext reaches an unauthorised
2987 distant client; rendering-only obfuscation is not sufficient.
2988
2989- Carrier-pigeon deliveries must survive restarts and recipient logout without
2990 requiring every traversed chunk to remain stimulated.
2991
2992- A pigeon carrying an item to a player whose inventory cannot accept it must
2993 not destroy the cargo; it deposits into that player's vault via the nearest
2994 bank.
2995
2996- Two concurrent bank withdrawals, cheque fills or pigeon-arrival deposits must
2997 not spend the same vault goods twice.
2998
2999- Filling two cheques against the same vault stack must reserve disjoint
3000 quantities or reject the second fill.
3001
3002- A filled cheque that expires on the ground must release its reservation and
3003 must not remain redeemable.
3004
3005- A player-dropped ground item must not block movement, must not keep its chunk
3006 loaded, and must still be present after a chunk unload/reload if `expiresAt`
3007 has not passed.
3008
3009- Pickup of a ground item from a tile the player is not standing on must fail.
3010
3011- Requesting blank cheques must never raise the player's carried blank-cheque
3012 count above 99.
3013
3014- A marketplace match must atomically consume both escrows exactly once, even if
3015 two compatible orders arrive concurrently.
3016
3017- A matching market order from an online player may settle immediately for that
3018 player while the older/offline counterparty's delivery remains durable.
3019
3020- Skill XP is awarded only after authoritative action resolution, never directly
3021 from a client-reported result. A successful player attack splits that XP;
3022 a miss awards none.
3023
3024- A melee attack from the target's own tile, or from Chebyshev distance greater
3025 than 1, must fail. A ranged or spell attack beyond that item or spell's
3026 `rangeTiles` must fail.
3027
3028- A new player-market sale must capture the then-current undiscounted lerp
3029 value as `priceFrom` so shop and tooltip prices do not jump back to seed.
3030
3031- Two shop NPCs may charge different prices for the same item at the same
3032 instant because each applies its own hidden discount to the same lerp.
3033
3034- Item tooltip value must not be recomputed every tick; a one-minute refresh
3035 is sufficient. Purchase price is still evaluated at the moment of buy.
3036
3037# 31. Decisions through version 0.12
3038
3039- Chunk persistence is unload-driven rather than periodic.
3040
3041- The authored tile model has separate visual ground and functional
3042 block layers.
3043
3044- Mobile actors remain ECS entities and are not authored as painted tile
3045 contents.
3046
3047- Spawner blocks are editor-placeable and configurable per instance;
3048 persistence belongs to the spawned mob type.
3049
3050- world.sqlite is an authored, revisioned world source; state.sqlite
3051 holds runtime durable state.
3052
3053- Editor changes are staged for activation on restart instead of
3054 hot-patching the running world.
3055
3056- Code/world changes schedule a player-visible midnight restart; admins
3057 can trigger the same graceful pipeline immediately.
3058
3059- Git pull/build/relaunch belongs to `systemd` supervision after the
3060 game process has safely exited.
3061
3062- Deployment is manifest-driven: crash recovery restarts the currently
3063 checked-out commit, while only an intentional deployment restart may
3064 fast-forward `master`.
3065
3066- Future player scripting is modelled as an alternative controller
3067 producing normal server action commands.
3068
3069- Offline scripted players may remain in-world as ChunkLoaders until
3070 death or expiry and must survive planned restarts through persistence.
3071
3072- The player client is built on FrameworkV3, included as the git submodule
3073 `client/frameworkv3` and built first so this game's client code can layer on
3074 top. The client does not need an ECS and consumes protocol state
3075 independently of backend ECS storage. The Node.js server does not import
3076 FrameworkV3.
3077
3078- World sprites may be any pixel size. Each is placed with a pivot at
3079 horizontal centre and 8 pixels from the sprite bottom, on the tile
3080 centre. Blocks and mobiles are Y-sorted. The player may zoom the whole
3081 viewport within configured bounds; sprites are not scaled individually.
3082
3083- Visible equipment is drawn as extra 16×16 layers on the mob, including
3084 players. Worn items occupy equipment slots, not the 32 inventory slots.
3085 Nearby clients replicate appearance layers only, never another player's
3086 inventory.
3087
3088- Recolourable gear (metal armour) shares one overlay sprite and a 16×16
3089 channel mask. Material definitions supply the metal colour; luminance of
3090 the overlay is preserved. Iron and steel plate are different items with
3091 the same art and different `materialId`.
3092
3093- The play camera is always centered on the local player. The admin world
3094 editor is the only exception, and it frames one chunk at a time.
3095
3096- Authoritative movement is a tile-to-tile jump on a **global** cadence:
3097 default walk 2 tiles/s, run double. Walk steps every other movement tick;
3098 run steps every movement tick. Mobs do not set their own speed. Clients
3099 lerp for visuals only and never send interpolated positions.
3100
3101- Admins edit global tick timers and constants in a world-settings modal.
3102 Those values live in the pending world revision and apply on the next
3103 process start, like other editor saves.
3104
3105- World calendar time is server time minus 1200 years, same IANA zone as
3106 midnight restarts. At night the client darkens tiles the baked light map
3107 cannot reach.
3108
3109- Static light is baked on chunk save by raycast through passable tiles,
3110 including across chunk borders. The editor has a night-to-day slider for
3111 preview only.
3112
3113- Each world-editor chunk save stores who edited it, when, and a bullet
3114 diff of ground changes, block placements, block replacements and block
3115 removals at world tile coordinates.
3116
3117- Default speech is proximity-based and becomes less legible with distance.
3118 Long-distance exchange is physical: a pigeon carries money or one item stack.
3119 A letter is paper with player-written text, not a separate mail record.
3120
3121- Permanent player groups are social/addressing structures and do not create an
3122 instant global chat channel.
3123
3124- Carrier-pigeon transit is persistent but does not automatically keep every
3125 traversed chunk simulated. Whenever a pigeon passes through a chunk that is
3126 already simulating, it materialises as an ECS `Mob` and is visible to any
3127 nearby client whose normal chunk subscription includes it, even if that client
3128 is unrelated to the delivery. Unrelated clients do not receive cargo contents.
3129
3130- A player has a 32-slot inventory. Stackable items occupy one slot. Currency is
3131 a numeric wallet/vault balance, not an inventory item.
3132
3133- Player-dropped items lie on the tile for `groundItemDespawnDuration`
3134 (default 10 minutes), block nobody, and may be picked up by anyone standing
3135 on that tile. They survive unload until expiry via timestamps.
3136
3137- The bank near the marketplace holds an unlimited **character** vault.
3138 Later banks are linked to the same vault. Pigeons may deposit money or one
3139 stack into the sender's vault after arriving at the nearest bank. An
3140 account-level inheritance tab receives a deleted character's goods.
3141
3142- Blank cheques are issued at a bank up to a carried total of 99. Filling a
3143 cheque reserves a vault item quantity. The filled cheque is a bearer item.
3144 In-person redemption withdraws into the bearer's inventory. Sending the cheque
3145 to the bank by pigeon transfers the reserved goods into the pigeon's sender's
3146 vault.
3147
3148- The central marketplace hides individual live sell listings and matches durable
3149 escrowed buy/sell orders at the midpoint of compatible bid/ask limits.
3150 Quantities are item stacks.
3151
3152- The newest matching market participant receives the trade result locally; the
3153 older counterparty receives theirs by pigeon into their bank.
3154
3155- NPC shops remain restricted to `npcShopAllowed` basic ingredients. They sell
3156 to players at
3157 `lerp(priceFrom, lastTradePrice, min(1, (now - lastTradeAt) / shopPriceLerpDuration))`
3158 times a hidden per-shop discount. With no player-market sale yet, the
3159 undiscounted value is `seedValue`. Tooltips use the same lerp without the
3160 discount and refresh at most once per minute.
3161
3162- Hovering an item shows name, description, origin (crafter, or shop NPC name
3163 if bought there) and current undiscounted value.
3164
3165- All combatants can attack. Melee requires standing on one of the eight
3166 neighbouring tiles. Ranged attacks and spells use the item's or spell's
3167 range. The hit roll uses the weapon skill; damage uses Strength (melee),
3168 Dexterity (ranged) or Mind (magic). Successful player-attack XP is split
3169 equally between those two skills.
3170
3171- Player progression is skill-based rather than class-based. Non-combat
3172 actions award XP to one governing skill; combat hits split XP as above.
3173
3174- Never-edited chunks are default grass, no blocks, and **closed**. The
3175 editor opens or closes each chunk. Closed chunks are visible but not
3176 enterable.
3177
3178- Accounts authenticate at auth.timfalken.com. Until that service is up,
3179 each connection is stub `admin-<n>` (n = connected client count including
3180 this one) and is treated as admin.
3181
3182- An account has unlimited characters and plays one at a time. Creation
3183 takes first name (not globally unique), last name (globally unique to the
3184 account, reusable on that account's other characters), and male/female.
3185 first+last must be unique for that account. This setup may change later.
3186
3187- Character deletion is a 24-hour (configurable) delay with email notify
3188 and cancel. Permanent delete frees names and moves inventory, equipment,
3189 wallet and vault to the account inheritance tab, which any of that
3190 player's characters can claim into their own vault.
3191
3192# 32. Open design decisions for later iterations
3193
3194These do not block the initial implementation, but should eventually be
3195specified explicitly:
3196
3197- Whether multiple mobile entities may occupy one tile and, if so, which
3198 categories can overlap.
3199
3200- Whether player movement is four-direction only or also supports
3201 diagonals. Combat melee adjacency already includes diagonals.
3202
3203- Exact hit-chance and damage curves, attack intervals/cooldowns, whether
3204 Defence modifies incoming hit chance or damage, and ranged/spell
3205 line-of-sight or obstruction rules.
3206
3207- Deterministic rounding when shop discount or lerp produces a fractional
3208 currency amount.
3209
3210- Exact equipment slot list, per-slot draw order exceptions (cloaks,
3211 two-handed weapons), and whether worn overlays have facing frames to
3212 match the mob.
3213
3214- Additional recolour channels beyond metal (for example cloth dyes) and
3215 the exact luminance-preserving remap function.
3216
3217- Exact camera zoom minimum, maximum and whether zoom is restricted to
3218 integer steps.
3219
3220- Exact night ambient curve (how dark, dusk length) and whether baked light
3221 stores a boolean reach mask or a distance/falloff value per tile.
3222
3223- Whether opening a door at runtime should rebake or ignore static light.
3224
3225- Exact simulation tick rate stays a world setting; lower-frequency AI and
3226 spawner cadences can still be tuned independently.
3227
3228- Exact world/chunk binary serialisation format and schema/version
3229 migration strategy.
3230
3231- Whether gameplay can permanently modify ground/block tiles in the
3232 initial release.
3233
3234- Spawner timing rules, spawn-point restrictions and behaviour when
3235 persistent spawned mobs travel very far away.
3236
3237- World-editor undo/redo and rollback UI. The per-chunk changelog is an audit
3238 log, not by itself an undo stack.
3239
3240- Exact restart warning intervals and whether admins can
3241 cancel/reschedule a planned restart.
3242
3243- Worker rebalance thresholds and whether regions may migrate while
3244 players are actively crossing their boundaries.
3245
3246- Future scripting language syntax, event model and resource quotas.
3247
3248- Exact proximity-chat distance curve, maximum range and character degradation
3249 algorithm.
3250
3251- Group naming/roles, membership limits and whether group-wide letter sending
3252 is offered as an addressing convenience that still dispatches one pigeon and
3253 consumes one paper/letter per recipient.
3254
3255- Whether pigeons can eventually be intercepted, killed or redirected in transit.
3256
3257- Marketplace partial fills, cancellation rules, fees/taxes (if any),
3258 tie-breaking details and midpoint rounding for indivisible currency.
3259
3260- Whether market price history or aggregate statistics are visible despite live
3261 order listings remaining hidden.
3262
3263- Initial skill catalogue, XP curves, level caps, action XP formulas and the
3264 remaining interpretation of skills such as Defence.
3265
3266- Maximum letter body length and whether writing paper requires a desk or can be
3267 done from inventory anywhere.
3268
3269- Exact item catalogue, which items stack, per-item `maxStackSize` exceptions,
3270 harvest interactions and ground-item spawner parameters.
3271
3272- Whether death drops inventory, and whether dropped unique items other than
3273 cheques have destruction side-effects.
3274
3275- Whether the issuer can void a filled cheque without the bearer item being
3276 destroyed, and whether cheques can ever represent currency rather than items.
3277
3278- Whether a short dispatch interval is needed so many pigeons cannot leave in a
3279 single tick, even though sending remains free.
3280
3281- New-character spawn location (must be an open chunk) and name length /
3282 allowed-character rules.
3283
3284- Later changes to character creation beyond first name, last name and sex.
3285
3286# 33. Architectural summary
3287
3288ECS → what an entity is and what systems can act on it
3289Chunk → tile data, spatial lookup, simulation and client subscription
3290Region → residency and simulation-worker ownership
3291Coordinator→ where regions execute
3292Gateway → stable client connections, auth, character select, and command/update routing
3293world.sqlite→ authored versioned ground/block/spawner/light/settings world; unedited chunks are closed grass
3294state.sqlite→ accounts, characters, vaults, inheritance, and other durable live-game state
3295systemd → process supervision and relaunch
3296Deployment hook → conditional Git update/build only for intentional deployment restarts
3297Controller → manual client input today; sandboxed player scripts later
3298FrameworkV3 → git submodule at `client/frameworkv3`; built first; game client code layers on top
3299Sprites → any size; pivot at horizontal centre, 8px from bottom; Y-sort blocks/mobs
3300Equipment → layered 16×16 overlays on mobs; metal armour shares art and recolours by material
3301Camera → play view centered on the local player; bounded zoom; editor is chunk-framed
3302Movement → global walk/run cadence (default 2 tiles/s walk, run double); server tile steps; client visual lerp
3303World time → server clock minus 1200 years; night darkens unlit tiles
3304Light → baked passable-tile raycast on editor save; shines across chunks
3305World settings → admin modal for tick timers and global constants; pending revision
3306Inventory → 32 slots; stacks occupy one slot; letters are written paper items
3307Bank → per-character vault; account inheritance tab on character delete
3308Auth → auth.timfalken.com, stub admin-<n> until live; unlimited characters, one in world
3309Chunks → editor open/closed; default grass and closed until painted
3310Ground items → non-blocking, 10-minute player drops, pickup only while standing on the tile
3311Communication service → proximity speech
3312CourierService → pigeons carrying money or one item stack through durable transit
3313BankService → shared unlimited vaults, cheque reservations and redemption
3314MarketService → durable escrowed order book, matching, last-sale index and pigeon-to-bank settlement
3315Shop NPCs → sell allowed stock; price lerps toward last player-market sale over shopPriceLerpDuration, times a hidden discount
3316Combat → 8-tile melee, item/spell ranged range; hit skill roll; Strength / Dexterity / Mind damage; equal XP split
3317Skills → classless progression; non-combat XP to one skill; attack XP split hit/damage
3318
3319
3320# 34. Version history
3321
3322## 0.12
3323
3324- Chunks are open or closed in the world editor. Closed chunks stay visible
3325 but cannot be entered. Never-edited chunks are default grass with no
3326 blocks and are closed.
3327- Login uses auth.timfalken.com; until that is live, connections are stub
3328 `admin-<n>` (connected-client count including this one) and are admins.
3329- Accounts have unlimited characters, one in the world at a time. Creation
3330 is first name, unique account-owned last name, and male/female.
3331- Character deletion waits 24 hours with email and cancel. Permanent delete
3332 frees names and moves goods to an account inheritance bank tab.
3333
3334## 0.11
3335
3336- Made walk/run a global cadence from world settings (default 2 tiles/s
3337 walk, run double): walk steps every other movement tick, run every tick.
3338 Mob definitions do not set move speed.
3339- Added an admin world-settings modal for tick timers and global constants
3340 (shop lerp duration, drop lifetime, simulation tick, and the same class
3341 of values). Settings ride the pending world revision.
3342- World calendar time is server time minus 1200 years.
3343- Baked static lighting by passable-tile raycast on chunk save, including
3344 across chunk borders. Clients darken unreachable tiles at night. The
3345 editor has a night-to-day preview slider.
3346
3347## 0.10
3348
3349- Drew visible equipment as 16×16 overlay layers on mobs (including players),
3350 with worn items in equipment slots rather than the 32-slot inventory.
3351- Replicated compact appearance layers to nearby clients instead of another
3352 player's inventory.
3353- Recolourable metal armour shares one overlay plus a 16×16 channel mask;
3354 material definitions supply the metal colour while preserving shading.
3355
3356## 0.9
3357
3358- Vendored FrameworkV3 as the git submodule `client/frameworkv3`. The game
3359 client builds that library first and implements game-specific code on top
3360 of it. The Node.js server does not import the submodule.
3361
3362## 0.8
3363
3364- Required all world sprites (tiles, blocks, mobs, items) to be 16×16 pixels,
3365 rejected at load, with a CI unit test that reports and fails on any other
3366 size. Sprites are not individually scaled; the player may zoom the viewport
3367 within configured bounds.
3368- Locked the play camera to the local player. The admin world editor remains
3369 the only non-player-centered view.
3370- Made authoritative movement integer tile-to-tile steps. Clients lerp
3371 mobiles for presentation only.
3372- Added a per-chunk world-editor changelog: admin, timestamp, and bullet
3373 diffs for ground changes, block place/change/remove.
3374
3375## 0.7
3376
3377- Added combat for all mobs including players: melee from any of the eight
3378 neighbouring tiles, ranged and spells from the item or spell range.
3379- Hit rolls use the weapon skill (Swordfighting, Axefighting, Archery, Magic,
3380 and so on). Damage uses Strength, Dexterity or Mind according to melee,
3381 ranged or magic.
3382- Successful player-attack XP is split equally between the hit skill and the
3383 damage skill. Ordinary mobs use archetype skill levels and do not earn XP.
3384- Shop NPCs sell items at seed value adapted to the last player-market unit
3385 price, lerping over one hour, multiplied by a hidden per-shop discount.
3386- Only the latest player-market sale per item is stored (price, timestamp, and
3387 lerp origin). No historical series.
3388- Item hover shows name, description, origin (crafter or shop NPC) and the
3389 undiscounted current value, refreshed at most once per minute.
3390
3391## 0.6
3392
3393- Added a 32-slot player inventory, stackable items, carried currency as a
3394 numeric wallet, and unique-instance items for letters and filled cheques.
3395- Redefined letters as paper items with player-written text rather than a
3396 separate mail record.
3397- Redefined carrier pigeons as free couriers that carry money or one item
3398 stack to a player or to the nearest bank.
3399- Added a shared unlimited bank near the marketplace, blank cheques filled to
3400 99, vault reservations on fill, in-person redemption and pigeon-to-bank
3401 cheque transfers between vaults.
3402- Added player-dropped ground items: 10-minute lifetime, non-blocking, pickup
3403 only while standing on the tile, timestamp persistence across unload.
3404- Specified later ground-item spawners and harvesting as content that reuses
3405 this item model.
3406- Routed offline/full-inventory pigeon delivery and older-side market
3407 settlement into the recipient's shared bank vault.
3408
3409## 0.5
3410
3411- Made carrier pigeons shared world-visible entities whenever their route crosses an already-simulating chunk.
3412- Unrelated nearby players can see pigeons in their normal 3x3 chunk view; pigeons do not keep chunks loaded themselves.
3413- Added deterministic materialisation/dematerialisation between durable abstract transit and worker-owned ECS pigeon entities.
3414
3415## 0.4
3416
3417- Added FrameworkV3 as the shared player-client foundation while keeping backend ECS internal to the server.
3418- Added server-side proximity chat degradation, persistent player groups and durable carrier-pigeon letters.
3419- Added scalable courier transit that can cross dormant world space without forcing normal chunk simulation.
3420- Added the central marketplace, escrowed hidden order book, midpoint pricing and pigeon-based remote settlement.
3421- Added the player-driven item-source philosophy and restrictions on NPC shop inventories.
3422- Added classless, skill-based player progression and authoritative skill XP.
3423
3424## 0.3
3425
3426- Converted the living design document to Markdown as the canonical format.
3427- Defined `systemd` as the production process supervisor.
3428- Added a conditional, manifest-driven deployment path so crashes do not deploy pending code early.
3429- Added a concrete example systemd service shape and clarified privilege separation.
3430
3431## 0.2
3432
3433- Added unload-driven chunk persistence, authored world revisions, the admin world editor, spawner blocks, graceful scheduled restarts and future player scripting hooks.