Commit:
Moving DOCS to Wiki
This commit is contained in:
BigPappa committed
1 parent
eeed950ceb
commit
8743ffa85c
1 file changed
+228
@@ -0,0 +1,228 @@
|
|||||||
|
<p align="center">
|
||||||
|
<h1 align="center">RS-MobStand</h1>
|
||||||
|
<p align="center">
|
||||||
|
Automated Mob Farming for Modern Minecraft Servers
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</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.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
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)
|
||||||
|
|
||||||
|
# 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.
|
||||||
|
|
||||||
|
### Leave Alive Support
|
||||||
|
|
||||||
|
Maintain a configurable number of mobs while still automating management.
|
||||||
|
|
||||||
|
### YAML Storage
|
||||||
|
|
||||||
|
Reliable persistent storage that survives server restarts.
|
||||||
|
|
||||||
|
### Armor Stand Ownership
|
||||||
|
|
||||||
|
Protect Mob Stands from unauthorized access.
|
||||||
|
|
||||||
|
### Chunk-Safe Design
|
||||||
|
|
||||||
|
Built to behave correctly across chunk loads and unloads.
|
||||||
|
|
||||||
|
### Performance Focused
|
||||||
|
|
||||||
|
Designed to minimize server impact while maximizing functionality.
|
||||||
|
|
||||||
|
### Administrative Tools
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
### 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
|
||||||
|
|
||||||
|
# License
|
||||||
|
|
||||||
|
This project is licensed under the MIT License.
|
||||||
|
|
||||||
|
See the LICENSE file for details.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
Built by RSScripting
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
Generate • Collect • Transport • Store
|
||||||
|
</p>
|
||||||
Reference in new issue
Block a user