1.5.1

Docs Update
2026-09-10 15:35:37 -05:00
1 parent 059f43a18c
commit 39f469eedf
@@ -14,48 +14,36 @@ The available options allow you to change how an item is displayed, organize ite
 Icon: Name Tag
 Change the name displayed to players for the selected item.

-[Learn more about Edit Display Name](Item%20Options/Edit%20Display%20Name.md)
-
 ---

 ## Create SubCategory
 Icon: Crafter
 Create a new SubCategory using the selected item as the starting point.  The Original item will be copied into the SubCategory when it is created.

-[Learn more about Creating SubCategories](Subcategories.md)
-
 ---

 ## Assign Page / Slot
 Icon: Book
 Choose which page and slot the item appears in within its category.

-[Learn more about Assign Page / Slot](Item%20Options/Assign%20Page%20Slot.md)
-
 ---

 ## Edit Lore
 Icon: Book With Quill
 Change the description displayed underneath the SubCategory.

-[Learn more about Edit Lore](Item%20Options/Edit%20Lore.md)
-
 ---

 ## Move to Category
 Icon: Piston
 Move the item from its current category to another category.

-[Learn more about Moving Items to a Category](Moving%20Items.md)
-
 ---

 ## Move to SubCategory
 Icon: Sticky Piston
 Move the item into an existing SubCategory.

-[Learn more about Moving Items to a SubCategory](Item%20Options/Move%20to%20SubCategory.md)
-
 ---

 ## Delete Item
@@ -63,24 +51,18 @@ Icon: Barrier Block
 Delete the selected item reference from the Warehouse.
 Deletion is permanent and may be restricted when the item is still being used or contains inventory.

-[Learn more about Deleting Items](Item%20Options/Delete%20Item.md)
-
 ---

 ## Copy to Category
 Icon: Sign
 Create an additional reference to the same Warehouse item in another category.

-[Learn more about Copying Items to a Category](Item%20Options/Copy%20to%20Category.md)
-
 ---

 ## Copy to SubCategory
 Icon: Hanging Sign
 Create an additional reference to the same Warehouse item in a SubCategory.

-[Learn more about Copying Items to a SubCategory](Item%20Options/Copy%20to%20SubCategory.md)
-
 ---

 ## Back
