docs: Add some command documentation for FancyCore

2025-12-06 07:43:36 +00:00 · 2025-11-23 16:58:06 +01:00
parent 30898973c3
commit 18518f9c19
10 changed files with 429 additions and 9 deletions
--- a/docs/src/fancycore/commands/chat.md
+++ b/docs/src/fancycore/commands/chat.md
@@ -1,7 +1,6 @@
 ---
 icon: dot
 title: Chat
-order: 8
 ---

 ![](../../static/commands.png)
--- a/docs/src/fancycore/commands/economy.md
+++ b/docs/src/fancycore/commands/economy.md
@@ -1,7 +1,6 @@
 ---
 icon: dot
 title: Economy
-order: 9
 ---

 ![](../../static/commands.png)
--- a/docs/src/fancycore/commands/inventory.md
+++ b/docs/src/fancycore/commands/inventory.md
@@ -0,0 +1,74 @@
+---
+icon: dot
+title: Inventory
+---
+
+![](../../static/commands.png)
+
+# Commands for the inventory system
+
+## Kits
+
+### Create Kit
+
+Description: Creates a new kit with the specified name. It contains all items in your inventory<br/>
+Syntax: ``/CreateKit (name)``<br/>
+Permission: ``fancycore.commands.createkit``
+
+### Delete Kit
+
+Description: Deletes the specified kit.<br/>
+Syntax: ``/DeleteKit (name)``<br/>
+Permission: ``fancycore.commands.deletekit``
+
+### Give Kit
+
+Description: Gives the specified kit to the targeted player(s).<br/>
+Syntax: ``/Kit (name) [player]``<br/>
+Permission: ``fancycore.commands.kit.(name)``
+
+### List Kits
+
+Description: Lists all available kits.<br/>
+Syntax: ``/Kits`` or ``/ListKits``<br/>
+Permission: ``fancycore.commands.listkits``
+
+## Backpacks
+
+### Open Backpack
+
+Description: Opens the specified backpack of the targeted player.<br/>
+Syntax: ``/Backpack (name) [player]``<br/>
+Permission: ``fancycore.commands.backpack``
+
+### Create Backpack
+
+Description: Creates a new backpack with the specified name and size.<br/>
+Syntax: ``/CreateBackpack (name) (size)``<br/>
+Permission: ``fancycore.commands.createbackpack``
+
+### Delete Backpack
+
+Description: Deletes the specified backpack.<br/>
+Syntax: ``/DeleteBackpack (name)``<br/>
+Permission: ``fancycore.commands.deletebackpack``
+
+### List Backpacks
+
+Description: Lists all available backpacks.<br/>
+Syntax: ``/Backpacks`` or ``/ListBackpacks``<br/>
+Permission: ``fancycore.commands.listbackpacks``
+
+## Utilities
+
+### Clear Inventory
+
+Description: Clears the inventory of the targeted player(s).<br/>
+Syntax: ``/ClearInventory [player]``<br/>
+Permission: ``fancycore.commands.clearinventory``
+
+### Open another Player's Inventory
+
+Description: Opens the inventory of the targeted player.<br/>
+Syntax: ``/OpenInventory (player)`` or ``/Invsee (player)``<br/>
+Permission: ``fancycore.commands.openinventory``
--- a/docs/src/fancycore/commands/moderation.md
+++ b/docs/src/fancycore/commands/moderation.md
@@ -1,9 +1,105 @@
 ---
 icon: dot
 title: Moderation
-order: 7
 ---

 ![](../../static/commands.png)

 # Commands for the moderation system
