# RS-MobStand

**Automated Mob Farming for Modern Minecraft Servers**

![Minecraft](https://img.shields.io/badge/Minecraft-1.21%2B-green)
![Platform](https://img.shields.io/badge/Platform-Paper-orange)
![Storage](https://img.shields.io/badge/Storage-YAML-blue)
![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)

------------------------------------------------------------------------

## Overview

**RS-MobStand** is a powerful automated mob killing plugin.

Players convert Armor Stands into Mob Stands and configure them through
intuitive GUI menus while server owners maintain full control through
configurable settings, permissions, filters, and administrative tools.

------------------------------------------------------------------------

## Documentation

See the complete documentation:

-   [Home](docs/Home.md)
-   [Installation](docs/Installation.md)
-   [Creating Your First MobStand](docs/Creating-Your-First-MobStand.md)
-   [Filters](docs/Filters.md)
-   [Radius Settings](docs/Radius-Settings.md)
-   [Pause and Resume](docs/Pause-and-Resume.md)
-   [Admin Guide](docs/Admin-Guide.md)
-   [Troubleshooting](docs/Troubleshooting.md)
-   [Storage and Persistence](docs/Storage-and-Persistence.md)
-   [Permissions](docs/Permissions.md)
-   [Changelog](docs/Changelog.md)

# Features

### Automated Mob Farming
Manage nearby mobs without traditional mob grinders.

### Dynamic GUI Menus
Simple and intuitive inventory-based interfaces.

### Adult & Baby Filters
Configure which mobs are affected by each Mob Stand.

### Radius Controls
Fine-tune stand operation and efficiency. Mob Stands scan within the
configured horizontal radius and only 2 blocks above and 2 blocks below
the stand's base level.

### View Radius
Visualize the configured Mob Stand scan area in-world with a temporary
particle outline visible only to the player who activates it.

### Leave Alive Support
Maintain a configurable number of mobs while still automating
management.  Custom named mobs are completely ignored.

### Individual Arm Poses
When arms are enabled, configure the Main Hand and Off Hand
independently with five available poses: Down, 1/4 Down, Straight Out,
1/4 Up, and Straight Up.

### Display Name Control
Show or hide the Mob Stand's in-world display name directly from the Mob
Stand menu.

### Paused on Conversion
Newly converted Mob Stands start paused, allowing their settings to be
configured before automated mob management begins.

### Mob Whitelists
Adult and Baby mob filters act as whitelists. A mob must be configured
for the appropriate age category before a Mob Stand will affect it.

### YAML Storage
Reliable persistent storage that survives server restarts.

### Armor Stand Ownership
Protect Mob Stands from unauthorized access.

### Vanilla Conversion
Mob Stands can be converted back into standard vanilla Armor Stands,
removing the RS-MobStand functionality.


### Administrative Tools

Powerful management tools for staff and server operators.

------------------------------------------------------------------------

# Installation

1.  Download the latest release.
2.  Place the jar into your server's `plugins` folder.
3.  Restart the server.
4.  Configure settings as desired.
5.  Convert an Armor Stand into a Mob Stand.
6.  Enjoy automated mob management.

------------------------------------------------------------------------


# Contributors

### Big Pappa
Project Creator Founder of RSScripting

### Atlas
Architecture, Design & Development Support

------------------------------------------------------------------------

# Support
If you encounter a bug or have a feature request, please open an issue
in the GitHub repository.

------------------------------------------------------------------------

# License
This project is licensed under the MIT License.
See the LICENSE file for details.

------------------------------------------------------------------------