Getting Started

You need Python 3.9 or later. The scripts use only the standard library. In the examples, grw.py stands for the full path to skills/grindwright/scripts/grw.py. On Windows, run it with python; elsewhere, with python3.

The skill does this setup for you. These are the steps it follows.

Create the state folder

--project is required. Run this in the game's folder:

$ grw.py init --project "Tiny Colony"
{
 "ok": true,
 "state": "ai-docs/grind",
 "next": "fill profile.json and road.json (references/profile.md)"
}

That writes three files:

ai-docs/grind/ledger.jsonl
ai-docs/grind/profile.json
ai-docs/grind/road.json

If someone else owns the repository, or its rules limit what may appear there, keep the state outside it and pass --state <folder> on every command.

Fill in the profile and road

profile.json lists the people, lanes, machines and guards. road.json says what finished means, as weighted milestones. The fields are described in references/profile.md.

The owner confirms the road once. Until confirmed is true, next adds a road_warning and the skill takes only bugs and failing tests.

See which lanes are open

grw.py doctor reports which plugins and machines it found, and which lanes that closes. Part of its output for the example profile:

 "closed_lanes": {},
 "open_lanes": [
  "bugs",
  "cards"
 ],

Plugins are optional. A lane whose plugin is missing is closed, and the others carry on.