add README with build instructions and MIT license

2026-02-24 12:51:12 +01:00
parent 348bd4fe64
commit e86e59cd69
2 changed files with 95 additions and 6 deletions
--- a/21
+++ b/21
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ut3usw
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
--- a/README.md
+++ b/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)