# SoulForge **A powerful Minecraft Paper plugin that adds custom tools, a soul harvesting system, an upgrade shop, and a built-in resource pack — all in one.** --- ## Features ### Custom Tools | Tool | Description | |------|-------------| | **Drill 3×3** | A netherite pickaxe that mines a 3×3 area in one strike. Crafted with diamond blocks. | | **Drill 5×5** | An upgraded drill that mines a 5×5 area. Crafted with netherite blocks. | | **TNT Pickaxe** | Has a configurable chance to spawn primed TNT when breaking blocks. Crafted with TNT and netherite. | | **Scythe of the Grim Reaper** | A netherite sword that harvests **souls** from slain mobs with a chance-based drop. | | **Timber Axe** | Fells entire trees (logs + leaves) in one chop, with a cooldown between uses. | | **Murasame** | A cursed netherite sword that applies a spreading curse to mobs — after 5 stacks, the target dies. Crafted with wither skeleton skulls. | All custom items are **unbreakable**, display an enchantment glint, and support custom models via the optional resource pack. ### Soul System - Kill mobs while holding the **Scythe** to harvest **souls**. - Souls are tracked per-player and persist across sessions (`souls.yml`). - Use `/souls` to check your balance, or `/soulsgive ` to transfer souls. - View another player's souls with `/souls ` (requires `souls.seeothers` permission). ### Souls Shop (`/soulsshop`) Spend souls on **permanent, per-player upgrades** that apply whenever you craft a new tool: | Upgrade | Description | Cost | Levels | |---------|-------------|------|--------| | Souls: Multiplier | +1 soul per drop per level (cap configurable) | 5 souls | 4 | | Scythe: Efficiency | Adds Efficiency enchantment | 15 souls | 5 | | Scythe: Looting | Adds Looting enchantment | 20 souls | 3 | | Scythe: Soul Harvest | Increases soul harvest chance | 50 souls | 5 | | Scythe: Sharpness | Adds Sharpness enchantment | 20 souls | 5 | | TNT Pickaxe: Fortune | Adds Fortune enchantment | 25 souls | 3 | | TNT Pickaxe: Silk Touch | Adds Silk Touch | 25 souls | 1 | | TNT Pickaxe: Unbreakable | Makes it unbreakable | 40 souls | 1 | | Timber Axe: Remove Cooldown | Removes the felling cooldown | 30 souls | 1 | | Timber Axe: Efficiency | Adds Efficiency enchantment | 15 souls | 5 | | Timber Axe: Fortune | Adds Fortune enchantment | 20 souls | 3 | | Timber Axe: Silk Touch | Adds Silk Touch | 20 souls | 1 | | Unlock Murasame Crafting | Permanently unlocks the Murasame recipe | 100 souls | 1 | After purchasing an upgrade, **craft the tool again** to receive the new enchantments. ### Resource Pack SoulForge includes a built-in optional resource pack with custom models for all tools. The pack can be: - **Auto-downloaded** by players on join (configurable in `config.yml`). - **Toggled live** with `/soulforge reload` — no server restart required. - Item models automatically sync across inventories, ender chests, and shulker boxes. ### Crafting Recipes All tools are craftable through vanilla-style shaped recipes. Use `/recipe` to browse all recipes, or `/3x3recipe`, `/5x5recipe`, `/tntrecipe` for specific ones. A search dialog is available via `/recipe `. --- ## Commands | Command | Description | Permission | |---------|-------------|------------| | `/recipe [search]` | Browse all recipes or search | — | | `/3x3recipe` | Show Drill 3×3 recipe | — | | `/5x5recipe` | Show Drill 5×5 recipe | — | | `/tntrecipe` | Show TNT Pickaxe recipe | — | | `/souls [player]` | View your (or another's) soul count | `souls.seeothers` (op) | | `/soulsshop` | Open the Souls Shop | — | | `/soulsgive ` | Give souls to another player | — | | `/givesouls ` | Admin: give souls to a player | `givesouls` (op) | | `/silktouch` | Apply Silk Touch to all drills in inventory | — | | `/fortune` | Apply Fortune to all drills in inventory | — | | `/opci give/remove ` | Admin: give/remove custom items | `drill_itemgiver` (op) | | `/soulforge reload` | Reload config & resource pack | `soulforge.admin` (op) | --- ## Configuration All settings are in `config.yml`. Key options: ```yaml texturepack: wanted: false # Enable the resource pack url: "https://..." # Download URL id: "00000000-..." # Resource pack UUID hash: "" # Optional SHA-1 hash (speeds up startup) tntpickaxe: chance: 10 # % chance TNT spawns on block break scythe: soul-chance: 2 # % chance to harvest a soul per kill soul-harvest-bonus: 3 # Bonus chance from Soul Harvest upgrade timberaxe: cooldown-seconds: 10 # Cooldown between tree fells max-tree-logs: 100 # Maximum logs per tree soulsshop: multiplier: 5 multiplier-levels: 4 # Max levels for Souls Multiplier multiplier-cap: 5 # Max souls per drop tntpickaxe: fortune: 25 silktouch: 25 unbreakable: 40 timberaxe: remove-cooldown: 30 efficiency: 15 fortune: 20 silktouch: 20 scythe: efficiency: 15 looting: 20 soul-harvest: 50 sharpness: 20 murasame: crafting-unlock: 100 ``` --- ## Requirements - **Minecraft** 1.21+ - **Paper** server (uses Paper API features like Data Components and Adventure API) - **Java** 21+ --- ## Installation 1. Download the latest `.jar` from [Releases](https://github.com/affenix-studios/SoulForge/releases). 2. Place the jar in your server's `plugins/` folder. 3. Restart the server. 4. (Optional) Edit `plugins/SoulForge/config.yml` to enable the resource pack or adjust settings. --- ## Building from Source ```bash ./gradlew build ``` The compiled jar will be in `build/libs/`. --- **Created by SniperJohnny, member of Affenix Studios**

SniperJohnny

Organizations