+
+## Report
+
+### Report a Player
+
+Description: Reports a player for misconduct.<br/>
+Syntax: ``/Report (player) [reason]``<br/>
+Permission: ``fancycore.commands.report``
+
+### List Reports
+
+Description: Lists all active player reports.<br/>
+Syntax: ``/Reports list``<br/>
+Permission: ``fancycore.commands.reports.list``
+
+### View Report Details
+
+Description: Views details of a specific report.<br/>
+Syntax: ``/Reports view (reportID)``<br/>
+Permission: ``fancycore.commands.reports.view``
+
+### Close Report
+
+Description: Closes a specific report.<br/>
+Syntax: ``/Reports close (reportID)``<br/>
+Permission: ``fancycore.commands.reports.close``
+
+## Warn
+
+### Warn a Player
+
+Description: Issues a warning to a player.<br/>
+Syntax: ``/Warn (player) [reason]``<br/>
+Permission: ``fancycore.commands.warn``
+
+## Mute
+
+### Mute a Player
+
+Description: Mutes a player, preventing them from sending chat messages.<br/>
+Syntax: ``/Mute (player) [reason]``<br/>
+Permission: ``fancycore.commands.mute``
+
+### Temporary Mute a Player
+
+Description: Temporarily mutes a player for a specified duration.<br/>
+Syntax: ``/Tempmute (player) (duration) [reason]``<br/>
+Permission: ``fancycore.commands.tempmute``
+
+### Unmute a Player
+
+Description: Unmutes a player.<br/>
+Syntax: ``/Unmute (player)``<br/>
+Permission: ``fancycore.commands.unmute``
+
+
+## Kick
+
+### Kick a Player
+
+Description: Kicks a player from the server.<br/>
+Syntax: ``/Kick (player) [reason]``<br/>
+Permission: ``fancycore.commands.kick``
+
+## Ban
+
+### Ban a Player
+
+Description: Bans a player from the server.<br/>
+Syntax: ``/Ban (player) [reason]``<br/>
+Permission: ``fancycore.commands.ban``
+
+### Temporary Ban a Player
+
+Description: Temporarily bans a player from the server for a specified duration.<br/>
+Syntax: ``/Tempban (player) (duration) [reason]``<br/>
+Permission: ``fancycore.commands.tempban``
+
+### Unban a Player
+
+Description: Unbans a player from the server.<br/>
+Syntax: ``/Unban (player)``<br/>
+Permission: ``fancycore.commands.unban``
+
+## Logs
+
+### View Moderation Logs
+
+Description: Views the moderation logs.<br/>
+Syntax: ``/Modlogs [player]``<br/>
+Permission: ``fancycore.commands.modlogs``
+
+### View Chat Logs
+
+Description: Views the chat logs.<br/>
+Syntax: ``/Chatlogs [player] [--withCommands]``<br/>
+Permission: ``fancycore.commands.chatlogs``
--- a/docs/src/fancycore/commands/permissions.md
+++ b/docs/src/fancycore/commands/permissions.md
@@ -1,9 +1,102 @@
 ---
 icon: dot
 title: Permissions
-order: 10
 ---

 ![](../../static/commands.png)

 # Commands for the permissions system
+
+## Groups
+
+### Create Group
+
+Description: Creates a new group with the specified name.<br/>
+Syntax: ``/Groups create (name)``<br/>
+Permission: ``fancycore.commands.creategroup``
+
+### Delete Group
+
+Description: Deletes the specified permission group.<br/>
+Syntax: ``/Groups delete (name)``<br/>
+Permission: ``fancycore.commands.deletegroup``
+
+### List Groups
+
+Description: Lists all available permission groups.<br/>
+Syntax: ``/Groups list``<br/>
+Permission: ``fancycore.commands.listgroups``
+
+### Info Group
+
+Description: Displays information about the specified permission group.<br/>
+Syntax: ``/Groups info (name)``<br/>
+Permission: ``fancycore.commands.infogroup``
+
+### Set Parent Group
+
+Description: Sets the parent group for the specified permission group.<br/>
+Syntax: ``/Groups parent (group) set (parent)``<br/>
+Permission: ``fancycore.commands.setparentgroup``
+
+### Add Permission to Group
+
+Description: Adds the specified permission to the permission group.<br/>
+Syntax: ``/Groups permission (group) add (permission)``<br/>
+Permission: ``fancycore.commands.addpermtogroup``
+
+### Remove Permission from Group
+
+Description: Removes the specified permission from the permission group.<br/>
+Syntax: ``/Groups permission (group) remove (permission)``<br/>
+Permission: ``fancycore.commands.removepermfromgroup``
+
+### Set Prefix for Group
+
+Description: Sets the prefix for the specified permission group.<br/>
+Syntax: ``/Groups prefix (group) set (prefix)``<br/>
+Permission: ``fancycore.commands.setprefixforgroup``
+
+### Set Suffix for Group
+
+Description: Sets the suffix for the specified permission group.<br/>
+Syntax: ``/Groups suffix (group) set (suffix)``<br/>
+Permission: ``fancycore.commands.setsuffixforgroup``
+
+### Add Player to Group
+
+Description: Adds the specified player to the permission group.<br/>
+Syntax: ``/Groups player (player) add (group)``<br/>
+Permission: ``fancycore.commands.addplayertogroup``
+
+### Remove Player from Group
+
+Description: Removes the specified player from the permission group.<br/>
+Syntax: ``/Groups player (player) remove (group)``<br/>
+Permission: ``fancycore.commands.removeplayerfromgroup``
+
+## Player Permissions
+
+### Add Permission to Player
+
+Description: Adds the specified permission to the targeted player.<br/>
+Syntax: ``/Permission add (permission) [player]``<br/>
+Permission: ``fancycore.commands.addpermtoplayer``
+
+### Remove Permission from Player
+
+Description: Removes the specified permission from the targeted player.<br/>
+Syntax: ``/Permission remove (permission) [player]``<br/>
+Permission: ``fancycore.commands.removepermfromplayer``
+
+### Check Player Permission
+
+Description: Checks if the targeted player has the specified permission.<br/>
+Syntax: ``/Permission check (permission) [player]``<br/>
+Permission: ``fancycore.commands.checkplayerperm``
+
+### List Player Permissions
+
+Description: Lists all permissions of the targeted player.<br/>
+Syntax: ``/Permission list [player]``<br/>
+Permission: ``fancycore.commands.listplayerperms``
--- a/docs/src/fancycore/commands/player.md
+++ b/docs/src/fancycore/commands/player.md
@@ -1,7 +1,6 @@
 ---
 icon: dot
 title: Player
