Skip to Content
GameGenReferenceProject files

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

PathWritten byPurposeIn git
.unrest/gamegen.jsonNew gameThe project’s GameGen settings.Yes
.unrest/agents/unreal-simulation/New gameThe Unreal QA agent for this project.Yes
.unrest/specs/GameGenThe project’s specs.The tutorial’s .gitignore leaves it out.
.unrest/skills/YouProject skills.The tutorial’s .gitignore leaves it out.
GAMEGEN_START_HERE.mdNew gameSetup and reopening instructions.Yes
Scripts/ue.mjsThe tutorialBuild, test, editor and replay commands.Yes
agent/trainer.jsonThe tutorialHow the Lou view reads this game’s runs.Yes
Saved/Lou/The game and the Lou viewRecorded runs and forks.No
Saved/Automation/Scripts/ue.mjsBuild 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:

.unrest/gamegen.json
{ "engine": "unreal" }

The Floppy Bird tutorial adds a louTrainer block that points the Lou view at the game’s runs and scripts:

.unrest/gamegen.json
{ "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" } } }
KeyMeaning
engineThe engine. unreal for an Unreal project.
louTrainer.manifestThe game’s manifest for the Lou view.
louTrainer.runsRootWhere recorded runs are read from.
louTrainer.datasetsRootWhere fork records are kept.
louTrainer.converter.scriptThe script that builds a run’s recording.
louTrainer.converter.pythonThe Python that runs it. Optional. See Set up recording.
louTrainer.forkHere.scriptThe 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.jsonl and summary.json
  • GameOver as the end of a run
  • the two actions, flap and wait
  • 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.py as 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 fork

See Record a run for what each file holds.

Saved/Automation

FileContents
floppy-result.jsonThe result report of the last build or test. The Unreal view reads it.
floppy-build.logThe last build’s output.
floppy-tests.logThe last test run’s output.
floppy-replay.logThe last replay’s output.
qa-editor.logThe 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.

Next steps

Last updated on