Skip to content

new-project ​

Tool scripts/new-project.sh (script, Scripts). Start a reverse-engineering project for one game, with GameFrame's toolkit and playbook.

Run it as scripts/new-project.sh. Source on GitHub.

Its own help ​

This is the help text in the tool itself, as ./gameframe tool new-project prints it.

text
Start a reverse-engineering project for one game, with GameFrame's toolkit and playbook.

  scripts/new-project.sh DIR "Game Name" [PATH/TO/GAME]

Creates DIR as a git repository with:
  AGENTS.md (+ CLAUDE.md)   the rules, with the game's name; edit the goal paragraph first
  README.md, LICENSE-APACHE, LICENSE-CC0-1.0   front page (build/run per part); code Apache 2.0, content CC0 1.0
  .claude/skills/           the re-* skills (every step of the method)
  .claude/agents/           the stage and task agents, which hand off to each other
  .claude/settings.json     light permissions and the gates (scripts/hooks/gate.py)
  tools/, scripts/          GameFrame's toolkit, requirements.txt, .mcp.json (REA)
  gameframe                 the help and discovery command (./gameframe help)
  docs/FINDINGS.md, docs/CHECKLIST.md, labels/names.tsv, labels/fields.tsv
  docs/DOS.md, ABI.md, GAME-PATTERNS.md, LEGAL.md, OUTPUTS.md, SETUP.md   the reference documents
  docs/games/, observe/, engines/, hardware/, consoles/, working/, case-studies/   the guides
  target/, analysis/, derived/   for the game, Ghidra output and ground truth: ignored by git
With PATH/TO/GAME it copies the game's executables and DLLs into target/ (data files are
left where they are: point the tools at them) and prints a first look at each binary.

Named by ​

Skills: re-start, re-port.

Code: Apache 2.0. Content: CC0 1.0. No game material: bring your own copy.