diff --git a/docs/01) Getting Started/C) Categories.md b/docs/01) Getting Started/C) Categories.md index 635bccb..b538bb3 100644 --- a/docs/01) Getting Started/C) Categories.md +++ b/docs/01) Getting Started/C) Categories.md @@ -12,7 +12,9 @@ Open a Warehouse Chest by sneaking and clicking a warehouse chest with a stick a From the Administration Menu, select the option for managing categories. 📷 Screenshot + ![Plugins Folder](../images/AdminMenu.jpg) + ![Plugins Folder](../images/ChestMenu.jpg) --- @@ -23,6 +25,7 @@ Select **Create Category**. You will be guided through the information needed to create the category. 📷 Screenshot + ![Plugins Folder](../images/CreateCategory.jpg) --- @@ -43,6 +46,7 @@ The Internal Name is not normally shown to players. > **NOTE:** Choose the Internal Name carefully. It should be unique and should describe the purpose of the category. 📷 Screenshot + ![Plugins Folder](../images/CategoryName.jpg) --- @@ -61,6 +65,7 @@ Examples: - Redstone 📷 Screenshot + ![Plugins Folder](../images/CategoryDisplayName.jpg) --- @@ -79,6 +84,7 @@ For example: - **Iron Sword** for Combat 📷 Screenshot + ![Plugins Folder](../images/CategoryMaterialPicker.jpg) --- @@ -99,6 +105,7 @@ Building materials and decorative blocks. ``` 📷 Screenshot + ![Plugins Folder](../images/CategoryLore.jpg) --- diff --git a/docs/02) Depositing And Withdrawing/A) Depositing Items.md b/docs/02) Depositing And Withdrawing/A) Depositing Items.md index 6598ddd..96cd66e 100644 --- a/docs/02) Depositing And Withdrawing/A) Depositing Items.md +++ b/docs/02) Depositing And Withdrawing/A) Depositing Items.md @@ -17,14 +17,10 @@ Each method ultimately adds the deposited items to the shared Warehouse inventor ## 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 @@ -39,21 +35,15 @@ Once you have the desired amount set, click the item in the center of the wool. ## 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 @@ -69,9 +59,7 @@ For more information, see **[Auto-Deposit](../50%29%20Side%20Pages/Auto-Deposit. ## 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. @@ -81,9 +69,7 @@ The configured interval determines how often RS-Warehouse checks the Warehouse C ## 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. @@ -93,11 +79,8 @@ This allows items to be deposited without waiting for the next automatic process ## 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. @@ -107,9 +90,7 @@ When the inventory is closed, RS-Warehouse processes the items and adds them to ## 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%29%20Side%20Pages/UnCategorized%20Category.md)**. --- diff --git a/docs/02) Depositing And Withdrawing/B) Withdrawing Items.md b/docs/02) Depositing And Withdrawing/B) Withdrawing Items.md index 7a82a1b..aac0e6e 100644 --- a/docs/02) Depositing And Withdrawing/B) Withdrawing Items.md +++ b/docs/02) Depositing And Withdrawing/B) Withdrawing Items.md @@ -21,9 +21,7 @@ The normal withdrawal process is: ## 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. --- @@ -31,7 +29,6 @@ The Transaction Menu displays the item currently selected along with its availab ## 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. @@ -41,9 +38,7 @@ The amount selection menu allows you to adjust the amount before completing the ## 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. --- @@ -51,7 +46,6 @@ 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** @@ -68,7 +62,6 @@ These variants can be selected and withdrawn independently. ## 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. \ No newline at end of file diff --git a/docs/50) Side Pages/Auto-Deposit.md b/docs/50) Side Pages/Auto-Deposit.md index de2c47e..1f55d6a 100644 --- a/docs/50) Side Pages/Auto-Deposit.md +++ b/docs/50) Side Pages/Auto-Deposit.md @@ -1,7 +1,6 @@ # Auto-Deposit **Auto-Deposit** allows each player to choose which items should automatically be sent to the Warehouse when they pick them up. - When a player picks up an item that has been added to their Auto-Deposit filter, the item is sent directly to the Warehouse instead of being added to their inventory. > **NOTE:** Auto-Deposit is configured separately by each player. Your Auto-Deposit items do not affect other players. @@ -11,11 +10,8 @@ When a player picks up an item that has been added to their Auto-Deposit filter, ## Adding an Item to Auto-Deposit Open the Warehouse and access the **Auto-Deposit** menu. - To add an item to your Auto-Deposit filter, place the item into the Auto-Deposit menu. - RS-Warehouse copies the item into your Auto-Deposit filter. - The original item is **not removed from your inventory**. 📷 Screenshot @@ -27,7 +23,6 @@ The original item is **not removed from your inventory**. ## How Auto-Deposit Works Once an item has been added to your Auto-Deposit filter, you can simply pick up that item normally. - When you pick up an item that matches one of your Auto-Deposit items: 1. RS-Warehouse detects the item pickup. @@ -39,9 +34,7 @@ When you pick up an item that matches one of your Auto-Deposit items: ## Items Not in the Filter Items that are not in your Auto-Deposit filter behave normally. - When you pick up an item that has not been added to Auto-Deposit, Minecraft adds the item to your inventory as usual. - This allows you to choose exactly which items should be automatically sent to the Warehouse. --- @@ -49,7 +42,6 @@ This allows you to choose exactly which items should be automatically sent to th ## Managing Your Auto-Deposit Items Your Auto-Deposit filter can be changed at any time. - Open the Auto-Deposit menu to view the items currently configured for automatic deposit. 📷 Screenshot @@ -72,7 +64,6 @@ then *Auto-Deposit* is paused. If it is **GREEN** then *Auto-Deposit* is running ## Using Auto-Deposit with the Warehouse Auto-Deposit is especially useful for items that you collect frequently. - For example, you may want all of the following to automatically go to the Warehouse: - Cobblestone diff --git a/docs/50) Side Pages/UnCategorized Category.md b/docs/50) Side Pages/UnCategorized Category.md index a3d4a46..c3fc88c 100644 --- a/docs/50) Side Pages/UnCategorized Category.md +++ b/docs/50) Side Pages/UnCategorized Category.md @@ -1,7 +1,6 @@ # The UnCategorized Category The **UnCategorized** category is where RS-Warehouse places items that have been discovered by the warehouse but have not yet been assigned to another category. - This allows items to be added to the warehouse immediately without requiring an administrator to organize every item first. > **NOTE:** The UnCategorized category is intended to be a temporary holding area for items that have not yet been organized. @@ -12,9 +11,7 @@ This allows items to be added to the warehouse immediately without requiring an ## How Items Become UnCategorized When an item is deposited into the warehouse, RS-Warehouse checks whether the item has been assigned to a category. - If the item has not been assigned to a category, it is placed in the **UnCategorized** category. - This means you can continue adding items to the warehouse without having to stop and organize each new item as it is discovered. --- @@ -46,7 +43,6 @@ For example, you may discover several new items while playing: 5. Move the items into their appropriate categories. Once an item has been moved to its appropriate category, it will appear there instead of in Unassigned. - This allows the warehouse to remain usable without requiring constant administrative organization. > **IMPORTANT:** Items in Unassigned are still part of the warehouse inventory. Unassigned simply means that they have not yet been organized into a specific category. \ No newline at end of file