Skip to content

docs(readme): show booth staff how to launch the kiosk - #73

Merged
esthor merged 1 commit into
mainfrom
esthor/readme-booth-note
Oct 15, 2026
Merged

esthor merged 1 commit into
mainfrom
esthor/readme-booth-note

Conversation

@esthor

@esthor esthor commented Oct 15, 2026 •

Copy link
Copy Markdown
Collaborator

[Agent: Claude Code | Model: Opus 5.5 | Thinking: High | Acting on behalf of: Erik | Skill: none]

Summary

Juan asked for a README note on running the game as a kiosk. The booth flags from #43 are documented only in docs/builds.md, and the README never pointed there.

The README's Builds section gains a short Run it at a booth subsection with:

  • the launch command for macOS, Windows and Linux, with --booth --route=heroes_vs_villains;
  • what booth mode changes: fullscreen, the menu's Quit ignored, and the 90-second idle return to the hub;
  • a link to Run it at a booth for every route and flag.

Docs only; no code changes.

Testing

  • python3 tools/checks/repo_hygiene.py --all: clean.
  • The commands and behavior match app/app_router.gd (BOOTH_FLAG, ROUTE_PREFIX, IDLE_SECONDS = 90) and the executable names in docs/builds.md.

Checklist

  • The PR title follows Conventional Commits
  • Docs are updated (README only)

Summary by CodeRabbit

  • Documentation
    • Added booth-mode setup instructions for macOS, Windows, and Linux, including optional route selection.
    • Documented fullscreen behavior, the 90-second idle return to the hub, and how to access the full booth guide.

[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.
@coderabbitai

coderabbitai Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: coderabbitai/coderabbit-arcade/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Enterprise
  • Run ID: 6cc858b3-56e0-4e29-b32e-66c0399e1e9b
📥 Commits

Reviewing files that changed from the base of the PR and between a531862 and 33dc16d.

📒 Files selected for processing: 1
  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 100 included reviews per hour; 93 remain after this review.

📝 Walkthrough

The README adds booth-mode launch instructions for macOS, Windows, and Linux. It describes the --booth and optional --route flags, booth-mode behavior, and links to the full booth documentation.

Changes: Booth launch documentation

Layer / File(s) Summary
Document booth-mode launch
README.md
Adds platform launch commands using --booth and an optional --route. Describes fullscreen mode, the ignored Quit Game action, and the 90-second idle return to the hub’s attract screen. Links to the full booth documentation.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 33dc1

The booth-launch instructions match the existing application behavior. No actionable merge-blocking risk remains.

### Architecture Summary

Architecture risk: 🔵 Low · up to 33dc1

The change affects 1 system.

Changed systems: README.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — README.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in README.md: Adds booth-running instructions: pass --booth after -- and optionally --route=<name> to open a game directly; provides commands for macOS, Windows, and Linux. The text states booth mode runs fullscreen, ignores the menu’s Quit Game action, and returns any game to the hub’s attract screen after 90 seconds without input, with a link to the full route and flag list.
Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly identifies a README documentation change that explains how booth staff launch the kiosk. It uses a valid Conventional Commits format.
Description check Passed The description explains the purpose, documents the main changes, lists testing performed, and includes the relevant checklist items. Screenshots are not required for this documentation-only change.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)

Generate unit tests in current branch
Generate unit tests

Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@esthor
esthor merged commit 1ef58f1 into main Oct 15, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant