1.5.0
Docs update
This commit is contained in:
BigPappa committed
1 parent
59b0da3170
commit
7f83d5c403
33 files changed
+25
-25
No files matched your search
@@ -0,0 +1,98 @@
|
||||
# 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.
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 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.
|
||||
2. The item is sent directly to the Warehouse.
|
||||
3. The item is not added to your inventory.
|
||||
|
||||
---
|
||||
|
||||
## 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.
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
## Pausing/Resuming Auto-Deposit
|
||||
|
||||
*Auto-Deposit* may be paused and resumed by clicking on the **DYE** in the top row. If the **DYE** is **RED**
|
||||
then *Auto-Deposit* is paused. If it is **GREEN** then *Auto-Deposit* is running.
|
||||
|
||||
> **NOTE:** Items within the *Auto-Deposit* filter cannot be withdrawn from the warehouse as long as *Auto-Deposit*
|
||||
> is enabled. Pausing *Auto-Deposit* will allow you to withdraw those items from the warehouse again.
|
||||
|
||||
## 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
|
||||
- Stone
|
||||
- Dirt
|
||||
- Ores
|
||||
- Farmed materials
|
||||
- Mob drops
|
||||
|
||||
Instead of filling your inventory with these items, they can be sent directly to the Warehouse as you collect them.
|
||||
|
||||
---
|
||||
|
||||
## Auto-Deposit Is Player-Specific
|
||||
|
||||
Each player's Auto-Deposit filter is independent.
|
||||
|
||||
For example, Player A can configure:
|
||||
|
||||
- Cobblestone
|
||||
- Stone
|
||||
- Dirt
|
||||
|
||||
while Player B can configure:
|
||||
|
||||
- Iron Ore
|
||||
- Coal
|
||||
- Diamonds
|
||||
|
||||
The two players' filters do not affect one another.
|
||||
|
||||
> **IMPORTANT:** Adding an item to your Auto-Deposit filter does not automatically configure it for other players.
|
||||
@@ -0,0 +1,137 @@
|
||||
# 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
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
# Creating a Server Command
|
||||
|
||||
Server Commands are created through the Warehouse **Administration Menu**.
|
||||
Open the Administration Menu and select **Server Commands**.
|
||||
|
||||
📷 Screenshot
|
||||
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,37 @@
|
||||
# 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)
|
||||
@@ -0,0 +1,48 @@
|
||||
# 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
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 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.
|
||||
Reference in new issue
Block a user