first commit

README.md

@@ -0,0 +1,44 @@
+# FallSMP-Rewards
+
+Kill-based quest rewards plugin for Paper 1.21.
+
+## Features
+
+- Configurable player-kill milestone quests in `config.yml`
+- Item rewards per quest (example format: `DIAMOND:3`)
+- 3x3 GUI (`/rewards`) with:
+  - `CHEST` icon when claimable
+  - `MINECART` icon when not claimable
+  - detailed lore for quest text + progress + rewards
+- JSON player progress storage in `plugins/FallSMP-Rewards/playerdata/<uuid>.json`
+- Per killer-victim cooldown for counted kills (default 10 minutes)
+- Sound effects for open, progress, unlocked, claim, and denied actions
+
+## Command
+
+- `/rewards` - Opens the rewards GUI
+- `/rewards reload` - Reloads plugin config and quest definitions (`fallsmprewards.reload`)
+
+## Configure quests
+
+Edit `src/main/resources/config.yml` (or generated plugin config):
+
+```yml
+kill-count-cooldown-minutes: 10
+
+quests:
+  hunter_1:
+    required-kills: 5
+    title: "&aHunter I"
+    description:
+      - "&7Kill 5 players in total."
+    rewards:
+      - "IRON_INGOT:16"
+      - "GOLDEN_APPLE:1"
+```
+
+## Build
+
+```powershell
+./gradlew.bat build
+```