Log inGet started
World

THE CITY REMEMBERS

Branchmain
Branchesmain
Commit5cf6bc7972

README.md

game.core

The shared vocabulary of THE CITY REMEMBERS. Every build slice reads it; no slice writes it.

It answers the questions five agents building at once would otherwise each answer differently: where the districts are, how big a block is, what the clock says, what a reputation score is worth, how much heat is a star, which colours the references were drawn in, and the names of the scene entities each slice attaches its component to.

It holds no behaviour. Rules live here (a pure function from position to district, from score to band, from heat to stars); systems live in the slices.

What is in it

FieldWhat it settles
city9 × 9 grid of 80 m blocks on a 100 m pitch, 20 m streets, origin at block (4, 4), ground 1400 m.
districtsThe six districts in the ledger's own order, each with the grid test that claims a cell and its character, height range, density and police presence.
landmarksThe named places the city must contain (station, hospital, precinct, bank, dealer, market, hotel, diner) with the grid cell each sits in.
clockOne game day is 24 real minutes. Day 1 begins at 07:20, when the player steps off the train.
reputationOne score per district, −100 … +100, labelled in the ledger's six bands: RESPECTED, CAUTIOUS, NEUTRAL, SKEPTICAL, WARY, HOSTILE.
wantedHeat in points, five star thresholds, decay and the cooldown before heat falls.
money, health, xpStarting money 0, health, regen, hospital fee, and the rank ladder from NOBODY upward.
memoryThe fifteen memory kinds with each one's reputation weight, witness radius and ticker pattern, plus the bond thresholds that turn a stranger into an ally or a foe.
palette, uiEvery colour in the references, so five slices produce one city.
idsThe scene's named entities and the six mounts each slice attaches to.
camera, arrivalThe gameplay camera's setting, and where the player arrives.

Functions

local Core = require("game.core")

Core.districtAt(x, z)        -- -> "oldTown"      the district a world position is in
Core.districtName("oldTown") -- -> "Old Town"
Core.cellOf(x, z)            -- -> i, j           the grid cell a position falls in
Core.blockCentre(i, j)       -- -> x, z           world centre of a cell
Core.clockOf(elapsed)        -- -> { day, label, phase, ... }
Core.dayStamp(5)             -- -> "DAY 5"
Core.reputationLabel(70)     -- -> { label = "RESPECTED", colour = "teal" }
Core.wantedStars(140)        -- -> 3
Core.rankName(500)           -- -> "SOMEBODY"
Core.memoryShape()           -- -> the shape one stored memory has

The mounts

A slice attaches its component to its own mount and to no other one. The mounts are entities the scene build places; adding a component to one is an entityOps.addComponents call and does not involve writing the scene file.

mount_city     the city's geometry and atmosphere
mount_life     pedestrians, traffic, the police
mount_memory   the memory ledger and reputation
mount_player   the player, vehicles, the arrival
mount_ui       every screen
mount_world    weather and ambience

The memory contract

game.core defines what a memory is; game.memory (the memory slice) is what stores one. Any slice that wants the city to remember something calls:

require("game.memory").record({
    kind = "helped",
    district = Core.districtAt(x, z),
    subject = npcId,
    subjectName = "the man from the alley",
    text = "Helped a stranger out of a bad alley.",
    x = x, z = z,
})

and the memory slice dates it, weights it, files it, moves that district's reputation, gives it to whoever saw it, and draws it in the ledger.