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
1 change: 1 addition & 0 deletions ASSETS_LICENSES.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ These assets were made for this project, either by hand, by procedure, or with i
| Hoppy 2D sprite pack | `Character/Hoppy/2D/hoppy-sprite-pack/` | Generated from internal comic references | ⚠️ brand sign-off |
| Hoppy brawler combat supplement | `code-city-brawl-player/` | Image generation; exact combat and victory prompts in `PROMPT.md`, untouched masters `source.png` and `victory-source.png`, reproducible atlas packing in `tools/build_hoppy_brawler.py` | ⚠️ brand sign-off and project asset terms |
| Hoppy armed supplement | `hoppy-armed/` | Built-in image generation; exact prompts in each mode's `PROMPTS.md` / `refinements.json`, untouched masters in `sources/`, deterministic packing in `tools/build_hoppy_armed.py`. See its [`README.md`](hoppys-adventure-arcade/Assets/hoppy-armed/README.md). | ⚠️ brand sign-off and project asset terms |
| CodeRabbit 2D reference hero | `Character/CodeRabbit/2D/heroes_villains/` | Built-in image generation from the artist handover renders; retained masters, exact prompts and calibration in `sources/`, deterministic packing in `tools/build_coderabbit_hero_2d.py`. See its [`README.md`](hoppys-adventure-arcade/Assets/Character/CodeRabbit/2D/heroes_villains/README.md). | ⚠️ brand sign-off and project asset terms |
| Beat'em-up story illustrations | `beatemup-story/` | Built-in image generation; exact prompts and regeneration history in `refinements.json`, untouched masters in `sources/`, deterministic packing in `tools/build_story_scenes.py`. | ⚠️ brand sign-off and project asset terms |
| Hub chiptune loop | `Audio/Main Menu/` | Original, procedurally generated by `tools/build_hub_chiptune.py`; CC0 1.0. Design and loop notes in `PROMPTS.md`. The earlier "Send in the Rabbit" theme (music by Erik Thorelli, made with Suno v6 for this game) was removed from the build and stays in the credits. | ✅ |
| The Enchanted Repo music | `Audio/Platformer/The Enchanted Repo/` | Music by Erik Thorelli, made with Suno v6 for this game. Erik holds the rights and grants their use in the game and in this repository. Prompts, Suno song IDs, loop points and delivery steps in `PROMPTS.md`. | ✅ |
Expand Down
8 changes: 5 additions & 3 deletions docs/enchanted-repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Cross the forest and ruined castle, defeat the Legacy Monolith, then land on or

## Route and hazards

The 5,300-pixel route has three gaps (160–170 px), six solid raised root platforms, five crumbling branches, six ordinary enemies, five timed hazards, 25 Commit Tokens, and the existing shield, healing, boost and Auto-Fix pickups. Upper routes offer rewards; gaps are also jumpable without waiting for branch regrowth. A full-heal pickup precedes the boss arena.
The 5,300-pixel route has three gaps (160–170 px), six solid raised root platforms, five crumbling branches, six ordinary enemies, five timed hazards, 25 Commit Tokens, and the existing shield, healing, boost and Auto-Fix pickups. Raised root platforms preserve the artwork's transparent underside; only ground and boundary walls receive a solid backing. Upper routes offer rewards; gaps are also jumpable without waiting for branch regrowth. A full-heal pickup precedes the boss arena.

Branches support Hoppy until 0.7 seconds after landing, then remove collision, show breaking/falling art, and regrow after a 0.25-second break plus 3.5-second absence. Regrowth waits if Hoppy occupies the future platform shape. Pause freezes all timers. Branches over gaps provide stepping stones; falling into a pit still kills Hoppy through the normal retry flow.

