Project files
A GameGen project is an Unreal project folder with a few extra files. This page lists the ones GameGen reads or writes and says which you should commit.
Overview
| Path | Written by | Purpose | In git |
|---|---|---|---|
.unrest/gamegen.json | New game | The project’s GameGen settings. | Yes |
.unrest/agents/unreal-simulation/ | New game | The Unreal QA agent for this project. | Yes |
.unrest/specs/ | GameGen | The project’s specs. | The tutorial’s .gitignore leaves it out. |
.unrest/skills/ | You | Project skills. | The tutorial’s .gitignore leaves it out. |
GAMEGEN_START_HERE.md | New game | Setup and reopening instructions. | Yes |
Scripts/ue.mjs | The tutorial | Build, test, editor and replay commands. | Yes |
agent/trainer.json | The tutorial | How the Lou view reads this game’s runs. | Yes |
Saved/Lou/ | The game and the Lou view | Recorded runs and forks. | No |
Saved/Automation/ | Scripts/ue.mjs | Build and test logs and the result report. | No |
The tutorial’s .gitignore ignores everything under .unrest/ except gamegen.json and agents/.
.unrest/gamegen.json
This file records the engine. Keep it with the source files. GameGen also treats a folder as an Unreal project when a .uproject file sits at its root.
A blank Unreal project has only the engine:
{
"engine": "unreal"
}The Floppy Bird tutorial adds a louTrainer block that points the Lou view at the game’s runs and scripts:
{
"engine": "unreal",
"louTrainer": {
"manifest": "agent/trainer.json",
"runsRoot": "Saved/Lou/runs",
"datasetsRoot": "Saved/Lou/datasets",
"converter": { "script": "Scripts/run-to-rrd.py" },
"forkHere": { "script": "Scripts/fork-here.py" }
}
}| Key | Meaning |
|---|---|
engine | The engine. unreal for an Unreal project. |
louTrainer.manifest | The game’s manifest for the Lou view. |
louTrainer.runsRoot | Where recorded runs are read from. |
louTrainer.datasetsRoot | Where fork records are kept. |
louTrainer.converter.script | The script that builds a run’s recording. |
louTrainer.converter.python | The Python that runs it. Optional. See Set up recording. |
louTrainer.forkHere.script | The script that Fork from here runs. |
agent/trainer.json
The game’s manifest tells the Lou view how to read a run. In the tutorial it names:
- the run’s files and fields, such as
frames.jsonlandsummary.json - GameOver as the end of a run
- the two actions,
flapandwait - the sentence the view shows before any run exists
- the Fork from here form: a default hold of 1, and the recorded inputs playing on after the fork
Scripts/run-to-rrd.pyas the recording builder
Saved/Lou
Saved/Lou/
runs/
play-<UTC date>-<time>-<n>/ a run you played
manifest.json
frames.jsonl
summary.json
run.rrd once built
fork-<run>/ the forks of a run
datasets/
fork-<run>/branches.jsonl one row per forkSee Record a run for what each file holds.
Saved/Automation
| File | Contents |
|---|---|
floppy-result.json | The result report of the last build or test. The Unreal view reads it. |
floppy-build.log | The last build’s output. |
floppy-tests.log | The last test run’s output. |
floppy-replay.log | The last replay’s output. |
qa-editor.log | The output of the editor that editor-start launched. |
Each build or test replaces the result report, so an old result cannot stand in for a new one.
Scripts/ue.mjs
One script with no dependencies. It runs on Node 18 or newer, Bun or Deno. See the ue.mjs command reference.