From 33dc16ddce16b657a54fcba9f47b0e23c5fb102b Mon Sep 17 00:00:00 2001 From: Erik Thorelli Date: Thu, 15 Oct 2026 15:48:21 -0700 Subject: [PATCH] docs(readme): show booth staff how to launch the kiosk [Agent: Claude Code | Model: Opus 5.5 | Thinking: High | Acting on behalf of: Erik | Skill: none] Juan asked for a README note on running the game at a booth. The flags (#43) are documented only in docs/builds.md, which the README never pointed to. A short "Run it at a booth" subsection under Builds now gives the launch command for each platform, says what booth mode changes, and links the full section for every route and flag. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index bf0bff7f..38c4ba3c 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,18 @@ In Orbital Ops' zero-gravity bay, hold Jump or Up to rise, hold Down to descend, Versioned macOS, Windows, Linux and Web builds come from the [Build workflow](.github/workflows/build.yml): releases for `v*` tags, artifacts for every `main` push, and preview builds for PRs labelled `preview-build`. To build locally, run `python3 tools/build/export_game.py --smoke`. See [docs/builds.md](docs/builds.md). +### Run it at a booth + +To run a build as an unattended kiosk, pass `--booth` after `--`. Add `--route=` to open a game straight away: + +```sh +open -a "Hoppy’s Adventure Arcade.app" --args -- --booth --route=heroes_vs_villains # macOS +HoppysAdventureArcade.exe -- --booth --route=heroes_vs_villains # Windows +./HoppysAdventureArcade.x86_64 -- --booth --route=heroes_vs_villains # Linux +``` + +Booth mode runs fullscreen and ignores the menu's **Quit Game**, so staff close the window instead. After 90 seconds without input, any game returns to the hub's attract screen. [Run it at a booth](docs/builds.md#run-it-at-a-booth) lists every route and flag. + ## Docs - Platformer: [Bay Area Blitz](docs/bay-area-blitz.md), [Orbital Ops](docs/orbital-ops.md), [The Enchanted Repo](docs/enchanted-repo.md)