1.5.0
Docs update
This commit is contained in:
BigPappa committed
1 parent
d8108dbedc
commit
708946de40
5 files changed
+16
-5
No files matched your search
@@ -0,0 +1,326 @@
|
||||
# Configuration
|
||||
# Configuration
|
||||
|
||||
RS-Warehouse includes a `config.yml` file that allows you to control how certain features of the plugin behave.
|
||||
|
||||
The configuration file is located at:
|
||||
|
||||
`plugins/RS-Warehouse/config.yml`
|
||||
|
||||
After changing a setting, reload the plugin for the changes to take effect.
|
||||
|
||||
---
|
||||
|
||||
# Display Settings
|
||||
|
||||
The `display` section controls optional information and categories that are shown to players.
|
||||
|
||||
```yaml
|
||||
display:
|
||||
```
|
||||
|
||||
## Show Discovery Information
|
||||
|
||||
```yaml
|
||||
show-discovery-information: true
|
||||
```
|
||||
|
||||
Controls whether RS-Warehouse displays information about when an item was first deposited into the Warehouse database.
|
||||
When enabled, discovery information can include information about when the item was first discovered.
|
||||
|
||||
### Options
|
||||
|
||||
```text
|
||||
true
|
||||
```
|
||||
|
||||
Discovery information will be displayed.
|
||||
|
||||
```text
|
||||
false
|
||||
```
|
||||
|
||||
Discovery information will not be displayed.
|
||||
|
||||
---
|
||||
|
||||
## Show Server Commands
|
||||
|
||||
```yaml
|
||||
show-server-commands: true
|
||||
```
|
||||
|
||||
Controls whether the **Server Commands** category is displayed.
|
||||
The Server Commands category contains a list of commands available on your server.
|
||||
|
||||
> **NOTE:** This category does not execute commands. It is only used to provide players with a list of available commands.
|
||||
|
||||
### Options
|
||||
|
||||
```text
|
||||
true
|
||||
```
|
||||
|
||||
The Server Commands category will be displayed.
|
||||
|
||||
```text
|
||||
false
|
||||
```
|
||||
|
||||
The Server Commands category will be hidden.
|
||||
|
||||
---
|
||||
|
||||
## Show Server Rules
|
||||
|
||||
```yaml
|
||||
show-server-rules: true
|
||||
```
|
||||
|
||||
Controls whether the **Server Rules** category is displayed.
|
||||
This category can be used to provide players with a list of rules for your server.
|
||||
|
||||
### Options
|
||||
|
||||
```text
|
||||
true
|
||||
```
|
||||
|
||||
The Server Rules category will be displayed.
|
||||
|
||||
```text
|
||||
false
|
||||
```
|
||||
|
||||
The Server Rules category will be hidden.
|
||||
|
||||
---
|
||||
|
||||
# Automatic Chest Processing
|
||||
|
||||
The `chest-auto-processing` section controls automatic scanning and processing of Warehouse Chests.
|
||||
|
||||
```yaml
|
||||
chest-auto-processing:
|
||||
```
|
||||
|
||||
## Enable Automatic Processing
|
||||
|
||||
```yaml
|
||||
enabled: true
|
||||
```
|
||||
|
||||
Controls whether Warehouse Chests are automatically scanned and processed.
|
||||
|
||||
### Options
|
||||
|
||||
```text
|
||||
true
|
||||
```
|
||||
|
||||
Warehouse Chests will automatically be scanned and processed.
|
||||
|
||||
```text
|
||||
false
|
||||
```
|
||||
|
||||
Automatic processing will be disabled.
|
||||
|
||||
---
|
||||
|
||||
## Processing Interval
|
||||
|
||||
```yaml
|
||||
interval-seconds: 30
|
||||
```
|
||||
|
||||
Controls how often RS-Warehouse automatically scans and processes Warehouse Chests.
|
||||
The value is measured in seconds.
|
||||
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
interval-seconds: 30
|
||||
```
|
||||
|
||||
The plugin will process Warehouse Chests every 30 seconds.
|
||||
Increasing this value means chests will be processed less frequently.
|
||||
Decreasing this value means chests will be processed more frequently.
|
||||
|
||||
---
|
||||
|
||||
# Item Creation Settings
|
||||
|
||||
These settings control how RS-Warehouse handles items that do not currently exist in the Warehouse database.
|
||||
|
||||
## Allow Uncategorized Item Creation
|
||||
|
||||
```yaml
|
||||
allow-uncategorized-item-creation: true
|
||||
```
|
||||
|
||||
Controls whether new items can automatically be added to the **Uncategorized** category when they are deposited into a Warehouse Chest.
|
||||
|
||||
### Options
|
||||
|
||||
```text
|
||||
true
|
||||
```
|
||||
|
||||
Items that do not already exist in the Warehouse can be automatically added to the Uncategorized category.
|
||||
|
||||
```text
|
||||
false
|
||||
```
|
||||
|
||||
Items that do not already exist in the Warehouse will not automatically be created.
|
||||
|
||||
---
|
||||
|
||||
## Always Show Uncategorized
|
||||
|
||||
```yaml
|
||||
always-show-uncategorized: false
|
||||
```
|
||||
|
||||
Controls whether the **Uncategorized** category is always displayed in the main Warehouse Category Menu.
|
||||
|
||||
### Options
|
||||
|
||||
```text
|
||||
true
|
||||
```
|
||||
|
||||
The Uncategorized category will always be displayed.
|
||||
|
||||
```text
|
||||
false
|
||||
```
|
||||
|
||||
The Uncategorized category will only be displayed when it contains items.
|
||||
|
||||
---
|
||||
|
||||
## Allow Damaged Item Creation
|
||||
|
||||
```yaml
|
||||
allow-damaged-item-creation: true
|
||||
```
|
||||
|
||||
Controls whether damaged versions of items can automatically be added as damaged variants of their base item.
|
||||
|
||||
### Options
|
||||
|
||||
```text
|
||||
true
|
||||
```
|
||||
|
||||
Damaged items can automatically be added to the damaged variants menu of their base item.
|
||||
|
||||
```text
|
||||
false
|
||||
```
|
||||
|
||||
Damaged items will not automatically be added as damaged variants.
|
||||
|
||||
---
|
||||
|
||||
# Chest Close Processing
|
||||
|
||||
The `chest-close-processing` section controls whether Warehouse Chests are processed when a player closes them.
|
||||
|
||||
```yaml
|
||||
chest-close-processing:
|
||||
```
|
||||
|
||||
## Enable Chest Close Processing
|
||||
|
||||
```yaml
|
||||
enabled: true
|
||||
```
|
||||
|
||||
Controls whether a Warehouse Chest is immediately processed when a player closes it.
|
||||
|
||||
### Options
|
||||
|
||||
```text
|
||||
true
|
||||
```
|
||||
|
||||
The Warehouse Chest will be processed immediately when a player closes it.
|
||||
|
||||
```text
|
||||
false
|
||||
```
|
||||
|
||||
The Warehouse Chest will not be processed when it is closed.
|
||||
Items will instead be processed according to the Automatic Chest Processing settings if automatic processing is enabled.
|
||||
|
||||
---
|
||||
|
||||
# Default Configuration
|
||||
|
||||
The default `config.yml` is:
|
||||
|
||||
```yaml
|
||||
#
|
||||
# RS-Warehouse
|
||||
#
|
||||
|
||||
display:
|
||||
|
||||
# Display when item was first deposited
|
||||
# to database and what date it happened.
|
||||
show-discovery-information: true
|
||||
|
||||
# Display the Server Commands category.
|
||||
# This category is a list of commands
|
||||
# available on your server. It DOES NOT
|
||||
# execute any commands.
|
||||
show-server-commands: true
|
||||
|
||||
# Display the Server Rules category.
|
||||
# This category is a list of rules for
|
||||
# your server.
|
||||
show-server-rules: true
|
||||
|
||||
|
||||
############################################
|
||||
# Automatic-Chest scan and process settings.
|
||||
############################################
|
||||
|
||||
chest-auto-processing:
|
||||
|
||||
enabled: true
|
||||
interval-seconds: 30
|
||||
|
||||
|
||||
############################################
|
||||
# Item Creation. Whether to allow automatic
|
||||
# creation when items aren't in the database.
|
||||
############################################
|
||||
|
||||
# Allow item to be added to Uncategorized
|
||||
# if item is not currently in warehouse.
|
||||
allow-uncategorized-item-creation: true
|
||||
|
||||
# Whether or not to always show the Uncategorized category.
|
||||
# True = Uncategorized will always show.
|
||||
# False = Uncategorized will only show if it has items inside.
|
||||
always-show-uncategorized: false
|
||||
|
||||
# Allow damaged items to be added to
|
||||
# damaged variant menu of base items.
|
||||
allow-damaged-item-creation: true
|
||||
|
||||
|
||||
#######################################
|
||||
# Chest Close Processing Settings
|
||||
#######################################
|
||||
|
||||
chest-close-processing:
|
||||
|
||||
# Process warehouse chests immediately
|
||||
# when a player closes them.
|
||||
enabled: true
|
||||
```
|
||||
@@ -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%29%20Getting%20Started/A%29%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
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
|
||||
## 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%29%20Side%20Pages/Database%20Selection.md)* of the plugin.
|
||||
1. Hopper. This is your [Auto-Deposit](../50%29%20Side%20Pages/Auto-Deposit.md) section.
|
||||
2. Chest. This is the [UnCategorized Category](../50%29%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
|
||||
|
||||
|
||||
|
||||
Populated Database Template
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Creating a Category
|
||||
|
||||
Select **Create Category**.
|
||||
You will be guided through the information needed to create the category.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 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](../Blank%20Pages/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
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 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.
|
||||
|
||||
---
|
||||
Reference in new issue
Block a user