102 lines
3.0 KiB
Markdown
102 lines
3.0 KiB
Markdown
<p align="center">
|
|
<h1 align="center">RS-MobCages</h1>
|
|
<p align="center">
|
|
Capture, transport, and release mobs with portable Mob Cages.
|
|
</p>
|
|
|
|
|
|
<p align="center">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
---
|
|
|
|
## Overview
|
|
|
|
**RS-MobCages** allows players to capture supported mobs inside portable Mob Cages, carry them in their inventory, transport them wherever they are needed, and release them again.
|
|
|
|
Mob Cages are designed to provide a simple and convenient way to move mobs without relying on leads, boats, minecarts, or other traditional transportation methods.
|
|
Capture a mob, take it with you, and release it at its new destination.
|
|
|
|
---
|
|
|
|
## Features
|
|
|
|
### 🐾 Capture Supported Mobs
|
|
|
|
Use an empty Mob Cage on a supported mob to capture it.
|
|
The cage stores the information needed to recreate the mob when it is released.
|
|
|
|
### 📦 Portable Mob Storage
|
|
|
|
Captured mobs can be carried as items in a player's inventory.
|
|
This makes it easy to transport mobs across your world.
|
|
|
|
### 🔄 Release Mobs Anywhere
|
|
|
|
Release a captured mob when you are ready to place it in its new location.
|
|
After release, the Mob Cage becomes empty and can be used again.
|
|
|
|
### 🧬 Mob-Specific Data
|
|
|
|
RS-MobCages uses mob descriptors to handle supported mobs and preserve mob-specific information when appropriate.
|
|
This allows different types of mobs to be handled according to their individual requirements.
|
|
|
|
### 🚫 Protected Mobs
|
|
|
|
Players and named mobs cannot be captured.
|
|
Named mobs are also protected from capture.
|
|
|
|
### 🛡️ Safe Capture Handling
|
|
|
|
If a creature is not supported by RS-MobCages, the plugin will safely prevent it from being captured.
|
|
|
|
---
|
|
|
|
## How It Works
|
|
|
|
Using a Mob Cage is simple:
|
|
|
|
1. Obtain an empty Mob Cage.
|
|
2. Hold the empty cage in your main hand.
|
|
3. Right-click a supported mob to capture it.
|
|
4. Carry the filled Mob Cage to its new location.
|
|
5. Release the mob.
|
|
6. Reuse the empty Mob Cage.
|
|
|
|
---
|
|
|
|
## Documentation
|
|
|
|
Complete documentation is available in the [`docs`](docs/) folder.
|
|
|
|
Planned documentation includes:
|
|
|
|
- [Installation](./docs/Installation.md)
|
|
- [Getting Started](./docs/Getting-Started.md)
|
|
- [Crafting a Mob Cage](docs/Crafting.md)
|
|
- [Capturing Mobs](./docs/Capturing-Mobs.md)
|
|
- [Releasing Mobs](./docs/Releasing-Mobs.md)
|
|
- [Supported Mobs](./docs/Supported-Mobs.md)
|
|
- [Mob Variants and Attributes](./docs/Mob-Variants-and-Attributes.md)
|
|
- [Commands and Permissions](./docs/Commands-and-Permissions.md)
|
|
- [Configuration](./docs/Configuration.md)
|
|
- [Admin Guide](./docs/Admin-Guide.md)
|
|
- [Troubleshooting](./docs/Troubleshooting.md)
|
|
- [Changelog](./docs/Changelog.md)
|
|
|
|
---
|
|
|
|
## Requirements
|
|
|
|
- Paper
|
|
- A supported Minecraft server version
|
|
- Java version required by the server version
|
|
|
|
--- |