-order: 4
 ---

 ![](../../static/commands.png)
--- a/docs/src/fancycore/commands/server.md
+++ b/docs/src/fancycore/commands/server.md
@@ -1,7 +1,6 @@
 ---
 icon: dot
 title: Server
-order: 3
 ---

 ![](../../static/commands.png)
--- a/docs/src/fancycore/commands/teleportation.md
+++ b/docs/src/fancycore/commands/teleportation.md
@@ -1,9 +1,124 @@
 ---
 icon: dot
 title: Teleportation
-order: 5
 ---

 ![](../../static/commands.png)

 # Commands for the teleportation system
+
+## Player Teleportation
+
+### Teleport to another player
+
+Description: Teleports you or the specified player to another player's location.<br/>
+Syntax: ``/TP (target player) [destination player]`` or ``/Teleport (target player) [destination player]``<br/>
+Permission: ``fancycore.commands.tp``
+
+### Teleport another player to you
+
+Description: Teleports the specified player to your location.<br/>
+Syntax: ``/TPHere (player)`` or ``/TeleportHere (player)``<br/>
+Permission: ``fancycore.commands.tphere``
+
+### Teleport all players to you
+
+Description: Teleports all players on the server to your location.<br/>
+Syntax: ``/TPAll`` or ``/TeleportAll``<br/>
+Permission: ``fancycore.commands.tpall``
+
+### Teleport to specific coordinates
+
+Description: Teleports you to the specified coordinates<br/>
+Syntax: ``/TPPos (x) (y) (z) [world]`` or ``/TeleportPos (x) (y) (z) [world]``<br/>
+Permission: ``fancycore.commands.tppos``
+
+### Request teleport to another player
+
+Description: Sends a teleport request to another player to teleport to their location.<br/>
+Syntax: ``/TPR (player)``, ``/TPRequest (player)`` or ``/TeleportRequest (player)``<br/>
+Permission: ``fancycore.commands.tprequest``
+
+### Accept teleport request
+
+Description: Accepts a pending teleport request from another player.<br/>
+Syntax: ``/TPA [player]``, ``/TPAccept [player]`` or ``/TeleportAccept [player]``<br/>
+Permission: ``fancycore.commands.tpaccept``
+
+### Deny teleport request
+
+Description: Denies a pending teleport request from another player.<br/>
+Syntax: ``/TPD [player]``, ``/TPDeny [player]`` or ``/TeleportDeny [player]``<br/>
+Permission: ``fancycore.commands.tpdeny``
+
+### Teleport back to previous location
+
+Description: Teleports you back to your previous location before your last teleport.<br/>
+Syntax: ``/Back``<br/>
+Permission: ``fancycore.commands.back``
+
+### Teleport to last death location
+
+Description: Teleports you to the location where you last died.<br/>
+Syntax: ``/DeathBack``, ``/DeathTP`` or ``/DeathTeleport``<br/>
+Permission: ``fancycore.commands.deathback``
+
+## Spawn
+
+### Set spawn point
+
+Description: Sets the server's spawn point to your current location.<br/>
+Syntax: ``/SetSpawn``<br/>
+Permission: ``fancycore.commands.setspawn``
+
+### Teleport to spawn point
+
+Description: Teleports you to the server's spawn point.<br/>
+Syntax: ``/Spawn``<br/>
+Permission: ``fancycore.commands.spawn``
+
+## Warps
+
+### Create a warp point
+
+Description: Creates a warp point at your current location with the specified name.<br/>
+Syntax: ``/CreateWarp (name)``<br/>
+Permission: ``fancycore.commands.createwarp``
+
+### Delete a warp point
+
+Description: Deletes the warp point with the specified name.<br/>
+Syntax: ``/DeleteWarp (name)``<br/>
+Permission: ``fancycore.commands.deletewarp``
+
+### Teleport to a warp point
+
+Description: Teleports you to the warp point with the specified name.<br/>
+Syntax: ``/Warp (name)``<br/>
+Permission: ``fancycore.commands.warp.(name)``
+
+### List all warp points
+
+Description: Lists all available warp points on the server.<br/>
+Syntax: ``/ListWarps``, ``/Warps``<br/>
+Permission: ``fancycore.commands.listwarps``
+
+## Homes
+
+### Set home point
+
+Description: Sets your home point to your current location.<br/>
+Syntax: ``/SetHome (name)``<br/>
+Permission: ``fancycore.commands.sethome``
+
+### Delete home point
+
+Description: Deletes your home point with the specified name.<br/>
+Syntax: ``/DeleteHome (name)``<br/>
+Permission: ``fancycore.commands.deletehome``
+
+### Teleport to home point
+
+Description: Teleports you to your home point with the specified name or the first home if no name is provided.<br/>
+Syntax: ``/Home [name]``<br/>
+Permission: ``fancycore.commands.home``
--- a/docs/src/fancycore/commands/world.md
+++ b/docs/src/fancycore/commands/world.md
@@ -1,9 +1,54 @@
 ---
 icon: dot
 title: World
