commit a7356dc37c629db27d33da33ae7c18a4dc8dd1f1 Author: Chandler Swift Date: Sun Aug 17 21:16:53 2025 -0500 Add brief documentation diff --git a/README.md b/README.md new file mode 100644 index 0000000..2241f75 --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +# Project Battle + +Project Battle is an Augmented Reality battle-royale-inspired multiplayer game, +using OpenStreetMap data to create ad-hoc battle environments in arbitrary +real-world locations. + +Project Battle is currently in the **exploration** phase. Current game mechanics +are being drafted in the `docs/` folder. diff --git a/docs/mechanics.md b/docs/mechanics.md new file mode 100644 index 0000000..1f0d4b9 --- /dev/null +++ b/docs/mechanics.md @@ -0,0 +1,47 @@ +# Mechanics + +## Powerups + +- **Lava Bucket** ("banana peel"): + Deployed on the map at players current location, causes damage to all playes + (or maybe just players on a different team, deploying team imunity) within a + radius. + - radius + - duration + - damage +- **Air strike** (blue shell): + Deployed at a selected point on the map. Players in the strike zone should get + a warning, chance to deploy shield. +- **Shield** (star power): + Makes player immune to damage for a duration. +- **Decoy**: + Deployed at player’s current location. Displays a false location to enemies. +- **Compass**: + Shows the player the general direction of opponents. + Can be fooled by decoys or jammed by radar jamming. + Only effective within a certain distance. + UI: maybe similar to the Minecraft 1.21.6+ player location bar? +- **Radar Tower**: + Deployable at a team’s “base.” One per team. Shows enemies on the map within a radius. +- **Recon Drone**: + Scans in a straight line (ray) outward from the player’s current location, + revealing enemies or items along its path +- **Cloak**: + Deployable fog that creates a safe zone from detection. + Prevents radar, drone, or compass detection within the area. +- **Health Pack**: + Restores player health. +- **Signal Jammer**: + Disrupts enemy communication and equipment. Locks enemy devices for a duration + (no map updates, unable to collect power-ups). +- **TNT (IED)**: + Deployable explosive. Small, hidden effect that causes blast damage within a + radius when triggered. + +## Combat +Use device compass to aim in direction of enemy and shoot. The closer, the +better acuracy, the more damage dealt. Targets enemies in effective range of +weapon. + +Alternative: QR code scan: Players wear a QR code, which must be scanned for +proof of closeness.