1.5.0
Docs update
This commit is contained in:
BigPappa committed
1 parent
6a6454bbfe
commit
61486763ec
4 files changed
+17
-67
No files matched your search
@@ -1,7 +1,5 @@
|
||||
# Warehouse Chest Deposits
|
||||
|
||||
A Warehouse Chest can automatically process items placed inside it and deposit them into the shared Warehouse.
|
||||
|
||||
RS-Warehouse supports two methods of processing items from a Warehouse Chest:
|
||||
|
||||
- **Auto-Scan**
|
||||
@@ -12,13 +10,21 @@ Both methods ultimately deposit eligible items into the Warehouse.
|
||||
---
|
||||
|
||||
## Auto-Scan
|
||||
|
||||
Auto-Scan periodically checks the contents of the Warehouse Chest while the chest is open or in use.
|
||||
|
||||
When Auto-Scan is enabled, RS-Warehouse checks the chest at the configured interval and processes any eligible items it finds.
|
||||
|
||||
By default, Auto-Scan runs every **30 seconds**.
|
||||
|
||||
### Configuration
|
||||
Auto-Scan is controlled by the following configuration settings:
|
||||
|
||||
```yaml
|
||||
chest-auto-processing:
|
||||
enabled: true
|
||||
interval-seconds: 30
|
||||
```
|
||||
|
||||
## Chest Close Processing
|
||||
|
||||
### How It Works
|
||||
|
||||
1. Place items into the Warehouse Chest.
|
||||
@@ -27,12 +33,12 @@ By default, Auto-Scan runs every **30 seconds**.
|
||||
4. The items are deposited into the Warehouse.
|
||||
5. The chest is left with any items that could not be processed.
|
||||
|
||||
|
||||
### Configuration
|
||||
|
||||
Auto-Scan is controlled by the following configuration settings:
|
||||
|
||||
```yaml
|
||||
chest-auto-processing:
|
||||
chest-close-processing:
|
||||
# Process warehouse chests immediately
|
||||
# when a player closes them.
|
||||
enabled: true
|
||||
interval-seconds: 30
|
||||
```
|
||||
@@ -1,13 +1,10 @@
|
||||
# shop deposit
|
||||
|
||||
The `/shop deposit` command opens the **Mass Deposit** menu, allowing you to deposit multiple items from your inventory into the Warehouse at once.
|
||||
|
||||
This is useful when you want to quickly deposit several items without opening the Warehouse Chest.
|
||||
|
||||
---
|
||||
|
||||
## Opening the Mass Deposit Menu
|
||||
|
||||
Use:
|
||||
|
||||
/shop deposit
|
||||
@@ -16,45 +13,19 @@ The command opens the Mass Deposit screen.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Adding Items
|
||||
|
||||
Place the items you want to deposit into the Mass Deposit menu.
|
||||
|
||||
Items can be added individually or in larger quantities.
|
||||
|
||||
Once the items have been added, the menu provides the option to process the deposit.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Processing the Deposit
|
||||
|
||||
When the deposit is processed, RS-Warehouse checks each item and attempts to add it to the Warehouse.
|
||||
|
||||
Items that can be deposited are added to their corresponding Warehouse inventory.
|
||||
|
||||
Items that cannot be processed remain available to the player rather than being lost.
|
||||
|
||||
This allows you to safely attempt a mass deposit even when your inventory contains items that the Warehouse cannot currently accept.
|
||||
|
||||
---
|
||||
|
||||
## Warehouse Categories
|
||||
|
||||
Items are deposited according to the Warehouse's category and subcategory configuration.
|
||||
|
||||
If an item does not currently have a category and **Uncategorized Item Creation** is enabled, RS-Warehouse can create the item in the Uncategorized category.
|
||||
|
||||
For more information, see:
|
||||
|
||||
- [Uncategorized Category](50%29%20Side%20Pages/UnCategorized%20Category.md)
|
||||
- [Categories](../Blank%20Pages/Categories.md)
|
||||
- [Subcategories](../Blank%20Pages/Subcategories.md)
|
||||
|
||||
---
|
||||
|
||||
## Using `/shop deposit`
|
||||
|
||||
@@ -63,38 +34,11 @@ For more information, see:
|
||||
/shop deposit
|
||||
|
||||
### 2. Add items
|
||||
|
||||
Place the items you want to deposit into the Mass Deposit menu.
|
||||
|
||||
### 3. Process the deposit
|
||||
|
||||
Use the menu's deposit option to process the items.
|
||||
|
||||
### 4. Items are deposited
|
||||
|
||||
Successfully processed items are added to the Warehouse.
|
||||
|
||||
Any items that cannot be processed remain available to the player.
|
||||
|
||||
---
|
||||
|
||||
## Important Notes
|
||||
|
||||
- `/shop deposit` is a **mass deposit** function.
|
||||
- Items are deposited into the shared Warehouse inventory.
|
||||
- Successfully deposited items are removed from the Mass Deposit menu.
|
||||
- Items that cannot be processed are not lost.
|
||||
- Warehouse categories and subcategories determine where items are organized.
|
||||
- Uncategorized item creation can be controlled through the configuration.
|
||||
- The command does not require a Warehouse Chest.
|
||||
|
||||
---
|
||||
|
||||
## Related Pages
|
||||
|
||||
- [Depositing Items](A%29%20Depositing%20Items.md)
|
||||
- [Withdrawing Items](B%29%20Withdrawing%20Items.md)
|
||||
- [Warehouse Chest Deposits](C%29%20Warehouse%20Chest%20Deposits.md)
|
||||
- [Uncategorized Category](50%29%20Side%20Pages/UnCategorized%20Category.md)
|
||||
|
||||
📷 Screenshot
|
||||
Reference in new issue
Block a user