57 lines
2.0 KiB
Markdown
57 lines
2.0 KiB
Markdown
# Squirrel Forest
|
|
|
|
A 2D Phaser adventure-platformer about a squirrel exploring a living woodland full of flora, fauna and unusual mushrooms.
|
|
|
|
## Current prototype
|
|
|
|
- Side-scrolling exploration across five named woodland areas.
|
|
- Animated squirrel with separate visual and physics bodies.
|
|
- Keyboard and multi-touch movement/jumping.
|
|
- One-way log platforms: jump through from below and land from above.
|
|
- Acorn collection and five mushroom discoveries.
|
|
- Ambient frogs, hedgehogs, butterflies and fireflies.
|
|
- Moonlit Grove completion sequence.
|
|
|
|
## Controls
|
|
|
|
- **Move:** A/D or Left/Right
|
|
- **Jump:** W, Up or Space
|
|
- **Touch:** independent left/right and jump controls
|
|
|
|
## Structure
|
|
|
|
- `src/main.js` — scene orchestration, world content, HUD and input.
|
|
- `src/PlayerController.js` — squirrel physics/visual synchronization and animation state.
|
|
- `src/worldConfig.js` — shared world/surface geometry and platform metadata.
|
|
- `public/assets/player-game-sheet.png` — normalized squirrel animation sheet.
|
|
- `public/assets/world-atlas.png/json` — optimized runtime atlas for terrain, flora and fauna.
|
|
- `source-assets/` — preserved original source art sheets.
|
|
|
|
The original large public source sheets are retained in Git for now, but the production Docker build removes them before Vite runs so they are not shipped to the browser.
|
|
|
|
## Run
|
|
|
|
```bash
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
Production build:
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
## Direction
|
|
|
|
The intended feel is a cosy exploratory woodland adventure focused on traversal, discovery, environmental storytelling and small animal interactions rather than combat-first progression.
|
|
|
|
Good next slices:
|
|
|
|
1. climbable trunks and branch-to-branch movement;
|
|
2. field-guide journal for discovered plants, fungi and animals;
|
|
3. richer biome pockets such as birch grove, damp hollow, old oak canopy and moonlit marsh;
|
|
4. lightweight animal NPC quests;
|
|
5. acorn throwing / interaction using the existing player frames;
|
|
6. re-enable audio behind a user gesture once the sound pass begins.
|