Working on Docs now.
This commit is contained in:
BigPappa committed 2026-08-21 10:13:27 -05:00
1 parent e9af79d75e
commit 33a3ac1a04
33 files changed
+26 -36

No files matched your search

@@ -32,7 +32,7 @@ plugins/
📷 Screenshot
![Plugins Folder](../images/PluginsFolder.png)
![Plugins Folder](../images/PluginsFolder.jpg)
# Step 3 - Start Your Server
@@ -42,7 +42,7 @@ During startup RS-Warehouse will automatically create its data folder, configura
📷 Screenshot
![Plugins Folder](../images/PluginEnabled.png)
![Plugins Folder](../images/PluginEnabled.jpg)
---
@@ -25,7 +25,7 @@ with the chest. This will open the *Conversion* Menu.
📷 Screenshot
![ConversionMenu.png](../images/ConversionMenu.png)
![Conversion Menu](../images/ConversionMenu.jpg)
---
## Step 3 - Convert the Chest
@@ -34,11 +34,8 @@ In the *Conversion* menu pick up the *Crafting Table*. The action will be cance
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.
📷 Screenshot
![MainMenu.png](../images/MainMenu.png)
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.
---
@@ -51,8 +48,7 @@ There are 3 options in this menu. Picking up the item triggers the next action.
📷 Screenshot
![MainMenuNumbered.png](../images/MainMenuNumbered.png)
---
![Empty Warehouse](../images/Converted.jpg)
## Step 4 - Open the Warehouse
@@ -64,4 +60,4 @@ a fully organized and populated warehouse file in the *[db-files-templates](../B
📷 Screenshot
![EmptyWarehouse.png](../images/EmptyWarehouse.png)
![EmptyWarehouse](../images/EmptyWarehouse.jpg)
+12 -18
View File
@@ -1,37 +1,35 @@
# 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 and select the **Command Block** to open the **Administration Menu**.
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](../images/AdminMenu.jpg)
![Plugins Folder](../images/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:
@@ -45,13 +43,13 @@ 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:
@@ -63,15 +61,14 @@ Examples:
- 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:
@@ -82,16 +79,18 @@ For example:
- **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:
@@ -100,17 +99,15 @@ Building materials and decorative blocks.
```
📷 Screenshot
![Plugins Folder](../images/CategoryLore.jpg)
---
## Finishing the Category
Once the category information has been completed, confirm the creation.
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**.
---
@@ -118,7 +115,6 @@ If the category contains a large number of items, you can further organize them
## Organizing Your Warehouse
You can create as many categories as needed to organize your Warehouse.
A simple example might look like:
```text
@@ -133,7 +129,5 @@ Warehouse
```
Items can later be moved between categories as your Warehouse grows and changes.
For information about moving items, see **[Moving Items](../Blank%20Pages/Moving%20Items.md)**.
For information about creating categories within categories, see **[Subcategories](../Blank%20Pages/Subcategories.md)**.
@@ -29,7 +29,7 @@ Once you have the desired amount set, click the item in the center of the wool.
📷 Screenshot
![TransactionMenu.png](../images/TransactionMenu.png)
![Transaction Menu](../images/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.
@@ -58,7 +58,7 @@ Once you close the menu, any item you pick up wil automatically go into the ware
📷 Screenshot
![AutoDeposit.png](../images/AutoDeposit.png)
![Auto Deposit](../images/AutoDeposit.jpg)
> **NOTE:** Adding an item to the Auto-Deposit filter does not remove that item from your inventory.
@@ -14,7 +14,7 @@ The normal withdrawal process is:
📷 Screenshot
![TransactionMenu.png](../images/TransactionMenu.png)
![Transaction Menu](../images/TransactionMenu.jpg)
---
+2 -2
View File
@@ -20,7 +20,7 @@ The original item is **not removed from your inventory**.
📷 Screenshot
![AutoDeposit.png](../images/AutoDeposit.png)
![Auto Deposit](../images/AutoDeposit.jpg)
---
@@ -54,7 +54,7 @@ Open the Auto-Deposit menu to view the items currently configured for automatic
📷 Screenshot
![AutoDeposit.png](../images/AutoDeposit.png)
![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.
@@ -29,7 +29,7 @@ admin.
📷 Screenshot
![UnassignedCategory.png](../images/UnassignedCategory.png)
![UnassignedCategory.jpg](../images/UnassignedCategory.jpg)
---
+1 -1
View File
@@ -14,7 +14,7 @@
### Organization
- [Categories]
- [Categories](01%29%20Getting%20Started/C%29%20Categories.md)
- [Subcategories]
- [UnCategorized](50%29%20Side%20Pages/UnCategorized%20Category.md)
Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.0 KiB