1.2.0
Docs Update
This commit is contained in:
BigPappa committed
1 parent
ffd84d2bfa
commit
1548a4c983
1 file changed
+131
-71
@@ -1,12 +1,23 @@
|
||||
```{=html}
|
||||
<p align="center">
|
||||
<h1 align="center">RS-MobStand</h1>
|
||||
<p align="center">
|
||||
Automated Mob Farming for Modern Minecraft Servers
|
||||
</p>
|
||||
|
||||
|
||||
```
|
||||
```{=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">
|
||||
```
|
||||
|
||||
|
||||
|
||||
@@ -15,49 +26,57 @@
|
||||
|
||||
|
||||
|
||||
```{=html}
|
||||
</p>
|
||||
```
|
||||
|
||||
---
|
||||
------------------------------------------------------------------------
|
||||
|
||||
## Overview
|
||||
|
||||
**RS-MobStand** is a powerful automated mob farming plugin designed for Minecraft servers that want reliable resource generation without the performance impact of traditional mob farms.
|
||||
**RS-MobStand** is a powerful automated mob farming plugin designed for
|
||||
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 intuitive GUI menus while server owners maintain full control through configurable settings, permissions, filters, and administrative tools.
|
||||
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.
|
||||
|
||||
Built from the ground up with performance, scalability, and long-term server operation in mind.
|
||||
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
|
||||
- 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.
|
||||
RS-MobStand replaces those systems with a clean, configurable solution
|
||||
that is easy for players to use and easy for administrators to manage.
|
||||
|
||||
---
|
||||
------------------------------------------------------------------------
|
||||
|
||||
## Documentation
|
||||
|
||||
See the complete documentation:
|
||||
|
||||
- [Home](docs/Home.md)
|
||||
- [Installation](docs/Installation.md)
|
||||
- [Creating Your First ItemMagnet](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)
|
||||
- [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
|
||||
|
||||
@@ -75,11 +94,40 @@ Configure which mobs are affected by each Mob Stand.
|
||||
|
||||
### Radius Controls
|
||||
|
||||
Fine-tune stand operation and efficiency.
|
||||
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.
|
||||
Maintain a configurable number of mobs while still automating
|
||||
management.
|
||||
|
||||
### 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
|
||||
|
||||
@@ -89,6 +137,11 @@ Reliable persistent storage that survives server restarts.
|
||||
|
||||
Protect Mob Stands from unauthorized access.
|
||||
|
||||
### Vanilla Conversion
|
||||
|
||||
Mob Stands can be converted back into standard vanilla Armor Stands,
|
||||
removing the RS-MobStand functionality.
|
||||
|
||||
### Chunk-Safe Design
|
||||
|
||||
Built to behave correctly across chunk loads and unloads.
|
||||
@@ -101,13 +154,14 @@ Designed to minimize server impact while maximizing functionality.
|
||||
|
||||
Powerful management tools for staff and server operators.
|
||||
|
||||
---
|
||||
------------------------------------------------------------------------
|
||||
|
||||
# RS Ecosystem
|
||||
|
||||
RS-MobStand is the resource generation component of the growing **RS Ecosystem**.
|
||||
RS-MobStand is the resource generation component of the growing **RS
|
||||
Ecosystem**.
|
||||
|
||||
```text
|
||||
``` text
|
||||
┌─────────────┐
|
||||
│ RS-MobStand │
|
||||
└──────┬──────┘
|
||||
@@ -129,9 +183,10 @@ RS-MobStand is the resource generation component of the growing **RS Ecosystem**
|
||||
Store
|
||||
```
|
||||
|
||||
Together these plugins create a complete automated resource collection and logistics system.
|
||||
Together these plugins create a complete automated resource collection
|
||||
and logistics system.
|
||||
|
||||
---
|
||||
------------------------------------------------------------------------
|
||||
|
||||
# Screenshots
|
||||
|
||||
@@ -151,18 +206,18 @@ Together these plugins create a complete automated resource collection and logis
|
||||
|
||||
*Coming Soon*
|
||||
|
||||
---
|
||||
------------------------------------------------------------------------
|
||||
|
||||
# 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.
|
||||
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.
|
||||
|
||||
---
|
||||
------------------------------------------------------------------------
|
||||
|
||||
# Performance
|
||||
|
||||
@@ -170,47 +225,45 @@ 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
|
||||
- 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 |
|
||||
Component Status
|
||||
---------------------- -------------
|
||||
Core System ✅ Complete
|
||||
GUI System ✅ Complete
|
||||
YAML Storage ✅ Complete
|
||||
Administrative Tools ✅ Complete
|
||||
Optimization ✅ Complete
|
||||
Public Release 🚧 Pending
|
||||
|
||||
---
|
||||
------------------------------------------------------------------------
|
||||
|
||||
# Contributors
|
||||
|
||||
### Big Pappa
|
||||
|
||||
Project Creator
|
||||
Founder of RSScripting
|
||||
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.
|
||||
If you encounter a bug or have a feature request, please open an issue
|
||||
in the GitHub repository.
|
||||
|
||||
---
|
||||
|
||||
# License
|
||||
------------------------------------------------------------------------
|
||||
|
||||
# License
|
||||
|
||||
@@ -218,12 +271,19 @@ This project is licensed under the MIT License.
|
||||
|
||||
See the LICENSE file for details.
|
||||
|
||||
---
|
||||
------------------------------------------------------------------------
|
||||
|
||||
```{=html}
|
||||
<p align="center">
|
||||
Built by RSScripting
|
||||
```
|
||||
Built by RSScripting
|
||||
```{=html}
|
||||
</p>
|
||||
|
||||
```
|
||||
```{=html}
|
||||
<p align="center">
|
||||
Generate • Collect • Transport • Store
|
||||
```
|
||||
Generate • Collect • Transport • Store
|
||||
```{=html}
|
||||
</p>
|
||||
```
|
||||
Reference in new issue
Block a user