clankgame/README.md
Rob Colbert bf29fe4949 Add README.md and AGENTS.md documentation
- README: installation, dev server, gameplay controls, screens, sound
- AGENTS.md: project structure, stack, implementation patterns, git workflow
2026-05-30 03:03:20 -04:00

50 lines
1.3 KiB
Markdown

# The Clanked Game
A Space Invaders-inspired browser game built with React and Vite.
## Installation
```bash
pnpm install
```
## Development
```bash
pnpm dev
```
Runs the Vite dev server. Open the URL shown in your terminal (typically http://localhost:5173/).
## Gameplay
### Controls
| Key | Action |
|-----|--------|
| Arrow Left / A | Move left |
| Arrow Right / D | Move right |
| Space | Fire missile |
| Escape | Pause / Resume |
### Objective
Destroy all waves of aliens before they reach your position or deplete your lives.
- **Green aliens** (bottom rows): 10 points
- **Yellow aliens** (middle rows): 20 points
- **Red aliens** (top rows): 30 points
### Screens
- **Home** — Landing screen with "Main Menu" button
- **Main Menu** — Access "Start New Game" and "Options" (Options not yet implemented)
- **Game** — Canvas-based gameplay with HUD showing Score, Lives, and Round
- **Pause** — Overlay when Escape is pressed; press Escape again to resume
### Sound
Aliens play the classic four-note descending march throughout gameplay. The tempo accelerates as you destroy more aliens, matching the original 1978 arcade experience. Player fire and alien hits also produce synthesized sound effects.
Lose a life → Game Over → Return to Main Menu or start a New Game.