Update README

This commit is contained in:
russelburgraymond authored and GitHub committed 2026-06-07 12:20:27 -05:00
1 parent 0339e1e1ed
commit 3a2df4b8ea
1 file changed
+179 -40
+179 -40
View File
@@ -1,86 +1,225 @@
# RS-MobStand
<p align="center">
<h1 align="center">RS-MobStand</h1>
<p align="center">
Automated Mob Farming for Modern Minecraft Servers
</p>
</p>
> Automated mob farming for modern Minecraft servers.
<p align="center">
Part of the RS Ecosystem by RSScripting.
![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-SQLite-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)
</p>
---
## Overview
RS-MobStand allows players to generate mob drops through configurable Mob Stands without the need for traditional mob grinders.
**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.
Built with performance, scalability, and automation in mind, RS-MobStand serves as the resource generation layer of the RS Ecosystem.
Players place and configure Mob Stands to generate mob drops while server owners maintain full control through configurable settings, permissions, filters, upgrades, and administrative tools.
Built from the ground up with performance, scalability, and long-term server operation in mind.
---
## Ecosystem Flow
## Why RS-MobStand?
RS-MobStand
↓
RS-ItemMagnet
↓
RS-Auger
↓
RS-Warehouse
Traditional mob farms often create:
Generate → Collect → Transport → Store
- Excessive entity counts
- Server lag
- Chunk-loading issues
- Complex redstone systems
- Difficult balancing
RS-MobStand replaces those systems with a clean, configurable, database-backed solution that is easy for players to use and easy for administrators to manage.
---
## Features
# Features
✔ Automated mob drop generation
### Automated Mob Farming
✔ Adult and baby mob filters
Generate mob drops without traditional mob grinders.
✔ Radius controls
### Dynamic GUI Menus
✔ Leave Alive options
Simple and intuitive inventory-based interfaces.
✔ Dynamic GUI menus
### Advanced Filtering
✔ SQLite persistence
Control mob behavior with configurable options.
✔ Chunk-safe operation
### Radius Controls
✔ Performance-focused design
Fine-tune stand operation and efficiency.
✔ RS ecosystem integration
### Leave Alive Support
Maintain mobs while still controlling automation.
### SQLite Storage
Reliable persistent data storage.
### 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.
---
## Screenshots
# 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*
---
## Project Status
# Commands
🚧 Active Development
Current Repository Status:
- Stable
- Private
- Under active development
| Command | Description |
|----------|-------------|
| `/rsms` | Open the Mob Stand menu |
| `/rsms admin` | Open administrative controls |
---
## Contributors
# Permissions
| Permission | Description |
|------------|-------------|
| `rs.mobstand.use` | Allows use of Mob Stands |
| `rs.mobstand.admin` | Administrative access |
---
# 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. Enjoy automated mob farming.
---
# Performance
RS-MobStand was designed with long-term server operation in mind.
Features include:
- SQLite persistence
- Chunk-safe processing
- Efficient task management
- Optimized stand handling
- Minimal entity overhead
---
# Development Status
| Component | Status |
|------------|---------|
| Core System | ✅ Complete |
| GUI System | ✅ Complete |
| SQLite Storage | ✅ Complete |
| Administrative Tools | ✅ Complete |
| Optimization | ✅ Complete |
| Public Release | 🚧 Pending |
---
# Contributors
### Big Pappa
Project Creator
Founder of RSScripting
### Atlas
Architecture, Design, Development Support
Architecture, Design & Development Support
---
## Future RS Ecosystem
# Support
- RS-MobStand
- RS-ItemMagnet
- RS-Auger
- RS-Warehouse
- RS-PluginTemplate
If you encounter a bug or have a feature request, please open an issue in the GitHub repository.
---
# License
Copyright © 2026 RSScripting
All rights reserved.
This project may not be copied, modified, redistributed, or sold without explicit written permission from RSScripting.
---
<p align="center">
Built by RSScripting
</p>
<p align="center">
Generate • Collect • Transport • Store
</p>