CityRP Documentation Repository

Design Docs

Last updated

Plans and proposals, kept apart from the technical topics because they describe work rather than document behaviour. A design doc argues for a change — what it would touch, in what order, and what it deliberately leaves alone. For how the gamemode actually works today, use the topics list instead.

Open each doc with front matter; the table below is built from it, so a doc that omits a field leaves a hole in the index rather than going unlisted:

---
title: Docs layout migration          # sidebar and index label; falls back to the first heading
status: Proposed                      # Proposed / Accepted / Landed / Implemented / Abandoned
date: 2026-08-22                      # when it was written, not when it landed
description: One line on what it changes.
pinned: true                          # optional; lifts it to the top of this list
---

A body of work large enough to need several docs gets its own folder below, with one of them marked index: true to serve as its landing page.

DocStatusDateDescription
Docs layout migrationLanded2026-08-22Move narrative docs to docs/ and the generator to tools/docs/, and delete the last of the LDoc build tooling.
Class-Based Item RegistrationImplemented2026-08-22Why ITEM:New replaced cityrp.item.register, written retroactively against the code as it exists today.

Sections

DocStatusDateDescription
Car BoostingRotating vehicle-theft contracts through the Boosting Tablet, plus ringing and heat.
PinnedCityRP game conceptAccepted2026-09-18What CityRP is for, who it serves, and the pillars every design decision is tested against.
ClansPlayer-formed groups with a shared identity, a rank ladder, and a shared bank.
Economy
Server sessionsAccepted2026-09-02What counts as a server session, and the decisions phase one of cityrp.session inherits.
Weed