Expand Down Expand Up @@ -47,7 +47,7 @@ The level plays original music by Erik Thorelli from `Assets/Audio/Platformer/Th

Both loop from their `.import` settings (`loop`, `loop_offset`), so the player never reaches its finished signal. The shared scene-local Music-bus player changes tracks with pause-aware fades, suspends arcade music while playing and restores it on leaving. Shared imported streams are not changed. Existing Platformer jump/hurt/UI sounds are reused.

`scenes/platformer/enchanted_repo.gd` extends the existing `modes/platformer/level.gd`. New local scripts provide art crops, enemies, branch lifecycle, timed hazards, Monolith combat, and a ground-wave subclass of Orbital's projectile. The shared player and level lifecycle are unchanged. The router and Level Select now expose the new level with its own layered artwork. Background plates are finite scenery overlapped for coverage, not seamless textures. Terrain combines cropped kit sprites with separate collision solids, as in Orbital Ops; no editor-painted TileSet is claimed.
`scenes/platformer/enchanted_repo.gd` extends the existing `modes/platformer/level.gd`. New local scripts provide art crops, enemies, branch lifecycle, timed hazards, Monolith combat, and a ground-wave subclass of Orbital's projectile. The shared player and level lifecycle are unchanged. The router and Level Select now expose the new level with its own layered artwork. The treeline uses one continuous parallax strip: `enchanted_treeline.gdshader` crossfades the painted edges in premultiplied color before applying opacity once. This avoids the darker rectangular bands caused by overlapping translucent panels. Its lower edge fades into the sky where floor gaps expose it. Terrain combines cropped kit sprites with separate collision solids, as in Orbital Ops; no editor-painted TileSet is claimed.

## Validation and limits

Expand All @@ -57,4 +57,6 @@ The smoke suite passes headless and rendered: spawn, real platform/branch boardi

`tests/enchanted_boundaries.gd` checks occupied branch regrowth, safe quill warning/recovery, committed jab side, Auto-Fix boss exclusion, retained bare attack art, and fresh-instance armor. Orbital's complete smoke suite and Bay Area's smoke suite pass as regressions. Rendered spawn, boss, core, results and Level Select captures were reviewed.

The macOS sandbox aborts graphical launches before engine output; the rendered suite ran with approved graphical access. Headless import reports existing global-editor-settings/certificate sandbox warnings. No packaged exports or physical-controller session were tested. Fine animation registration, background joins, enemy death effects and longer hands-on balance testing remain polish work. No checkpoint saving or new audio assets were added.
The original macOS sandbox aborted graphical launches before engine output; the rendered suite ran with approved graphical access. Headless import reported existing global-editor-settings/certificate sandbox warnings. No packaged exports or physical-controller session were tested. Fine animation registration, enemy death effects and longer hands-on balance testing remain polish work. No checkpoint saving or new audio assets were added.

The 2026-11-14 background correction adds `tests/enchanted_background.gd`. Its headless checks cover viewport coverage at eight positions from spawn through the arena and exit. Its rendered checks use a constant-color fixture to verify uniform opacity across every repeat and a transparent lower edge. The complete route captures are in `docs/previews/enchanted-repo/background-*.png`, with a visual overview in `background-route-review.jpg`. Run this suite without `--headless` to regenerate them.
2 changes: 1 addition & 1 deletion docs/heroes-vs-villains.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This mode uses the armored Hoppy and the [Mode 2 asset pack](heroes-vs-villains-

The first entry from the menus opens the game's [how-to-play card](main-menu.md#how-to-play-cards) before the opening cards; the pause menu's **How to Play** shows it again.

The armored Hoppy uses eight-frame side, away and toward-camera locomotion cycles at 14 fps, with cadence scaled to analog movement and speed effects. Base travel speed is 264 pixels/second (10% above Code City Brawl).
The armored hero uses eight-frame side, away and toward-camera locomotion cycles at 14 fps, with cadence scaled to analog movement and speed effects. Base travel speed is 264 pixels/second (10% above Code City Brawl). Its reference-matched white-and-orange costume is drawn consistently across all 120 gameplay cels; the away view shows the white backs of the ears. The [hero asset guide](../hoppys-adventure-arcade/Assets/Character/CodeRabbit/2D/heroes_villains/README.md) documents sources, packing, calibration and visual comparisons.

Hoppy has three health points, jump avoidance, hit recovery and one shield on stage entry after REVIEW is unlocked. Attack presses can buffer the next combo strike. Clear ordinary rooms, then walk through the right gate. Boss encounters end with a short Hoppy victory hop while the defeated villain collapses, followed by the reward cards. After the last reward card, Hoppy runs out of the stage on his own under a CAPABILITY DEPLOYED banner, faster than his normal run when he starts far from the right edge, so he always leaves the screen before it fades. The screen dips to black while the next stage loads, then he runs in under its title banner and play resumes; the sequence takes about 2–3 seconds and needs no input. Messages raised while the title banner fades into combat, such as the encounter counter, wait until it clears. The opening cards lead into the same run-in, and so does a retry. Boss music dips, swaps tracks at the bottom and comes back up over 0.6 seconds. The final boss instead leads to the final victory cards and results. Break props for supplies; consumables collect on contact, while weapons require pickup input. Losing the last health point knocks Hoppy out:
- Play freezes under a white flash.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions docs/previews/hero-reference/VALIDATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Reference hero validation

Validated locally on 2026-11-14 with Godot 4.7.stable.official.5b4e0cb0f.

## Automated checks

All nine hero/integration suites passed in the final run: `heroes_reference_assets`, `heroes_villains_assets`, `heroes_villains_motion`, `heroes_villains_logic`, `heroes_villains_smoke`, `hoppy_armed_assets`, `beatemup_story`, `beatemup_knockout`, and `how_to_play`.

The additional Enchanted Repo transparency change passed `enchanted_assets`, `enchanted_boundaries`, and `enchanted_repo_smoke`. Collision geometry is unchanged; only the solid Polygon2D backing of raised one-way platforms was removed.

Reproduction command for the hero checks:

```sh
uv run --python 3.12 --no-project python tools/tests/run_tests.py --godot /Applications/Godot.app/Contents/MacOS/Godot -k heroes_reference_assets -k heroes_villains -k hoppy_armed_assets -k beatemup_story -k beatemup_knockout -k how_to_play -j 2
```

## Visual evidence

The numbered sheets cover 120 gameplay cels across combat, three movement directions, and five weapons. Before/after comparisons use baseline `27e2762`, at native and 2x size. Movement and armed combo GIFs are supplied at native and 4x size. The rear movement frames show white outer ears; a pixel regression check covers all eight frames.

Rendered Heroes motion and smoke suites also passed. Captures in `../heroes-villains/` show the movement cycles, mirrored combat poses, weapon contact phases, story cards, stages, victory and ending. Runtime motion checks cover both facings, weapon switching, carrying, jumping, defeat and face clearance.

`../enchanted-repo/transparent-platforms.png` shows the actual rendered platform silhouettes against the forest. The windowed Enchanted end-to-end test failed after its pause checks, consistent with the level's automatic focus-loss pause; it is not counted as a passing rendered run. Its complete headless smoke suite passed, including traversal and collision checks. The saved spawn capture directly verifies the visual transparency change.

## Rebuild and scope

Re-running the sprite, story and presentation builders produced identical SHA-256 hashes for all 26 runtime outputs: seven atlases, seven SpriteFrames resources, five carry textures, the manifest, two story images and four presentation scenes. The final assets still matched these hashes after producing the additional native-size previews.

Gameplay clocks, clip names/counts/durations, attack contact phases, reach, damage and collisions retain their original definitions. Changed runtime code is confined to Heroes art/weapon registration and the separately requested Enchanted platform backing. Other game mode resources were not changed.
Loading
Loading