@@ -1,110 +0,0 @@
-# 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
-
-![Transaction Menu](../TransactionMenu.jpg)
-
-
-> **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
-
-![Auto Deposit](../../images/AutoDeposit.jpg)
-
-> **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 |
-
---
@@ -1,67 +0,0 @@
-# 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
-
-![Transaction Menu](../TransactionMenu.jpg)
-
---
-
-## 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,137 +0,0 @@
-# Server Commands
-
-The **Server Commands** category provides players with a list of commands available on your server.
-Commands created in this category are for informational purposes only.
-
-> **NOTE:** RS-Warehouse does not execute any of the commands listed in the Server Commands category.
-
-The category can be enabled or disabled through the `config.yml` file.
-
---
-
-## Opening Server Commands
-
-The **Server Commands** category appears in the main Warehouse Category Menu when enabled.  It is
-located in the upper right of the main category selection page. The icon is a book.
-Select **Server Commands** to view the commands that have been added.
-
-📷 Screenshot
-
-![Command Section](../CommandsSection.jpg)
-
---
-
-# Creating a Server Command
-
-Server Commands are created through the Warehouse **Administration Menu**.
-Open the Administration Menu and select **Server Commands**.
-
-📷 Screenshot
-![Admin Create Command](../AdminCreateCommand.jpg)
-
-From the Server Commands menu, select the option to create a new command.
-You will then be guided through the command creation process.
-
---
-
-## Command Internal Name
-
-The first step is entering the command's **Internal Name**.
-The Internal Name is used internally by RS-Warehouse and must be unique.
-
-For example:
-
-```text
-home
-```
-
-> **NOTE:** Command names cannot be empty and may not exceed 25 characters.
-
---
-
-## Command Display Name
-
-Next, enter the **Display Name**.
-The Display Name is the name players will see in the Server Commands category.
-
-For example:
-
-```text
-/home
-```
-
-You can use a more descriptive display name if desired.
-
---
-
-## Adding a Description
-
-You can add a description to explain what the command does.
-The description is displayed as lore when players view the command.
-
-For example:
-
-```text
-Teleports you to your home.
-```
-
-You can use the available lore lines to provide additional information about the command.
-
---
-
-## Selecting an Icon
-
-Finally, select a material to represent the command.
-The selected material will be used as the command's icon in the Server Commands category.
-
-For example:
-
- **Compass** for `/home`
- **Chest** for `/shop`
- **Player Head** for `/spawn`
- **Book** for `/help`
-
---
-
-## Finishing the Command
-
-After selecting the command icon, the command will be created and added to the **Server Commands** category.
-Players can then open the category and view the command along with its description.
-The command is displayed for reference only.
-
-> **IMPORTANT:** Clicking a command in the Server Commands category does not execute the command.
-
---
-
-# Managing Server Commands
-
-To manage a server command, simply shift + right click its icon in the Commands section and 
-select the desired edit method.
-
---
-
-# Disabling the Server Commands Category
-
-The Server Commands category can be hidden through the `config.yml` file.
-
-Open:
-
-```text
-plugins/RS-Warehouse/config.yml
-```
-
-Locate:
-
-```yaml
-display:
-  show-server-commands: true
-```
-
-To hide the Server Commands category, change the setting to:
-
-```yaml
-display:
-  show-server-commands: false
-```
-
-When disabled, the Server Commands category will no longer appear in the main Warehouse Category Menu.
@@ -1,37 +0,0 @@
-# Frequently Asked Questions
-
-## Why is my warehouse empty?
-
-Items have not yet been deposited.
-
---
-
-## Can multiple players use the same warehouse?
-
-Yes.
-
---
-
-## Does RS-Warehouse support SQLite?
-
-Yes.
-
-SQLite is used by default.
-
---
-
-## Can I organize items?
-
-Yes.
-
-Categories and subcategories provide flexible organization.
-
---
-
-## Where can I request features?
-
-Please use the repository's **Issues** page.
-
---
-
-⬅️ Previous: [Configuration](../50)%20Side%20Pages/Configuration.md)
@@ -1,48 +0,0 @@
-# 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.
-> This category can be enable and disabled in the plugins config.yml file.  It is enabled by default.
-
---
-
-## 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.
-
---
-
-## Viewing UnCategorized Items
-
-Open the Warehouse and select the **UnCategorized** category.
-
-The category will display the items that have not yet been assigned to another category. These items can be withdrawn 
-just like any other item and even deposited.  They can be moved by an admin into a *Category* or *SubCategory* by any
-admin.
-
-📷 Screenshot
-
-![UnassignedCategory.jpg](../UnassignedCategory.jpg)
-
---
-
-## Keeping the Warehouse Organized
-
-The UnCategorized category makes it possible to build your warehouse inventory first and organize it later.
-
-For example, you may discover several new items while playing:
-
-1. Deposit the items into the Warehouse.
-2. The items are automatically placed in **UnCategorized** if they have not yet been categorized.
-3. Continue using the warehouse normally.
-4. When convenient, open **UnCategorized**.
-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.
@@ -1,72 +0,0 @@
-# Creating a Warehouse Chest
-
-This guide walks you through creating your first Warehouse Chest.
-
---
-
-## Before You Begin
-
-Ensure:
-
- RS-Warehouse is installed.
- You have administrative permissions.
- The server has been started at least once.
-
-If not, complete the
-[Installation And Setup](../01)%20Getting%20Started/A)%20Installation%20And%20Setup.md)
-guide first.
-
---
-
-## Step 1 - Convert A Chest
-
-Place a normal chest anywhere in the world. Then with a stick in your hand SNEAK and strike the chest 
-with the chest. This will open the *Conversion* Menu.
-
-📷 Screenshot
-
-![Conversion Menu](ConversionMenu.jpg)
---
-
-## Step 3 - Convert the Chest
-
-In the *Conversion* menu pick up the *Crafting Table*.  The action will be cancelled and the chest will
-be converted. 
-
-**NOTE:** Warehouse chests cannot be broken or damaged.  To pick one up, you will need to convert 
-it back into a normal chest.  Also, Sneak + clicking a warehouse chest with a stick is the only way
-to access the warehouse admin menu.
-
---
-
-## Step 3A - *Main Chest Menu*
-There are 3 options in this menu. Picking up the item triggers the next action. 
-1. Composter.  This Will convert the chest back into a standard chest.
-2. Command Block.  This will open the chest *Administration Menu*
-3. Book Shelf.  This will open the *Warehouse Category Menu*.
-
-
-📷 Screenshot
-
-![Empty Warehouse](../images/Converted.jpg)
-
-## Step 4 - Open the Warehouse
-
-Click on the *Book Shelf*. to open the *Warehouse Category Menu*.  If you have
-not created any categories yet you will only see 2 options in this menu. You can find
-a fully organized and populated warehouse file in the *[db-files-templates](../50)%20Side%20Pages/Database%20Selection.md)* of the plugin.
-1. Hopper.  This is your [Auto-Deposit](../50)%20Side%20Pages/Auto-Deposit.md) section. 
-2. Chest.  This is the [UnCategorized Category](../50)%20Side%20Pages/UnCategorized%20Category.md) section.
-
-**NOTE:** UnCategorized section will only show if there are "UnCategorized" inside.  This behavior can be changed
-by setting "always-show-uncategorized: true" in the plugins config.yml file.
-
-📷 Screenshot
-
-Empty Database Template
-
-![EmptyWarehouse](EmptyWarehouse.jpg)
-
-Populated Database Template
-
-![EmptyWarehouse](PopulatedWarehouse.jpg)
@@ -1,140 +0,0 @@
-# Categories
-
-Categories are used to organize items stored inside the Warehouse.
-A well-organized category structure makes it easier for players to browse and find the items they need.
-Categories are created and managed through the Warehouse **Administration Menu**.
-
---
-
-## Opening Category Management
-
-Open a Warehouse Chest by sneaking and clicking a warehouse chest with a stick and select the **Command Block** to open the **Administration Menu**.
-From the Administration Menu, select the option for managing categories.
-
-📷 Screenshot
-
-![Plugins Folder](AdminMenu.jpg)
-
-![Plugins Folder](ChestMenu.jpg)
-
---
-
-## Creating a Category
-
-Select **Create Category**.
-You will be guided through the information needed to create the category.
-
-📷 Screenshot
-
-![Plugins Folder](../images/CreateCategory.jpg)
-
---
-
-## Internal Name
-
-The first step is entering the category's **Internal Name**.
-The Internal Name is used internally by RS-Warehouse and must be unique.
-
-For example:
-
-```text
-building_blocks
-```
-
-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)
-
---
-
-## Display Name
-
-Next, enter the **Display Name**.
-The Display Name is the name players will see in the Warehouse Category Menu.
-
-Examples:
-
- Building Blocks
- Food
- Farming
- Combat
- Redstone
-
-📷 Screenshot
-
-![Plugins Folder](../images/CategoryDisplayName.jpg)
-
---
-
-## Selecting an Icon
-
-After entering the category names, choose the material that will represent the category in the Warehouse Category Menu.
-RS-Warehouse provides a Material Picker that allows you to select from available Minecraft materials.
-Choose an item that best represents the category.
-
-For example:
-
- **Grass Block** for Building Blocks
- **Wheat** for Farming
- **Apple** for Food
- **Iron Sword** for Combat
-
-📷 Screenshot
-
-![Plugins Folder](../images/CategoryMaterialPicker.jpg)
-
---
-
-## Adding a Description
-
-You can optionally add a description to the category.
-The description is displayed as lore when players view the category.
-Descriptions can be used to explain what belongs inside the category.
-Up to 5 lines can be used. Each book represents one line of lore.
-Click the book, the menu will exit.  Press "T" to open a chat and simply
-type your desired lore into the chat. Upon pressing "enter" the lore will be saved.
-
-For example:
-
-```text
-Building materials and decorative blocks.
-```
-
-📷 Screenshot
-
-![Plugins Folder](../images/CategoryLore.jpg)
-
---
-
-## Finishing the Category
-
-Once the category information has been completed, confirm the creation by picking up the Green Wool Block.
-The new category will then appear in the **Warehouse Category Menu**.
-You can now begin organizing items into the category.
-If the category contains a large number of items, you can further organize them using **Subcategories**.
-
---
-
-## Organizing Your Warehouse
-
-You can create as many categories as needed to organize your Warehouse.
-A simple example might look like:
-
-```text
-Warehouse
-│
-├── Building Blocks
-├── Food
-├── Farming
-├── Combat
-├── Redstone
-└── Miscellaneous
-```
-
-Items can later be moved between categories as your Warehouse grows and changes.
-For information about moving items, see **[Moving Items](Moving%20Items.md)**.
-For information about creating categories within categories, see **[Subcategories](../Blank%20Pages/Subcategories.md)**.
@@ -1,150 +0,0 @@
-# Subcategories
-
-Subcategories provide an additional level of organization inside the Warehouse.
-Instead of placing every item directly inside a main category, related items can be grouped together inside subcategories.
-
-For example:
-
-```text
-Building Blocks
-│
-├── Stone
-├── Wood
-├── Concrete
-└── Glass
-```
-
-Each subcategory can contain items just like a normal category.
-
---
-
-## Creating a Subcategory
-
-Subcategories are created from an existing item.
-To create a subcategory, first open the category containing the item you want to use.
-
-> **NOTE:** When an item is converted into a SubCategory, the SubCategory is created
-> with a copy of the item as the link. The actual item is then moved inside the SubCategory.
-
-Open the item's **Item Options Menu** and select the option to "Convert To New SubCategory".
-Do this by Sneak + cliking the item you wish to convert into a subcategory.
-
-📷 Screenshot
-
-![Convert To New SubCategory](ConvertToNewSubCategory.jpg)
-
---
-
-## Internal Name
-
-The first step is entering the subcategory's **Internal Name**.
-The Internal Name is used internally by RS-Warehouse and must be unique.
-Enter the desired internal name and pick up the Green Wool.
-
-For example:
-
-```text
-wood
-```
-
-The Internal Name is not normally displayed to players.
-
-> **NOTE:** Choose the Internal Name carefully. It should be unique and should describe the purpose of the subcategory.
-
-📷 Screenshot
-
-![SubCategory Internal Name](SubCatInternalName.jpg)
-
---
-
-## Display Name
-
-Next, enter the **Display Name**.
-The Display Name is the name players will see when viewing the Warehouse.
-Enter the display name and pick up the green wool.
-
-For example:
-
- Wood
- Stone
- Concrete
- Glass
-
-📷 Screenshot
-
-![SubCategory Display Name](SubCatDisplayName.jpg)
-
---
-
-## Adding a Description
-
-You can optionally add a description to the subcategory.
-The description is displayed as lore when players view the subcategory.
-You can add up to 5 lines of lore. Each line may contain up to 50 characters.
-
-Choose a book. Each book represents a line of lore. 
-
-Click the book for the corresponding lore line you wish to add/edit.
-Press "T" to open a chat and enter the test you wish to display as the lore.
-Once you press "Enter", the text will be saved to the book.  
-Once you are finished editing the desired "lore" lines simply grab the green Wool
-to save the SubCategory.
-
-For example:
-
-```text
-Wood blocks and related building materials.
-```
-
-📷 Screenshot
-
-![SubCategory Lore](SubCatLore.jpg)
-
---
-
-## Finishing the Subcategory
-
-Once the information has been completed, confirm the creation.
-The item used to create the subcategory will become a link to the new subcategory.
-Clicking that item will open the subcategory and display the items stored inside it.
-The original item is no longer treated as a normal item in that location.
-
---
-
-
-## Moving Items Into a Subcategory
-
-Once a subcategory has been created, items can be moved into it.
-This allows you to organize large categories into smaller groups.
-
-For example:
-
-```text
-Building Blocks
-│
-├── Stone
-│   ├── Stone
-│   ├── Cobblestone
-│   └── Stone Bricks
-│
-├── Wood
-│   ├── Oak Planks
-│   ├── Spruce Planks
-│   └── Birch Planks
-│
-└── Concrete
-    ├── White Concrete
-    ├── Red Concrete
-    └── Blue Concrete
-
-```
-
-## Opening a Subcategory
-
-Subcategories appear as an item inside their parent category.
-A SubCategory link can be created out of items within a SubCategory creating multiple levels of organization 
-within a category.
-Click the subcategory item to open it and view the items inside.
-You can then browse, deposit, withdraw, and manage the items contained within that subcategory just like other Warehouse items.
-
---