add README with build instructions and MIT license
This commit is contained in:
80
README.md
80
README.md
@@ -1,8 +1,76 @@
|
||||
# FPV Run
|
||||
# FPV Game
|
||||
|
||||
## TODO:
|
||||
A Playdate game where you pilot FPV drones in combat missions. Two game modes: precision FPV strikes and top-down bomber runs.
|
||||
|
||||
- [x] Menu audio
|
||||
- [x] Tags, zOffset from constants
|
||||
- [ ] Add global game state (?)
|
||||
- [x] Add inertia to the player
|
||||
## Game Modes
|
||||
|
||||
**FPV Mode** — Fly a first-person-view drone through the battlefield. Navigate obstacles, manage battery, and hit the target before telemetry is lost.
|
||||
|
||||
**Bomber Mode** — Command a bomber drone from above. Drop grenades on enemy soldiers, collect ammo crates, and complete kill targets to win.
|
||||
|
||||
## Features
|
||||
|
||||
- Two distinct drone types with unique gameplay
|
||||
- Multiple maps with increasing difficulty
|
||||
- Drone assembly mini-game
|
||||
- Crank-based grenade reloading in Bomber mode
|
||||
- Battery management and progressive difficulty
|
||||
|
||||
## Building
|
||||
|
||||
### Requirements
|
||||
|
||||
- [Playdate SDK](https://play.date/dev/)
|
||||
- macOS or Linux
|
||||
|
||||
### Build & Run
|
||||
|
||||
```bash
|
||||
# macOS
|
||||
export PLAYDATE_SDK_PATH="/path/to/PlaydateSDK" # optional, has default
|
||||
./build_and_run_mac.sh build
|
||||
|
||||
# Linux
|
||||
export PLAYDATE_SDK_PATH="/path/to/PlaydateSDK"
|
||||
./build_and_run.sh build
|
||||
```
|
||||
|
||||
To run without rebuilding:
|
||||
|
||||
```bash
|
||||
./build_and_run_mac.sh run
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
source/
|
||||
├── assets/
|
||||
│ ├── audio/ # Sound effects and music
|
||||
│ ├── fonts/ # Bitmap fonts
|
||||
│ ├── images/ # UI images, cards, maps
|
||||
│ ├── launcher/ # Playdate launcher assets
|
||||
│ └── sprites/
|
||||
│ ├── backgrounds/ # Level backgrounds
|
||||
│ ├── bomber/ # Bomber mode sprites
|
||||
│ ├── targets/ # Target vehicles
|
||||
│ └── ... # Player, effects, UI sprites
|
||||
├── libraries/ # Noble Engine, AnimatedSprite, etc.
|
||||
├── scenes/ # Game scenes (Menu, Game, Bomber, etc.)
|
||||
├── scripts/ # Game objects (Player, Enemy, Tank, etc.)
|
||||
└── utilities/ # Helpers and UI utils
|
||||
```
|
||||
|
||||
## Built With
|
||||
|
||||
- [Playdate SDK](https://play.date/dev/)
|
||||
- [Noble Engine](https://github.com/NobleRobot/NobleEngine) — Scene management framework
|
||||
- [AnimatedSprite](https://github.com/Whitebrim/AnimatedSprite) — Sprite animation library
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License — see [LICENSE](LICENSE) for details.
|
||||
|
||||
## Author
|
||||
|
||||
**ut3usw** — [dead.guru](https://dead.guru)
|
||||
|
||||
Reference in New Issue
Block a user