Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ body:
attributes:
label: Steps to reproduce
placeholder: |
1. Open Platformer → Level Select → Orbital Ops
1. Pick the Orbital Ops tile on the hub
2. Hold Jump in the zero-gravity bay
3. ...
validations:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ A Godot 4 arcade collection starring Hoppy, the CodeRabbit mascot. It has a reac
```sh
godot --path hoppys-adventure-arcade
```
3. Choose **Platformer Game** (it opens on Level Select), **Endless Runner**, or **Beat’em Up → Play Code City Brawl / Play Heroes vs. Villains**.
3. Pick a game tile: **Bay Area Blitz**, **Orbital Ops**, **The Enchanted Repo**, **Endless Runner**, **Code City Brawl** or **Heroes vs. Villains**. Esc, P or Start pauses any game; **Main Menu** on the pause menu or a results screen returns to the hub.

| Action | Keyboard | Controller |
|---|---|---|
Expand Down
8 changes: 4 additions & 4 deletions docs/bay-area-blitz.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ Run the project normally: **Platformer Game → Play Bay Area Blitz**. For direc
- Move: A/D, left/right arrows, controller left stick or D-pad.
- Jump: Space/W/up arrow, controller A/Cross. Release early for a shorter jump.
- Swipe: J/X, controller X/Square. Swiping is the only way to hurt a bug; there is no stomping, and touching an enemy from any side, including landing on it, costs a heart.
- Pause/resume: Escape, P or controller Start. Focus loss pauses the game. Entering the level from the menus opens its [how-to-play card](main-menu.md#how-to-play-cards); the pause menu's **How to Play** shows it again.
- Pause/resume: Escape, P or controller Start. Focus loss pauses the game. Entering the level from the hub opens its [how-to-play card](main-menu.md#how-to-play-cards); the pause menu's **How to Play** shows it again.
- Defeat the Merge Conflict Monster, then swipe or land on the MERGE button to finish.
- Pause and results provide fresh retry, platformer menu, and arcade return. Finishing a level (any of the three) plays a short stage-clear stinger (`Assets/Audio/Platformer/stinger_stage_clear.ogg`) over the MERGE SUCCESSFUL results while the paused level music stays silent; a knockout keeps its ducked level music instead.
- The pause menu (shared with every game, see [main-menu.md](main-menu.md#pause-menu)) offers Resume, Restart, How to Play and Main Menu; the results offer a fresh **Retry** and **Main Menu**, which returns to the hub. Finishing a level (any of the three) plays a short stage-clear stinger (`Assets/Audio/Platformer/stinger_stage_clear.ogg`) over the MERGE SUCCESSFUL results while the paused level music stays silent; a knockout keeps its ducked level music instead.

## Implemented

A 5,300-pixel authored city route with two jumpable gaps, optional raised token routes, two moving cable-car platforms, parallax buildings/fog, supplied Golden Gate scenery, animated Hoppy, glitch critters, Request Changes Reviewers, broken pipelines, a moving conflict zone, and a three-headed boss. The safe lower route does not require waiting for a cable car.

Three-heart health, damage knockback, post-hit protection, variable jump height, coyote time, jump buffering, swipe hit deduplication, per-run score, boss-gated completion, pause/focus handling, death/retry, level selection, and the Bay Area music track are connected. The existing menu audio/background paths were repaired to match the reorganized Assets folder. Other levels remain explicitly unavailable.
Three-heart health, damage knockback, post-hit protection, variable jump height, coyote time, jump buffering, swipe hit deduplication, per-run score, boss-gated completion, pause/focus handling, death/retry, and the Bay Area music track are connected. The existing menu audio/background paths were repaired to match the reorganized Assets folder. Other levels remain explicitly unavailable.

All art comes from `Assets/bay-area-blitz-assets-only`; Hoppy uses that pack's existing platformer SpriteFrames. Sound uses existing project assets. No assets were generated or downloaded.

Expand Down Expand Up @@ -77,7 +77,7 @@ All three platformer levels share a 3.5-second knockout cutaway for fatal hits a
The level freezes and its HUD disappears while an enlarged Hoppy plays the knockout sprite
animation in place, with fixed position, rotation and scale, and sees stars beneath a K.O.
callout. The current level or boss music keeps playing, ducked by 12 dB,
through the existing results menu. Retry creates a fresh run; leaving restores menu audio.
through the existing results menu. Retry creates a fresh run; leaving restores the hub audio.
Gameplay inputs cannot skip the cutaway, but can still finish the results fade once it appears.

Run `godot --headless --path hoppys-adventure-arcade --script res://tests/platformer_knockout.gd`
Expand Down
6 changes: 3 additions & 3 deletions docs/booth-runbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This runbook is for the staff who run Hoppy’s Adventure Arcade unattended at a
```sh
tools/booth/macos/setup.sh --app "/Applications/Hoppy’s Adventure Arcade.app" --route heroes_vs_villains
```
Nothing changes yet. To apply it, run the same command with `--apply` and enter the administrator password when asked. The game starts. To give each player a retry or change the attract screen, add game flags after `--`, for example `-- --retries=1 --attract=beatem_up` ([booth flags](builds.md#run-it-at-a-booth)).
Nothing changes yet. To apply it, run the same command with `--apply` and enter the administrator password when asked. The game starts. To give each player a retry, add game flags after `--`, for example `-- --retries=1` ([booth flags](builds.md#run-it-at-a-booth)).
4. Do the manual steps the script lists at the end: automatic login, Do Not Disturb, the display, the volume and the controllers.
5. Restart the Mac. The game should start on its own within a minute.

Expand All @@ -40,12 +40,12 @@ Booth mode itself runs fullscreen and ignores the menu's **Quit Game**. A game n
| What happens | What you'll see |
|---|---|
| A player walks away mid-game | After 90 seconds the game returns to the hub. |
| A player loses | Once they have used any retries you set (none by default), a **GAME OVER** card thanks them and shows their score. After six seconds the attract screen (the hub unless you set another) opens for the next player. |
| A player loses | Once they have used any retries you set (none by default), a **GAME OVER** card thanks them and shows their score. After six seconds the hub opens for the next player. |
| The game crashes or closes | The watchdog opens it again within a few seconds. |
| The game freezes | The watchdog restarts it within about a minute. |
| Someone presses Cmd+Q | The game closes, and the watchdog opens it again. |
| The player's controller disconnects | The game pauses and asks for the controller. Plug it back in, or press Start on another controller. |
| You want to clear the Endless Runner scores | Start the Endless Runner tile, pause and choose **Runner Menu**, then **Leaderboard → Reset scores**. (Or start the game once with `--route=runner`.) |
| You want to clear the Endless Runner scores | Start the Endless Runner tile, pause (Esc or Start) and choose **Leaderboard → Reset scores**, then **Reset** to confirm. |

## Stop the game for maintenance

Expand Down
8 changes: 4 additions & 4 deletions docs/builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ open -a "Hoppy’s Adventure Arcade.app" --args -- --booth --route=heroes_vs_vil

- **Fullscreen.** The game starts fullscreen without changing the saved settings.
- **Booth QR code.** A scannable, branded CodeRabbit link stays in the top-right corner on every route in booth mode. The provided code points to `https://coderabbit.link/ato26-ad?qr=1`, which identifies QR scans for attribution. To change the destination, regenerate `hoppys-adventure-arcade/Assets/booth/booth_qr.png` from the repository root with `swift hoppys-adventure-arcade/tools/booth/generate_qr.swift` and pass the output path and URL as optional arguments, then rebuild the game.
- **How-to-play cards.** Each visitor's first entry into a game opens its how-to-play card. Its pages turn by themselves every 7 seconds (28 seconds at most), so it starts play on its own and never holds off the idle reset. A new visitor starts whenever the attract route opens. See [main-menu.md](main-menu.md#how-to-play-cards).
- **Idle reset.** After 90 seconds with no keyboard, mouse, touch or controller input, any game returns to the attract route. That is the hub, whose rotating previews act as the attract screen, unless `--attract=` names `beatem_up` or `runner`, the other menus that start their own music.
- **Game over.** A lost game doesn't offer unlimited retries. A player gets `--retries=<n>` retries (default 0); after that, the game shows no retry screen. Instead a **GAME OVER** card thanks the player, shows their score and counts down six seconds, then the attract route opens for the next player. The count starts again whenever the attract route opens. Every game takes part: Heroes vs. Villains, Code City Brawl, the platformer levels and the Endless Runner. Without `--booth`, every game keeps its own retry screen.
- **How-to-play cards.** Each visitor's first entry into a game opens its how-to-play card. Its pages turn by themselves every 7 seconds (28 seconds at most), so it starts play on its own and never holds off the idle reset. A new visitor starts whenever the hub opens. See [main-menu.md](main-menu.md#how-to-play-cards).
- **Idle reset.** After 90 seconds with no keyboard, mouse, touch or controller input, any game returns to the hub, whose rotating previews act as the attract screen. (The old `--attract=` flag is still accepted so saved booth configs keep launching; it logs a warning and changes nothing.)
- **Game over.** A lost game doesn't offer unlimited retries. A player gets `--retries=<n>` retries (default 0); after that, the game shows no retry screen. Instead a **GAME OVER** card thanks the player, shows their score and counts down six seconds, then the hub opens for the next player. The count starts again whenever the hub opens. Every game takes part: Heroes vs. Villains, Code City Brawl, the platformer levels and the Endless Runner. Without `--booth`, every game keeps its own retry screen.
- **No quitting from the menu.** The menu's **Quit Game** does nothing in booth mode; staff close the window (Cmd+Q, Alt+F4).
- **Launch route.** `--route=<name>` opens a route at launch (`heroes_vs_villains`, `code_city_brawl`, `bay_area_blitz`, `orbital_ops`, `enchanted_repo`, `runner`, `platformer`, `beatem_up`, `hub`), with or without `--booth`. An unknown name logs an error and opens the hub.
- **Launch route.** `--route=<name>` opens a route at launch (`heroes_vs_villains`, `code_city_brawl`, `bay_area_blitz`, `orbital_ops`, `enchanted_repo`, `runner_game`, `credits`, `hub`), with or without `--booth`. An unknown name logs an error and opens the hub.
- **Keep it running.** `tools/booth/watchdog.sh` relaunches the game whenever it exits and restarts it when it hangs. The watchdog passes `--heartbeat=<path>`, which makes the game rewrite that file with the current time every two seconds; a file that stops changing means the game is stuck. On a Mac, `tools/booth/macos/setup.sh` installs the watchdog as a login item and applies the kiosk settings. The [booth runbook](booth-runbook.md) walks staff through setup, the show days and recovery.
- **Session log.** Booth mode records each game session's start and end in `user://booth/`, one file per run of the game (`sessions-<date and time>-<process id>.jsonl`). Each entry records the game, the local start and end times, the duration, how the session ended (`menu`, `idle`, `game_over` or `quit`), how many times the player re-entered the game, and how many times they lost (`game_overs`, stage retries included). It records nothing about players and never uses the network. A start with no end means the game stopped without quitting: a crash, a power cut or a forced kill. The game prints its file's full path at startup. `--session-log=<folder>` writes to another folder and works without `--booth`, for playtests.

Expand Down
Loading
Loading