"Add complete documentation system"

Push

Tag ItemMagnet as complete
This commit is contained in:
BigPappa committed 2026-06-08 21:04:49 -05:00
1 parent 25ee54d3f8
commit 520d9941f7
12 files changed
+956 -9

No files matched your search

+126
View File
@@ -0,0 +1,126 @@
# Creating Your First ItemMagnet
This guide walks through creating and configuring your first RS-ItemMagnet.
---
# Step 1 - Place a Lodestone
Place a Lodestone where you want your ItemMagnet to operate.
The Lodestone will serve as the machine block for the ItemMagnet.
---
# Step 2 - Convert the Machine
Open the RS-ItemMagnet menu and select:
```text
Convert Machine
```
Click the Lodestone you placed.
The Lodestone is now an RS-ItemMagnet.
---
# Step 3 - Assign a Container
Open the machine menu.
Select:
```text
Assign Container
```
Then click the container you want the machine to use.
Supported containers include:
* Chests
* Barrels
* Hoppers
* Other supported inventory blocks
---
# Step 4 - Configure Radius
Open:
```text
Radius Settings
```
Select the collection radius you want the machine to use.
Larger radii allow collection from a larger area.
---
# Step 5 - Configure Filters (Optional)
Open:
```text
Filters
```
Configure which items should be accepted or rejected.
Filters allow ItemMagnets to specialize in collecting specific resources.
---
# Step 6 - Test Collection
Drop an item inside the configured radius.
The ItemMagnet should:
1. Detect the item
2. Attract the item
3. Deliver the item to the assigned container
---
# Ownership
The player who creates the ItemMagnet becomes its owner.
Only the owner (or authorized administrators) may:
* Modify settings
* Change filters
* Reassign containers
* Remove the machine
---
# Troubleshooting
If items are not being collected:
* Verify a container is assigned
* Verify the container has available space
* Verify filters allow the item
* Verify the item is within range
For additional help see:
[Troubleshooting](Troubleshooting.md)
---
# Next Step
Continue with:
[Radius Settings](Radius-Settings.md)
or
[Filters](Filters.md)