137 lines
3.1 KiB
Markdown
137 lines
3.1 KiB
Markdown
# 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. |