227 lines
5.3 KiB
Markdown
227 lines
5.3 KiB
Markdown
<p align="center">
|
|
<h1 align="center">RS-ItemMagnet</h1>
|
|
<p align="center">
|
|
Automated Item Collection for Modern Minecraft Servers
|
|
</p>
|
|
|
|
<p align="center">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
---
|
|
|
|
## Overview
|
|
|
|
**RS-ItemMagnet** is an automated item collection plugin designed for Minecraft servers that want reliable resource logistics without the complexity of traditional hopper-heavy collection systems.
|
|
|
|
Players place and configure ItemMagnets to automatically attract nearby dropped items and route them into a designated container while server owners maintain full control through configurable settings, filters, radius controls, permissions, and administrative tools.
|
|
|
|
Built from the ground up with performance, scalability, and long-term server operation in mind.
|
|
|
|
---
|
|
|
|
## Why RS-ItemMagnet?
|
|
|
|
Traditional collection systems often create:
|
|
|
|
* Excessive hopper usage
|
|
* Server lag
|
|
* Large item build-ups
|
|
* Complicated item transport systems
|
|
* Difficult maintenance and troubleshooting
|
|
|
|
RS-ItemMagnet replaces those systems with a clean, configurable, database-backed solution that is easy for players to use and easy for administrators to manage.
|
|
|
|
---
|
|
|
|
## Documentation
|
|
|
|
- [Documentation](docs/index.md)
|
|
- [Installation](docs/installation.md)
|
|
- [Usage](docs/usage.md)
|
|
- [Configuration](docs/configuration.md)
|
|
- [Commands](docs/commands.md)
|
|
- [Permissions](docs/permissions.md)
|
|
- [Troubleshooting](docs/troubleshooting.md)
|
|
|
|
# Features
|
|
|
|
### Automated Item Collection
|
|
|
|
Automatically attract nearby dropped items.
|
|
|
|
### Dynamic GUI Menus
|
|
|
|
Simple and intuitive inventory-based interfaces.
|
|
|
|
### Advanced Item Filtering
|
|
|
|
Control exactly which items are accepted by each ItemMagnet.
|
|
|
|
### Radius Controls
|
|
|
|
Configure collection range to fit your automation needs.
|
|
|
|
### Target Containers
|
|
|
|
Assign and reassign collection containers at any time.
|
|
|
|
### Capacity-Aware Collection
|
|
|
|
Avoid unnecessary item acquisition when storage becomes unavailable.
|
|
|
|
### 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.
|
|
|
|
---
|
|
|
|
# RS Ecosystem
|
|
|
|
RS-ItemMagnet is the collection and routing 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
|
|
|
|
<img width="346" height="131" alt="27b8e481-1df0-465c-8fa1-2530636fa19f" src="https://github.com/user-attachments/assets/7446e87e-a77e-466f-8177-98c18b572011" />
|
|
>
|
|
|
|
### Filter Menu
|
|
|
|
<img width="349" height="267" alt="cde741b8-51ce-4915-9919-1442c2fb1020" src="https://github.com/user-attachments/assets/8169f346-91f3-403b-bc2e-0cb82c40c0d8" />
|
|
|
|
### Radius Configuration
|
|
|
|
<img width="349" height="131" alt="1f0d7b5f-5155-4af4-88f4-cd20e4ad9ca6" src="https://github.com/user-attachments/assets/9c2583a1-15b5-4dc5-a9f6-af627e16f790" />
|
|
|
|
---
|
|
|
|
# Permissions
|
|
|
|
| Permission | Description |
|
|
| --------------------- | ------------------------- |
|
|
| `rs.itemmagnet.use` | Allows use of ItemMagnets |
|
|
| `rs.itemmagnet.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 item collection.
|
|
|
|
---
|
|
|
|
# Performance
|
|
|
|
RS-ItemMagnet was designed with long-term server operation in mind.
|
|
|
|
Features include:
|
|
|
|
* SQLite persistence
|
|
* Chunk-safe processing
|
|
* Efficient task management
|
|
* Capacity-aware acquisition
|
|
* Optimized item handling
|
|
* Minimal server overhead
|
|
|
|
---
|
|
|
|
# Development Status
|
|
|
|
| Component | Status |
|
|
| -------------------- | ---------- |
|
|
| Core System | ✅ Complete |
|
|
| GUI System | ✅ Complete |
|
|
| SQLite Storage | ✅ Complete |
|
|
| Filter System | ✅ Complete |
|
|
| Administrative Tools | ✅ Complete |
|
|
| Optimization | ✅ Complete |
|
|
| Public Release | ✅ Public |
|
|
|
|
---
|
|
|
|
# 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 project repository.
|
|
|
|
---
|
|
|
|
# License
|
|
|
|
MIT License
|
|
|
|
See the LICENSE file for details.
|
|
|
|
---
|
|
|
|
<p align="center">
|
|
Built by RSScripting
|
|
</p>
|
|
|
|
<p align="center">
|
|
Generate • Collect • Transport • Store
|
|
</p>
|