From 2a2a99af721347e3625bdd2009c7b0287212b6d8 Mon Sep 17 00:00:00 2001 From: Big Pappa Date: Tue, 8 Sep 2026 15:31:31 -0500 Subject: [PATCH] 1.5.0 Docs update --- .../{Auto-Deposit.md => A) Auto-Deposit.md} | 4 +- .../B) Warehouse Chest Deposit.md | 39 ++++++++++++++++++ .../A) Depositing Items.md | 2 +- docs/Home.md | 6 +-- docs/{Blank Pages => images}/AutoDeposit.jpg | Bin 5 files changed, 45 insertions(+), 6 deletions(-) rename docs/02) Depositing Items/{Auto-Deposit.md => A) Auto-Deposit.md} (96%) create mode 100644 docs/02) Depositing Items/B) Warehouse Chest Deposit.md rename docs/{Blank Pages => images}/AutoDeposit.jpg (100%) diff --git a/docs/02) Depositing Items/Auto-Deposit.md b/docs/02) Depositing Items/A) Auto-Deposit.md similarity index 96% rename from docs/02) Depositing Items/Auto-Deposit.md rename to docs/02) Depositing Items/A) Auto-Deposit.md index f0a076a..1f55d6a 100644 --- a/docs/02) Depositing Items/Auto-Deposit.md +++ b/docs/02) Depositing Items/A) Auto-Deposit.md @@ -16,7 +16,7 @@ The original item is **not removed from your inventory**. 📷 Screenshot -![Auto Deposit](../Blank%20Pages/AutoDeposit.jpg) +![Auto Deposit](../images/AutoDeposit.jpg) --- @@ -46,7 +46,7 @@ Open the Auto-Deposit menu to view the items currently configured for automatic 📷 Screenshot -![Auto Deposit](../Blank%20Pages/AutoDeposit.jpg) +![Auto Deposit](../images/AutoDeposit.jpg) Items can be removed from the filter when you no longer want them to be automatically deposited by simply picking them up. The item will disappear and will no longer be in the filter. diff --git a/docs/02) Depositing Items/B) Warehouse Chest Deposit.md b/docs/02) Depositing Items/B) Warehouse Chest Deposit.md new file mode 100644 index 0000000..0e95ac5 --- /dev/null +++ b/docs/02) Depositing Items/B) Warehouse Chest Deposit.md @@ -0,0 +1,39 @@ +# 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** +- **Process on Close** + +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**. + +### How It Works + +1. Place items into the Warehouse Chest. +2. RS-Warehouse automatically scans the chest. +3. Eligible items are removed from the chest. +4. The items are deposited into the Warehouse. +5. The chest is left with any items that could not be processed. + +Auto-Scan is useful when players are actively using a Warehouse Chest and want items processed automatically without having to close the chest. + +### Configuration + +Auto-Scan is controlled by the following configuration settings: + +```yaml +chest-auto-processing: + enabled: true + interval-seconds: 30 \ No newline at end of file diff --git a/docs/Blank Pages/02) Depositing And Withdrawing/A) Depositing Items.md b/docs/Blank Pages/02) Depositing And Withdrawing/A) Depositing Items.md index f1b9484..c57f5c9 100644 --- a/docs/Blank Pages/02) Depositing And Withdrawing/A) Depositing Items.md +++ b/docs/Blank Pages/02) Depositing And Withdrawing/A) Depositing Items.md @@ -48,7 +48,7 @@ Once you close the menu, any item you pick up wil automatically go into the ware 📷 Screenshot -![Auto Deposit](../AutoDeposit.jpg) +![Auto Deposit](../../images/AutoDeposit.jpg) > **NOTE:** Adding an item to the Auto-Deposit filter does not remove that item from your inventory. diff --git a/docs/Home.md b/docs/Home.md index ecb5d8f..922bd3f 100644 --- a/docs/Home.md +++ b/docs/Home.md @@ -7,9 +7,9 @@ - [Database File Selection](01%29%20Getting%20Started/C%29%20Database%20File%20Selection.md) - [Permissions](01%29%20Getting%20Started/D%29%20Permissions.md) - - - +### Depositing items +- [Auto-Deposit](02%29%20Depositing%20Items/A%29%20Auto-Deposit.md) +- [Chest-Deposit](02%29%20Depositing%20Items/B%29%20Warehouse%20Chest%20Deposit.md) diff --git a/docs/Blank Pages/AutoDeposit.jpg b/docs/images/AutoDeposit.jpg similarity index 100% rename from docs/Blank Pages/AutoDeposit.jpg rename to docs/images/AutoDeposit.jpg