diff --git a/README.md b/README.md new file mode 100644 index 0000000..d133901 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +
+ +# RS-MobCage + +### Mob Capture & Transport for Modern Minecraft Servers + +![Minecraft](https://img.shields.io/badge/Minecraft-1.21%2B-green) +![Platform](https://img.shields.io/badge/Platform-Paper-orange) +![Status](https://img.shields.io/badge/Status-Stable-success) +![Development](https://img.shields.io/badge/Development-Active-brightgreen) +![RS Ecosystem](https://img.shields.io/badge/RS-Ecosystem-purple) + +
+ +**RS-MobCage** is a Minecraft plugin that adds reusable Mob Cages for capturing, transporting, and releasing supported mobs. + +A Mob Cage stores the captured mob's relevant information directly on the item, allowing the mob to be safely moved and released somewhere else. + +## Features + +- Capture supported mobs using a reusable Mob Cage +- Release captured mobs by right-clicking the ground +- Preserves supported mob variants +- Preserves baby/adult state where supported +- Preserves supported mob attributes such as: + - Cow variants + - Chicken variants + - Pig variants + - Sheep color + - Horse color and markings +- Prevents named mobs from being captured +- Prevents players from being captured +- Requires mobs to be at full health before capture +- Prevents Mob Cages from being placed as blocks +- Handles mob equipment during capture +- Configurable equipment-drop behavior +- Custom Mob Cage recipe +- Uses persistent item data to identify and track cage state +- Supports adding additional mob types through the descriptor system + +## Mob Cage + +The Mob Cage is crafted using: + +```text +Iron Bars | Iron Bars | Iron Bars +Iron Bars | Iron Ingot | Iron Bars +Iron Bars | Iron Bars | Iron Bars \ No newline at end of file