Added Readme.
This commit is contained in:
BigPappa committed 2026-08-08 17:41:15 -05:00
1 parent 0ed8e725e7
commit f7fce74bd5
1 file changed
+52
+52
View File
@@ -0,0 +1,52 @@
# RS-DISenchanter
![Version](https://img.shields.io/badge/version-0.1.0-blue)
![Minecraft](https://img.shields.io/badge/Minecraft-1.21.11-green)
![Paper](https://img.shields.io/badge/Paper-1.21.11-green)
![Java](https://img.shields.io/badge/Java-21-orange)
![Maven](https://img.shields.io/badge/build-Maven-C71A36)
![License](https://img.shields.io/badge/license-MIT-blue)
RS-DISenchanter is a simple Minecraft Paper plugin that allows players to safely remove enchantments from armor, weapons, tools, and enchanted books.
Normal enchantments can be removed directly.
Curses are handled separately and carry a configurable risk of destroying the item.
---
## Features
- `/disenchant` command
- Simple single-chest Disenchanter GUI
- Supports armor, weapons, tools, and enchanted books
- Displays one enchanted book for each enchantment
- Players choose which enchantments to remove
- Removed enchantments are returned as standard Minecraft enchanted books
- Standard enchanted books remain fully compatible with normal Minecraft books
- Curses must be removed before normal enchantments become available
- Each curse removal attempt has its own destruction roll
- Configurable item-destruction chance
- Supports multiple curses on the same item
- Remaining enchantments are preserved
- Closing the GUI safely returns the item
- Player-facing messages are stored in language files
- Language system designed to support additional languages in the future
---
## How It Works
### Normal Enchantments
Place an enchanted item into the center slot of the Disenchanter.
Each normal enchantment is displayed as an enchanted book.
For example:
```text
Diamond Pickaxe
├── Efficiency V
├── Fortune III
└── Unbreaking III