-order: 6
 ---

 ![](../../static/commands.png)

 # Commands for the world management system
+
+## World Management
+
+### Create a new world
+
+Description: Creates a new world with the specified name.<br/>
+Syntax: ``/CreateWorld (world name) [type]``<br/>
+Permission: ``fancycore.commands.createworld``
+
+### Copy an existing world
+
+Description: Creates a copy of the specified world.<br/>
+Syntax: ``/CopyWorld (source world name) (new world name)``<br/>
+Permission: ``fancycore.commands.copyworld``
+
+### Delete an existing world
+
+Description: Deletes the specified world from the server.<br/>
+Syntax: ``/DeleteWorld (world name)``<br/>
+Permission: ``fancycore.commands.deleteworld``
+
+### List all worlds
+
+Description: Lists all available worlds on the server.<br/>
+Syntax: ``/ListWorlds``, ``/Worlds``<br/>
+Permission: ``fancycore.commands.listworlds``
+
+### Teleport to a world
+
+Description: Teleports you to the specified world.<br/>
+Syntax: ``/World (world name)``<br/>
+Permission: ``fancycore.commands.world``
+
+## Utility Commands
+
+### Set weather
+
+Description: Sets the weather in the current world.<br/>
+Syntax: ``/SetWeather (sun|rain)``<br/>
+Permission: ``fancycore.commands.setweather``
+
+### Set time
+
+Description: Sets the time of day in the current world.<br/>
+Syntax: ``/SetTime (time)``<br/>
+Permission: ``fancycore.commands.settime``
--- a/docs/src/fancycore/fancycore.md
+++ b/docs/src/fancycore/fancycore.md
@@ -9,7 +9,7 @@ order: 90
 ![](../static/logos-and-banners/fancycore-banner.png)

 !!!
-Essential feature every Hytale server needs. From permission management over world management to economy and more.
+Essential features every Hytale server needs. From permission management over world management to economy and more.
 !!!

 ## Features
@@ -21,6 +21,7 @@ With FancyCore, you get a wide variety of features that are essential for runnin
 - **Chat**: advanced chat management with channels, formatting, nicknames and msgs
 - **Moderation**: tools for server admins including bans, kicks, warnings, and logs
 - **World**: create and manage multiple worlds with different settings and environments
+- **Inventory**: manage player inventories, kits and player backpacks
 - **Teleportation**: spawn point, warps, player homes, and teleport requests
 - **Player**: utility commands such as fly, speed, gamemode, heal, and more
 - **Server**: view server stats and manage plugins