Docs update
This commit is contained in:
BigPappa committed 2026-09-08 14:06:24 -05:00
1 parent d8108dbedc
commit 708946de40
5 files changed
+16 -5

No files matched your search

+150
View File
@@ -0,0 +1,150 @@
# 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](../images/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](../images/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](../images/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](../images/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.
---