street-crime

Street Crime Documentation

How the game’s art and configuration fit together: how a level is built from the names of its Illustrator layers, how a level design file makes things happen in it, and how characters and objects are named so the game can find them.

Play the demo.

Start here

   
QUICKSTART.md Play the demo, try a level in SANDBOX TEST, and make a first level
CHEATSHEET.md Every naming rule and config key on one page

Levels

Page  
level-naming.md What a level SVG says through its layer names: the walkable field, doors, locks, animated and breakable scenery, trigger areas, holes. Also as a quickstart and a cheatsheet
level-design.md When things happen: states, cases and conditions, triggers, spawn groups and crews, player entrances, resets and drafts in level-design.json. Also as a quickstart and a cheatsheet
inventory.md Items: the catalog, items lying in a level, taking and carrying them, the item screen, the command line, and what a level design reads
level-design-skill.md The level-design agent skill: describe a level in plain words, and it writes the design, a sandbox test and the art to-do, and checks every action in every state. Installing it for Claude Code, Copilot or Codex, the brief, and the checks. Also as a quickstart and a cheatsheet

Assets

Page  
character-assets.md File names, enemy animation config, the player’s frames, and layer names inside a character. Also as a quickstart and a cheatsheet
object-assets.md Shared objects, and a level’s animation frames and breakable state art. Also as a quickstart and a cheatsheet

Testing

Page  
sandbox.md SANDBOX TEST: the config file, the panel, reading its output, and the level design steps

Elsewhere in the repository

   
scripts/README.md The Illustrator scripts: running them from a terminal, and renaming layers from a layer map
config/schema/level-design.schema.json The level design format, for editors
config/palettes.json, config/schema/palettes.schema.json The palettes a level design can recolor a character’s parts with
config/debug/items.json, config/schema/items.schema.json The sandbox’s item catalog, and the format of one