docs: update LUNA-2 README with feature documentation and controls
This commit is contained in:
@@ -1,6 +1,31 @@
|
||||
# LUNA-1: Pink Unicorn Game — Project Scaffolding
|
||||
# LUNA-2: Character Controller — Jump, Gallop, Trails
|
||||
|
||||
Starter project for Mackenzie's Pink Unicorn Game built with **p5.js 1.9.0**.
|
||||
Starter project for Mackenzie's Pink Unicorn Game built with **p5.js 1.9.0**, implementing the core character controller.
|
||||
|
||||
## Controls
|
||||
|
||||
| Input | Action |
|
||||
|-------|--------|
|
||||
| Tap / Click | Move unicorn toward tap point |
|
||||
| Spacebar | Jump (when grounded) |
|
||||
| Proximity | Long distances trigger gallop speed boost |
|
||||
|
||||
## Features
|
||||
|
||||
- **Physics**: Jump with gravity affecting vertical movement
|
||||
- **Gallop**: Speed increases when far from target; dust particles trail behind
|
||||
- **Movement sparks**: Trail particles (sparkles) follow unicorn path; more frequent during gallop
|
||||
- **Floating islands**: Multiple platforms at varied heights
|
||||
- **Collectibles**: Crystals with particle burst feedback
|
||||
- **Touch-friendly**: Works with mouse and touch
|
||||
|
||||
## Technical Details
|
||||
|
||||
- p5.js loaded from CDN (no build step)
|
||||
- Easing horizontal movement (`lerp`) with gallop factor
|
||||
- Vertical movement simulation with gravity and ground collision
|
||||
- Particle systems for trails, dust, and collection bursts
|
||||
- `colorMode(RGB, 255)`; pink/unicorn palette defined in code
|
||||
|
||||
## Quick Start
|
||||
|
||||
@@ -12,37 +37,12 @@ python3 -m http.server 8080
|
||||
|
||||
Or simply open `luna/index.html` directly in a browser.
|
||||
|
||||
## Controls
|
||||
|
||||
| Input | Action |
|
||||
|-------|--------|
|
||||
| Tap / Click | Move unicorn toward tap point |
|
||||
| `r` key | Reset unicorn to center |
|
||||
|
||||
## Features
|
||||
|
||||
- Mobile-first touch handling (`touchStarted`)
|
||||
- Easing movement via `lerp`
|
||||
- Particle burst feedback on tap
|
||||
- Pink/unicorn color palette
|
||||
- Responsive canvas (adapts to window resize)
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
luna/
|
||||
├── index.html # p5.js CDN import + canvas container
|
||||
├── sketch.js # Main game logic and rendering
|
||||
├── style.css # Pink/unicorn theme, responsive layout
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## Verification
|
||||
|
||||
Open in browser → canvas renders a white unicorn with a pink mane. Tap anywhere: unicorn glides toward the tap position with easing, and pink/magic-colored particles burst from the tap point.
|
||||
Open in browser → canvas renders a white unicorn with a pink mane. Tap anywhere: unicorn glides toward the tap position. Jump with spacebar. Move far away: unicorn speeds up( gallops) leaving a dust trail and sparkles . Collect crystals to see bursts.
|
||||
|
||||
## Technical Notes
|
||||
## Files
|
||||
|
||||
- p5.js loaded from CDN (no build step)
|
||||
- `colorMode(RGB, 255)`; palette defined in code
|
||||
- Particles are simple fading circles; removed when `life <= 0`
|
||||
- `index.html` — p5.js import + container
|
||||
- `sketch.js` — Main game logic
|
||||
- `style.css` — Responsive layout and styling
|
||||
Reference in New Issue
Block a user