1.5.0
Docs update
This commit is contained in:
BigPappa committed
1 parent
8f02e44191
commit
15aead2b5a
5 files changed
+29
-46
No files matched your search
@@ -0,0 +1,110 @@
|
||||
# Depositing Items
|
||||
|
||||
RS-Warehouse provides several ways to deposit items into the Warehouse.
|
||||
|
||||
Items can be deposited using:
|
||||
|
||||
1. **Transaction Menu**
|
||||
2. **Auto-Deposit**
|
||||
3. **Warehouse Chest — Automatic Processing**
|
||||
4. **Warehouse Chest — On Chest Close**
|
||||
5. **Command — `/shop deposit`**
|
||||
|
||||
Each method ultimately adds the deposited items to the shared Warehouse inventory.
|
||||
|
||||
---
|
||||
|
||||
## 1. Deposit Through the Transaction Menu
|
||||
|
||||
Items can be deposited directly through the item's **Transaction Menu**.
|
||||
Open the Warehouse and select the category containing the item you want to deposit.
|
||||
Select the item to open its Transaction Menu.
|
||||
From the Transaction Menu, click the wool to set the amount you want to deposit. Deposit amount will be displayed in the
|
||||
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.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
|
||||
|
||||
|
||||
> **NOTE:** Variant items such as damaged, enchanted, and partially filled items have their own transaction menus and are handled separately from the primary item.
|
||||
|
||||
---
|
||||
|
||||
## 2. Auto-Deposit
|
||||
|
||||
**Auto-Deposit** allows you to automatically deposit items when you pick them up.
|
||||
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.
|
||||
|
||||
### Adding Items to the Auto-Deposit Filter
|
||||
|
||||
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.
|
||||
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
|
||||
|
||||
|
||||
|
||||
> **NOTE:** Adding an item to the Auto-Deposit filter does not remove that item from your inventory.
|
||||
|
||||
For more information, see **[Auto-Deposit](../../50)%20Side%20Pages/Auto-Deposit.md)**.
|
||||
|
||||
---
|
||||
|
||||
## 3. Warehouse Chest — Automatic Processing
|
||||
|
||||
A **Warehouse Chest** can automatically process its contents at regular intervals.
|
||||
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 and deposits all contents.
|
||||
|
||||
> **NOTE:** The automatic processing interval is controlled by the server configuration and may be different on your server.
|
||||
|
||||
---
|
||||
|
||||
## 4. Warehouse Chest — On Chest Close
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
## 5. Command — `/shop deposit`
|
||||
|
||||
Items can also be deposited using the **`/shop deposit`** command.
|
||||
This command opens the **Warehouse Deposit** 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.
|
||||
|
||||
> **NOTE:** The `/shop deposit` command provides a convenient way to access the Warehouse Deposit inventory without navigating through the Warehouse menus.
|
||||
|
||||
---
|
||||
|
||||
## New Items
|
||||
|
||||
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.
|
||||
For more information, see **[UnCategorized Category](../../50)%20Side%20Pages/UnCategorized%20Category.md)**.
|
||||
|
||||
---
|
||||
|
||||
## Which Method Should I Use?
|
||||
|
||||
Each deposit method is useful in different situations.
|
||||
|
||||
| Method | Best Used For |
|
||||
|---|---|
|
||||
| **Transaction Menu** | Depositing a specific item directly |
|
||||
| **Auto-Deposit** | Automatically depositing items when picked up |
|
||||
| **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 |
|
||||
| **`/shop deposit`** | Quickly depositing items through a dedicated inventory |
|
||||
|
||||
---
|
||||
@@ -0,0 +1,67 @@
|
||||
# Withdrawing Items
|
||||
|
||||
Items stored in the Warehouse can be withdrawn directly into your inventory.
|
||||
|
||||
The normal withdrawal process is:
|
||||
|
||||
1. Open the Warehouse.
|
||||
2. Select a category.
|
||||
3. Select the item you want.
|
||||
4. Open the item's Transaction Menu.
|
||||
5. Select **Withdraw**.
|
||||
6. Choose the amount.
|
||||
7. Confirm the withdrawal by picking up the item in the center.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Selecting an Item
|
||||
|
||||
Open the Warehouse and select the category containing the item you want to withdraw.
|
||||
Select the item to open its **Transaction Menu**.
|
||||
The Transaction Menu displays the item currently selected along with its available Warehouse quantity.
|
||||
|
||||
---
|
||||
|
||||
## Choosing the Withdrawal Amount
|
||||
|
||||
Select **Withdraw** to choose how many items you want to remove from the Warehouse.
|
||||
The amount selection menu allows you to adjust the amount before completing the withdrawal.
|
||||
|
||||
> **NOTE:** The amount available for withdrawal is limited by the quantity stored in the Warehouse and the amount that can be placed into your inventory.
|
||||
|
||||
---
|
||||
|
||||
## Completing the Withdrawal
|
||||
|
||||
Confirm the withdrawal to receive the selected items.
|
||||
The items are removed from the Warehouse and added to your inventory.
|
||||
The Warehouse quantity is updated after a successful withdrawal.
|
||||
|
||||
---
|
||||
|
||||
## Withdrawing Variants
|
||||
|
||||
Some items may have variants stored separately from the primary item.
|
||||
RS-Warehouse supports transaction menus for:
|
||||
|
||||
- **Damaged Variants**
|
||||
- **Enchanted Variants**
|
||||
- **Partially Filled Variants**
|
||||
|
||||
These variants can be selected and withdrawn independently.
|
||||
|
||||
|
||||
> **NOTE:** A variant represents a specific version of an item and is handled separately from the primary item.
|
||||
|
||||
---
|
||||
|
||||
## Inventory Space
|
||||
|
||||
Your available inventory space affects how many items can be withdrawn at one time.
|
||||
If your inventory cannot hold the requested amount, the available withdrawal amount is limited accordingly.
|
||||
|
||||
> **IMPORTANT:** Make sure you have enough inventory space before withdrawing large quantities.
|
||||
@@ -1,13 +0,0 @@
|
||||
# Permissions
|
||||
|
||||
This page documents every permission node used by RS-Warehouse.
|
||||
|
||||
| Permission | Description | Default |
|
||||
|------------|-------------|---------|
|
||||
| *(To be completed)* | | |
|
||||
|
||||
---
|
||||
|
||||
⬅️ Previous: [Withdrawing Items](../02)%20Depositing%20And%20Withdrawing/Withdrawing-Items.md)
|
||||
|
||||
➡️ Next: [Commands](../50)%20Side%20Pages/Commands.md)
|
||||
Reference in new issue
Block a user