1.2.0
Docs Update
This commit is contained in:
BigPappa committed
1 parent
ffd84d2bfa
commit
1548a4c983
1 file changed
+115
-55
@@ -1,12 +1,23 @@
|
|||||||
|
```{=html}
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<h1 align="center">RS-MobStand</h1>
|
```
|
||||||
<p align="center">
|
```{=html}
|
||||||
Automated Mob Farming for Modern Minecraft Servers
|
<h1 align="center">
|
||||||
</p>
|
```
|
||||||
|
RS-MobStand
|
||||||
|
```{=html}
|
||||||
|
</h1>
|
||||||
|
```
|
||||||
|
```{=html}
|
||||||
<p align="center">
|
<p align="center">
|
||||||
|
```
|
||||||
|
Automated Mob Farming for Modern Minecraft Servers
|
||||||
|
```{=html}
|
||||||
|
</p>
|
||||||
|
```
|
||||||
|
```{=html}
|
||||||
|
<p align="center">
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -15,33 +26,41 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
```{=html}
|
||||||
</p>
|
</p>
|
||||||
|
```
|
||||||
|
|
||||||
---
|
------------------------------------------------------------------------
|
||||||
|
|
||||||
## Overview
|
## 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?
|
## Why RS-MobStand?
|
||||||
|
|
||||||
Traditional mob farms often create:
|
Traditional mob farms often create:
|
||||||
|
|
||||||
* Excessive entity counts
|
- Excessive entity counts
|
||||||
* Server lag
|
- Server lag
|
||||||
* Chunk-loading issues
|
- Chunk-loading issues
|
||||||
* Complex redstone systems
|
- Complex redstone systems
|
||||||
* Difficult balancing
|
- 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
|
## Documentation
|
||||||
|
|
||||||
@@ -49,7 +68,7 @@ See the complete documentation:
|
|||||||
|
|
||||||
- [Home](docs/Home.md)
|
- [Home](docs/Home.md)
|
||||||
- [Installation](docs/Installation.md)
|
- [Installation](docs/Installation.md)
|
||||||
- [Creating Your First ItemMagnet](docs/Creating-Your-First-MobStand.md)
|
- [Creating Your First MobStand](docs/Creating-Your-First-MobStand.md)
|
||||||
- [Filters](docs/Filters.md)
|
- [Filters](docs/Filters.md)
|
||||||
- [Radius Settings](docs/Radius-Settings.md)
|
- [Radius Settings](docs/Radius-Settings.md)
|
||||||
- [Pause and Resume](docs/Pause-and-Resume.md)
|
- [Pause and Resume](docs/Pause-and-Resume.md)
|
||||||
@@ -75,11 +94,40 @@ Configure which mobs are affected by each Mob Stand.
|
|||||||
|
|
||||||
### Radius Controls
|
### 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
|
### 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
|
### YAML Storage
|
||||||
|
|
||||||
@@ -89,6 +137,11 @@ Reliable persistent storage that survives server restarts.
|
|||||||
|
|
||||||
Protect Mob Stands from unauthorized access.
|
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
|
### Chunk-Safe Design
|
||||||
|
|
||||||
Built to behave correctly across chunk loads and unloads.
|
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.
|
Powerful management tools for staff and server operators.
|
||||||
|
|
||||||
---
|
------------------------------------------------------------------------
|
||||||
|
|
||||||
# RS Ecosystem
|
# 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 │
|
│ RS-MobStand │
|
||||||
└──────┬──────┘
|
└──────┬──────┘
|
||||||
@@ -129,9 +183,10 @@ RS-MobStand is the resource generation component of the growing **RS Ecosystem**
|
|||||||
Store
|
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
|
# Screenshots
|
||||||
|
|
||||||
@@ -151,7 +206,7 @@ Together these plugins create a complete automated resource collection and logis
|
|||||||
|
|
||||||
*Coming Soon*
|
*Coming Soon*
|
||||||
|
|
||||||
---
|
------------------------------------------------------------------------
|
||||||
|
|
||||||
# Installation
|
# Installation
|
||||||
|
|
||||||
@@ -162,7 +217,7 @@ Together these plugins create a complete automated resource collection and logis
|
|||||||
5. Convert an Armor Stand into a Mob Stand.
|
5. Convert an Armor Stand into a Mob Stand.
|
||||||
6. Enjoy automated mob management.
|
6. Enjoy automated mob management.
|
||||||
|
|
||||||
---
|
------------------------------------------------------------------------
|
||||||
|
|
||||||
# Performance
|
# Performance
|
||||||
|
|
||||||
@@ -170,47 +225,45 @@ RS-MobStand was designed with long-term server operation in mind.
|
|||||||
|
|
||||||
Features include:
|
Features include:
|
||||||
|
|
||||||
* YAML persistence
|
- YAML persistence
|
||||||
* Chunk-safe processing
|
- Chunk-safe processing
|
||||||
* Efficient task management
|
- Efficient task management
|
||||||
* Optimized stand handling
|
- Optimized stand handling
|
||||||
* Minimal server overhead
|
- Minimal server overhead
|
||||||
|
|
||||||
---
|
------------------------------------------------------------------------
|
||||||
|
|
||||||
# Development Status
|
# Development Status
|
||||||
|
|
||||||
| Component | Status |
|
Component Status
|
||||||
| -------------------- | ---------- |
|
---------------------- -------------
|
||||||
| Core System | ✅ Complete |
|
Core System ✅ Complete
|
||||||
| GUI System | ✅ Complete |
|
GUI System ✅ Complete
|
||||||
| YAML Storage | ✅ Complete |
|
YAML Storage ✅ Complete
|
||||||
| Administrative Tools | ✅ Complete |
|
Administrative Tools ✅ Complete
|
||||||
| Optimization | ✅ Complete |
|
Optimization ✅ Complete
|
||||||
| Public Release | 🚧 Pending |
|
Public Release 🚧 Pending
|
||||||
|
|
||||||
---
|
------------------------------------------------------------------------
|
||||||
|
|
||||||
# Contributors
|
# Contributors
|
||||||
|
|
||||||
### Big Pappa
|
### Big Pappa
|
||||||
|
|
||||||
Project Creator
|
Project Creator Founder of RSScripting
|
||||||
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 in the GitHub repository.
|
If you encounter a bug or have a feature request, please open an issue
|
||||||
|
in the GitHub repository.
|
||||||
|
|
||||||
---
|
------------------------------------------------------------------------
|
||||||
|
|
||||||
# License
|
|
||||||
|
|
||||||
# License
|
# License
|
||||||
|
|
||||||
@@ -218,12 +271,19 @@ This project is licensed under the MIT License.
|
|||||||
|
|
||||||
See the LICENSE file for details.
|
See the LICENSE file for details.
|
||||||
|
|
||||||
---
|
------------------------------------------------------------------------
|
||||||
|
|
||||||
|
```{=html}
|
||||||
<p align="center">
|
<p align="center">
|
||||||
Built by RSScripting
|
```
|
||||||
|
Built by RSScripting
|
||||||
|
```{=html}
|
||||||
</p>
|
</p>
|
||||||
|
```
|
||||||
|
```{=html}
|
||||||
<p align="center">
|
<p align="center">
|
||||||
Generate • Collect • Transport • Store
|
```
|
||||||
|
Generate • Collect • Transport • Store
|
||||||
|
```{=html}
|
||||||
</p>
|
</p>
|
||||||
|
```
|
||||||
Reference in new issue
Block a user