Working on Docs now.
This commit is contained in:
BigPappa committed 2026-08-22 21:40:02 -05:00
1 parent b15c0fb9c5
commit 243ab18953
6 files changed
+142 -16

No files matched your search

+4 -4
View File
@@ -31,7 +31,7 @@ Do this by Sneak + cliking the item you wish to convert into a subcategory.
📷 Screenshot
![Plugins Folder](../images/ConvertToNewSubCategory.jpg)
![Convert To New SubCategory](../images/ConvertToNewSubCategory.jpg)
---
@@ -53,7 +53,7 @@ The Internal Name is not normally displayed to players.
📷 Screenshot
![Plugins Folder](../images/SubCatInternalName.jpg)
![SubCategory Internal Name](../images/SubCatInternalName.jpg)
---
@@ -72,7 +72,7 @@ For example:
📷 Screenshot
![Plugins Folder](../images/SubCatDisplayName.jpg)
![SubCategory Display Name](../images/SubCatDisplayName.jpg)
---
@@ -98,7 +98,7 @@ Wood blocks and related building materials.
📷 Screenshot
![Plugins Folder](../images/SubCatLore.jpg)
![SubCategory Lore](../images/SubCatLore.jpg)
---
+137
View File
@@ -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
![Command Section](../images/CommandsSection.jpg)
---
# Creating a Server Command
Server Commands are created through the Warehouse **Administration Menu**.
Open the Administration Menu and select **Server Commands**.
📷 Screenshot
![Admin Create Command](../images/AdminCreateCommand.jpg)
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.
-11
View File
@@ -1,11 +0,0 @@
# Commands
| Command | Description |
|---------|-------------|
| *(To be completed)* | |
---
⬅️ Previous: [Permissions](Permissions.md)
➡️ Next: [Configuration](../50)%20Side%20Pages/Configuration.md)
+1 -1
View File
@@ -10,4 +10,4 @@ This page documents every permission node used by RS-Warehouse.
⬅️ Previous: [Withdrawing Items](../02)%20Depositing%20And%20Withdrawing/Withdrawing-Items.md)
➡️ Next: [Commands](Commands.md)
➡️ Next: [Commands](../50)%20Side%20Pages/Commands.md)
Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.4 KiB