protokill plan
1 folder · 25 files

complete
access.md
bots.md
combat.md
contracts.md
declined.md
defs.md
devlog.md
facilities.md
hacking.md
legends.md
lifepath.md
local-play.md
look.md
milestones.md
npcs.md
opt-out.md
order.txt
planning.md
README.md
rig.md
scars.md
services.md
strategic.md
systems.md
tooling.md
README.md

Plan #

What protokill is building, one file per epic. milestones.md is the other view of the same work: the releases, in prose.

An epic is a line of work with an exit criterion somebody could check. Its file says what that part of the game is, why it is in the game and what makes it rewarding, then lists its features under ## Still open, an optional ## Deferred on purpose, and a trailing ## Done of - [x] items linking their pull requests. A feature is a checkbox: done or not. Tasks are pull requests and bugs are issues; neither is listed here.

Rules #

  • The id is the filename and the commit scope. plan/access.md is access, so its commits read feat(access): …. An id never changes; archiving moves the file into complete/ without renaming it. plan is the scope for changes to this register.
  • Status is shipped (the exit criterion is met), open, blocked (waiting on dependsOn), continuous (never finished) or declined (answered no, in declined.md). A shipped epic with nothing open moves to complete/.
  • Order is advisory. The tables follow order.txt, a list of ids; an epic it doesn't name sorts to the end of its table. What really constrains the work is dependsOn.
  • The tables are generated. scripts/gen-plan-readme.py rewrites what sits between the <!-- generated: … --> fences from the epics' frontmatter, and checks ids, statuses and dependencies. The plan-register hook runs it with --check. Everything outside a fence is hand-written.

Adding an epic #

Write plan/<id>.md with the frontmatter every other epic carries (id, title as an outcome, status, dependsOn, exitCriterion), run scripts/gen-plan-readme.py, and stage both. Add a line to order.txt only if where the epic sits is worth saying.

Complete #

id title
mission A mission runs headless and replays the same everywhere
server A hosted mission survives the server being killed
testnet A local testnet stands in for the network
atproto The game speaks atproto natively
mouse The browser plays with the mouse alone

Shipped, with loose ends #

id title

Open #

id title status
lifepath A runner is who their background made them open
rig A runner is proud of a rig they built open
systems Hardware follows honest rules of fit and flow open
planning A heist is planned before it is run open
access A locked door has more than one way through open
npcs The people on a floor can be talked, sneaked or fought past open
combat A floor can be crossed unseen, by gun or by hand open
hacking The net is a second battlefield, bridged to the body open
facilities A facility is built from what it is for, and every lock has a key open
defs New content arrives without a release open
scars Failure leaves marks a runner lives with open
strategic The world moves on real time between missions open
contracts A job is never quite what the brief says open
local-play The game plays without a remote server open
legends The city remembers its biggest names, for a while open
opt-out A player's own record decides whether AIs see them open
services A run node can die without harming the world open

The list reads as the game does: the runner, planning, the heist, its consequences and the world. The last three land by the beta, not before.

Continuous #

id title
bots Anything a player can do, a bot can do and check
look The screen reads at a glance
tooling Every commit is checked for the targets it builds
devlog Every day of development is on record for the launch video

Not pursued #

id title
declined What protokill is not building