93 lines
1.8 KiB
Markdown
93 lines
1.8 KiB
Markdown
# RS-ItemMagnet Documentation
|
|
|
|
Welcome to the official RS-ItemMagnet documentation.
|
|
|
|
RS-ItemMagnet is an automated item collection plugin for Paper Minecraft servers. It allows players to create ItemMagnets that collect dropped items and deliver them directly into designated storage containers.
|
|
|
|
Built for performance, reliability, multiplayer compatibility, and long-term server operation.
|
|
|
|
---
|
|
|
|
# Features
|
|
|
|
* Automated item collection
|
|
* Configurable collection radius
|
|
* Advanced item filtering
|
|
* Container assignment and reassignment
|
|
* Ownership protection
|
|
* Pause and resume controls
|
|
* SQLite persistence
|
|
* Chunk-safe operation
|
|
* Multiplayer support
|
|
* Administrative controls
|
|
|
|
---
|
|
|
|
# Quick Start
|
|
|
|
1. Place a Lodestone.
|
|
2. Convert it into an RS-ItemMagnet.
|
|
3. Assign a target container.
|
|
4. Configure radius and filters.
|
|
5. Drop items within range.
|
|
6. Watch items get collected automatically.
|
|
|
|
---
|
|
|
|
# Documentation Index
|
|
|
|
## Getting Started
|
|
|
|
* [Installation](Installation.md)
|
|
* [Creating Your First ItemMagnet](Creating-Your-First-ItemMagnet.md)
|
|
|
|
## Player Guide
|
|
|
|
* [Filters](Filters.md)
|
|
* [Radius Settings](Radius-Settings.md)
|
|
* [Pause and Resume](Pause-and-Resume.md)
|
|
|
|
## Administration
|
|
|
|
* [Admin Guide](Admin-Guide.md)
|
|
* [Troubleshooting](Troubleshooting.md)
|
|
|
|
## Technical Information
|
|
|
|
* [Storage and Persistence](Storage-and-Persistence.md)
|
|
* [Changelog](Changelog.md)
|
|
|
|
---
|
|
|
|
# RS Ecosystem
|
|
|
|
RS-ItemMagnet is part of the 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.
|
|
|
|
---
|
|
|
|
# Support
|
|
|
|
If you encounter a bug or have a feature request, please open an issue in the GitHub repository.
|
|
|
|
---
|
|
|
|
Built by RSScripting
|
|
|
|
Big Pappa • Atlas
|