CurseArmour

# ⚔️ CurseArmour **"Power always comes at a price."** CurseArmour is a progression‑focused Minecraft Paper plugin where players voluntarily—or through discovery—equip mysterious cursed armour that cannot be removed. Each piece binds itself to its wearer, growing stronger over time while demanding increasingly dangerous trials. Unlike traditional RPG plugins where progression is based on grinding levels, CurseArmour is based on **achievement**. The strongest gear requires **dedication instead of luck**. --- ## ✨ Features - **Progression System** – 5+ stages of evolving power, with unique quests per stage. - **Quest System** – 15+ quest types (combat, mining, exploration, farming, building). - **Curse‑Breaking System** – Players can break the curse by completing difficult tasks. When they do: - The cursed armour is removed. - Their **original armour** (with all enchantments) is fully restored. - They receive a `Soul of Freedom` reward. - **Global Events** – Blood Moon, Void Storm, Dark Harvest, Soul Eclipse. - **Boss System** – Unique bosses with scaling difficulty and special drops. - **Raid System** – Co‑op wave‑based raids with exclusive rewards. - **Custom Enchantments** – Soul Drain, Bloodlust, Void Step, Iron Will, Last Stand. - **SQLite Storage** – All progress and armour states persist across restarts. - **Admin Commands** – Full control over stages, events, bosses, raids, and players. - **Bedrock Compatible** – Works seamlessly with Geyser/Floodgate. --- ## 📋 Requirements - **Paper 1.21.11+** (or any compatible fork) - **Java 21** - **PlaceholderAPI** (optional) - **Vault** (optional) --- ## 🚀 Installation 1. Download the latest `CurseArmour-1.0.0.jar` from the **Versions** tab. 2. Place it in your server's `plugins/` folder. 3. Start the server. 4. Configure `plugins/CurseArmour/config.yml` to your liking. 5. Customise quests in `plugins/CurseArmour/stages/`. --- ## 🎮 Commands | Command | Description | |---------|-------------| | `/curse` | Opens the Curse Journal GUI | | `/curse progress` | Shows your current stage and stats | | `/curse quests` | Opens a detailed quest list GUI | | `/curse advance` | Advances to the next stage (if all quests are complete) | | `/curse break` | Starts the curse‑breaking ritual | | `/curse breakprogress` | Shows your progress on breaking the curse | **Admin commands** (`/curseadmin`): `reload`, `stage`, `reset`, `event`, `boss`, `raid`, `debug`. --- ## ⚙️ Configuration ### `config.yml` (excerpt) ```yaml settings: max-stages: 5 auto-save: 5 debug: false events: enabled: true interval-minutes: 30 chance-percent: 15 duration-minutes: 10 curse-break: enabled: true tasks: kill-mobs: 1000 mine-blocks: 5000 travel-distance: 100000 kill-bosses: 5 complete-raids: 3 reward: item: "NETHER_STAR" name: "&6Soul of Freedom" lore: "&7You broke the curse." ``` ### Stage Configuration (`stages/stageX.yml`) ```yaml name: "Awakening" description: "Simple survival objectives." required_quests: 3 rewards: description: "+Small armor bonus" defense: 2 toughness: 0.5 enchantments: - "SOUL_DRAIN" ``` --- ## 🧩 PlaceholderAPI Support If PlaceholderAPI is installed, you can use: - `%cursearmour_stage%` – Current stage - `%cursearmour_kills%` – Total kills - `%cursearmour_breaking%` – Whether the player is breaking the curse (`true`/`false`) - `%cursearmour_broken%` – Whether the curse is broken (`true`/`false`) --- ## 🏗️ Building from Source ```bash git clone https://github.com/AyezSkylar/CurseArmour.git cd CurseArmour ./gradlew build # JAR is in build/libs/ ``` --- ## 📝 License This project is licensed under the **MIT License**. --- ## 👤 Author **AyezSkylar** – (https://github.com/AyezSkylar) --- **Made with ❤️ by AyezSkylar**