Skip to content

Contributors

Start here

  • Architecture - the daemon and thin-client topology, the data-owner rule, and the deliberate non-goals. Read this first; everything else assumes it.
  • Add a feature - the end-to-end recipe every new behavior follows: daemon service function, route row, handler, thin client cmdlet, reference row, test. Walk it once before working independently.

How-to guides

Each guide solves one task with numbered steps and a worked example.

  • Add a feature - the end-to-end recipe: service function, route row, handler, thin cmdlet wrapper, reference row, test.
  • Run and write tests - run the Pester suites against the fixture repo and add a test that follows the mock policy.
  • Set up GitLab pipelines - wire the settle and map-checkup jobs into the lore repository's CI.
  • Deploy the VM daemon - install the systemd unit, configure sync, pick a publish mode, and verify health.
  • Write documentation - the authoring contract for this site: audiences, registers, vocabulary, ownership, and consistency rules. Follow it for any documentation change.

Models

Each model defines the contract for one subsystem: the data it owns, the invariants it maintains, and the guarantees other parts of the system may rely on.

  • The session model - header keys, entity-driven distribution, integrity tiers, and the participation graph.
  • The entity model - index files, merging, machine authorship, and the claim ledger.
  • The roster model - the Gracz/Postać split, durable sections, the Gracze.md seed, and the character file contract.
  • Identity & the capability ACL - identity linking, tokens, capabilities, roles, and governance data.
  • The location model - the location tree, the Mapa registry, normalization, traversal graphs, and map checkup.
  • The PU model - the four tracked fields, the monthly batch process, the timeline, and election eligibility.
  • The economy model - denominations, holdings, Transfer classification, reconciliation, and analytics.
  • The log pipeline - fetching and parsing logs, Discord delivery, and the daemon's internal streams.
  • The settlement model - pending-work derivation, report generation, the CI driver, and merge request write-back.
  • Name resolution - resolver stages, disambiguation, and the name index.
  • Adoption & import - single-pass import, presence branching, idempotency, and legacy recovery.
  • Sync & deployment - in-daemon Git synchronization, scheduler ticks, publish modes, and SyncStale.

Reference

Dry lookup: the closed route table and cmdlet mapping, configuration keys, the closed tag schema, session metadata syntax, data tables, capabilities, code style, and the glossary.