Docs Update
This commit is contained in:
BigPappa committed 2026-09-03 02:05:10 -05:00
1 parent 1548a4c983
commit a953452d33
1 file changed
+5 -164
+5 -164
View File
@@ -1,24 +1,7 @@
```{=html} # RS-MobStand
<p align="center">
``` **Automated Mob Farming for Modern Minecraft Servers**
```{=html}
<h1 align="center">
```
RS-MobStand
```{=html}
</h1>
```
```{=html}
<p align="center">
```
Automated Mob Farming for Modern Minecraft Servers
```{=html}
</p>
```
```{=html}
<p align="center">
```
![Version](https://img.shields.io/badge/version-1.0.4-blue)
![Minecraft](https://img.shields.io/badge/Minecraft-1.21%2B-green) ![Minecraft](https://img.shields.io/badge/Minecraft-1.21%2B-green)
![Platform](https://img.shields.io/badge/Platform-Paper-orange) ![Platform](https://img.shields.io/badge/Platform-Paper-orange)
![Storage](https://img.shields.io/badge/Storage-YAML-blue) ![Storage](https://img.shields.io/badge/Storage-YAML-blue)
@@ -26,40 +9,16 @@ Automated Mob Farming for Modern Minecraft Servers
![Development](https://img.shields.io/badge/Development-Active-brightgreen) ![Development](https://img.shields.io/badge/Development-Active-brightgreen)
![RS Ecosystem](https://img.shields.io/badge/RS-Ecosystem-purple) ![RS Ecosystem](https://img.shields.io/badge/RS-Ecosystem-purple)
```{=html}
</p>
```
------------------------------------------------------------------------ ------------------------------------------------------------------------
## Overview ## Overview
**RS-MobStand** is a powerful automated mob farming plugin designed for **RS-MobStand** is a powerful automated mob killing plugin.
Minecraft servers that want reliable resource generation without the
performance impact of traditional mob farms.
Players convert Armor Stands into Mob Stands and configure them through Players convert Armor Stands into Mob Stands and configure them through
intuitive GUI menus while server owners maintain full control through intuitive GUI menus while server owners maintain full control through
configurable settings, permissions, filters, and administrative tools. configurable settings, permissions, filters, and administrative tools.
Built from the ground up with performance, scalability, and long-term
server operation in mind.
------------------------------------------------------------------------
## Why RS-MobStand?
Traditional mob farms often create:
- Excessive entity counts
- Server lag
- Chunk-loading issues
- Complex redstone systems
- Difficult balancing
RS-MobStand replaces those systems with a clean, configurable solution
that is easy for players to use and easy for administrators to manage.
------------------------------------------------------------------------ ------------------------------------------------------------------------
## Documentation ## Documentation
@@ -81,74 +40,54 @@ See the complete documentation:
# Features # Features
### Automated Mob Farming ### Automated Mob Farming
Manage nearby mobs without traditional mob grinders. Manage nearby mobs without traditional mob grinders.
### Dynamic GUI Menus ### Dynamic GUI Menus
Simple and intuitive inventory-based interfaces. Simple and intuitive inventory-based interfaces.
### Adult & Baby Filters ### Adult & Baby Filters
Configure which mobs are affected by each Mob Stand. Configure which mobs are affected by each Mob Stand.
### Radius Controls ### Radius Controls
Fine-tune stand operation and efficiency. Mob Stands scan within the Fine-tune stand operation and efficiency. Mob Stands scan within the
configured horizontal radius and only 2 blocks above and 2 blocks below configured horizontal radius and only 2 blocks above and 2 blocks below
the stand's base level. the stand's base level.
### View Radius ### View Radius
Visualize the configured Mob Stand scan area in-world with a temporary Visualize the configured Mob Stand scan area in-world with a temporary
particle outline visible only to the player who activates it. particle outline visible only to the player who activates it.
### Leave Alive Support ### Leave Alive Support
Maintain a configurable number of mobs while still automating Maintain a configurable number of mobs while still automating
management. management.
### Individual Arm Poses ### Individual Arm Poses
When arms are enabled, configure the Main Hand and Off Hand When arms are enabled, configure the Main Hand and Off Hand
independently with five available poses: Down, 1/4 Down, Straight Out, independently with five available poses: Down, 1/4 Down, Straight Out,
1/4 Up, and Straight Up. 1/4 Up, and Straight Up.
### Display Name Control ### Display Name Control
Show or hide the Mob Stand's in-world display name directly from the Mob Show or hide the Mob Stand's in-world display name directly from the Mob
Stand menu. Stand menu.
### Paused on Conversion ### Paused on Conversion
Newly converted Mob Stands start paused, allowing their settings to be Newly converted Mob Stands start paused, allowing their settings to be
configured before automated mob management begins. configured before automated mob management begins.
### Mob Whitelists ### Mob Whitelists
Adult and Baby mob filters act as whitelists. A mob must be configured 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. for the appropriate age category before a Mob Stand will affect it.
### YAML Storage ### YAML Storage
Reliable persistent storage that survives server restarts. Reliable persistent storage that survives server restarts.
### Armor Stand Ownership ### Armor Stand Ownership
Protect Mob Stands from unauthorized access. Protect Mob Stands from unauthorized access.
### Vanilla Conversion ### Vanilla Conversion
Mob Stands can be converted back into standard vanilla Armor Stands, Mob Stands can be converted back into standard vanilla Armor Stands,
removing the RS-MobStand functionality. removing the RS-MobStand functionality.
### Chunk-Safe Design
Built to behave correctly across chunk loads and unloads.
### Performance Focused
Designed to minimize server impact while maximizing functionality.
### Administrative Tools ### Administrative Tools
@@ -156,58 +95,6 @@ Powerful management tools for staff and server operators.
------------------------------------------------------------------------ ------------------------------------------------------------------------
# RS Ecosystem
RS-MobStand is the resource generation component of the growing **RS
Ecosystem**.
``` text
┌─────────────┐
│ RS-MobStand │
└──────┬──────┘
│ Generate
▼
┌──────────────┐
│ RS-ItemMagnet│
└──────┬───────┘
│ Collect
▼
┌───────────┐
│ RS-Auger │
└─────┬─────┘
│ Transport
▼
┌─────────────┐
│ RS-Warehouse│
└─────────────┘
Store
```
Together these plugins create a complete automated resource collection
and logistics system.
------------------------------------------------------------------------
# Screenshots
### Main Menu
*Coming Soon*
### Mob Stand Interface
*Coming Soon*
### Administrative Menu
*Coming Soon*
### In-World Mob Stand
*Coming Soon*
------------------------------------------------------------------------
# Installation # Installation
1. Download the latest release. 1. Download the latest release.
@@ -219,71 +106,25 @@ and logistics system.
------------------------------------------------------------------------ ------------------------------------------------------------------------
# Performance
RS-MobStand was designed with long-term server operation in mind.
Features include:
- YAML persistence
- Chunk-safe processing
- Efficient task management
- Optimized stand handling
- Minimal server overhead
------------------------------------------------------------------------
# Development Status
Component Status
---------------------- -------------
Core System ✅ Complete
GUI System ✅ Complete
YAML Storage ✅ Complete
Administrative Tools ✅ Complete
Optimization ✅ Complete
Public Release 🚧 Pending
------------------------------------------------------------------------
# Contributors # Contributors
### Big Pappa ### Big Pappa
Project Creator Founder of RSScripting Project Creator Founder of RSScripting
### Atlas ### Atlas
Architecture, Design & Development Support Architecture, Design & Development Support
------------------------------------------------------------------------ ------------------------------------------------------------------------
# Support # Support
If you encounter a bug or have a feature request, please open an issue If you encounter a bug or have a feature request, please open an issue
in the GitHub repository. in the GitHub repository.
------------------------------------------------------------------------ ------------------------------------------------------------------------
# License # License
This project is licensed under the MIT License. This project is licensed under the MIT License.
See the LICENSE file for details. See the LICENSE file for details.
------------------------------------------------------------------------ ------------------------------------------------------------------------
```{=html}
<p align="center">
```
Built by RSScripting
```{=html}
</p>
```
```{=html}
<p align="center">
```
Generate • Collect • Transport • Store
```{=html}
</p>
```