Documentation Update
This commit is contained in:
BigPappa committed 2026-08-09 07:02:36 -05:00
1 parent 943ba9a53b
commit ef41c1c34f
1 file changed
+11 -23
@@ -28,7 +28,7 @@ title. Green wool adds to the deposit amount, Red wool will subtract from it.
Once you have the desired amount set, click the item in the center of the wool. Once you have the desired amount set, click the item in the center of the wool.
📷 Screenshot 📷 Screenshot
![TransactionMenu.png](../images/TransactionMenu.png)
> **NOTE:** Variant items such as damaged, enchanted, and partially filled items have their own transaction menus and are handled separately from the primary item. > **NOTE:** Variant items such as damaged, enchanted, and partially filled items have their own transaction menus and are handled separately from the primary item.
@@ -43,21 +43,25 @@ Each player has their own Auto-Deposit filter.
When Auto-Deposit is enabled and you pick up an item that matches one of the items in your filter, RS-Warehouse sends the item directly to the Warehouse instead of placing it into your inventory. When Auto-Deposit is enabled and you pick up an item that matches one of the items in your filter, RS-Warehouse sends the item directly to the Warehouse instead of placing it into your inventory.
📷 Screenshot
### Adding Items to the Auto-Deposit Filter ### Adding Items to the Auto-Deposit Filter
Open the **Auto-Deposit** menu from the Warehouse. Open the **Auto-Deposit** menu from the Warehouse. This is the _Hopper_ on the _Main Category Menu_
Place an item into the Auto-Deposit menu to add it to your personal filter. Place an item into the Auto-Deposit menu to add it to your personal filter.
The item placed into the filter is used as a copy of the item you want to automatically deposit. The item placed into the filter is used as a copy of the item you want to automatically deposit.
Ensure the _Dye_ is green.
Once you close the menu, any item you pick up wil automatically go into the warehouse.
📷 Screenshot 📷 Screenshot
![AutoDeposit.png](../images/AutoDeposit.png)
> **NOTE:** Adding an item to the Auto-Deposit filter does not remove that item from your inventory. > **NOTE:** Adding an item to the Auto-Deposit filter does not remove that item from your inventory.
For more information, see **[Auto-Deposit](...)**. For more information, see **[Auto-Deposit](../50%29%20Side%20Pages/Auto-Deposit.md)**.
--- ---
@@ -67,9 +71,7 @@ A **Warehouse Chest** can automatically process its contents at regular interval
The processing interval is controlled by the server's `config.yml`. The processing interval is controlled by the server's `config.yml`.
The configured interval determines how often RS-Warehouse checks the Warehouse Chest for items to deposit. The configured interval determines how often RS-Warehouse checks the Warehouse Chest for items to deposit and deposits all contents.
📷 Screenshot
> **NOTE:** The automatic processing interval is controlled by the server configuration and may be different on your server. > **NOTE:** The automatic processing interval is controlled by the server configuration and may be different on your server.
@@ -81,8 +83,6 @@ A **Warehouse Chest** can also process its contents when the chest is closed.
When this option is enabled, RS-Warehouse processes the items in the Warehouse Chest when the player closes the chest. When this option is enabled, RS-Warehouse processes the items in the Warehouse Chest when the player closes the chest.
📷 Screenshot
This allows items to be deposited without waiting for the next automatic processing interval. This allows items to be deposited without waiting for the next automatic processing interval.
> **NOTE:** Chest-close processing and automatic timed processing are separate options controlled by the server configuration. > **NOTE:** Chest-close processing and automatic timed processing are separate options controlled by the server configuration.
@@ -95,14 +95,10 @@ Items can also be deposited using the **`/shop deposit`** command.
This command opens the **Warehouse Deposit** inventory. This command opens the **Warehouse Deposit** inventory.
📷 Screenshot
Place the items you want to deposit into the inventory. Place the items you want to deposit into the inventory.
When the inventory is closed, RS-Warehouse processes the items and adds them to the Warehouse. When the inventory is closed, RS-Warehouse processes the items and adds them to the Warehouse.
📷 Screenshot
> **NOTE:** The `/shop deposit` command provides a convenient way to access the Warehouse Deposit inventory without navigating through the Warehouse menus. > **NOTE:** The `/shop deposit` command provides a convenient way to access the Warehouse Deposit inventory without navigating through the Warehouse menus.
--- ---
@@ -113,7 +109,7 @@ Items that have not yet been assigned to a category can still be deposited.
Depending on the server configuration, newly discovered items may be placed into the **Unassigned** category. Depending on the server configuration, newly discovered items may be placed into the **Unassigned** category.
For more information, see **[The Unassigned Category](...)**. For more information, see **[UnCategorized Category](../50%29%20Side%20Pages/UnCategorized%20Category.md)**.
--- ---
@@ -128,11 +124,3 @@ Each deposit method is useful in different situations.
| **Warehouse Chest — Automatic Processing** | Farms and storage systems that continuously feed a Warehouse Chest | | **Warehouse Chest — Automatic Processing** | Farms and storage systems that continuously feed a Warehouse Chest |
| **Warehouse Chest — On Chest Close** | Manually placing items into a Warehouse Chest | | **Warehouse Chest — On Chest Close** | Manually placing items into a Warehouse Chest |
| **`/shop deposit`** | Quickly depositing items through a dedicated inventory | | **`/shop deposit`** | Quickly depositing items through a dedicated inventory |
---
## Finished
RS-Warehouse provides several ways to get items into the Warehouse.
Choose the method that best fits how you collect and store items on your server.