From 18518f9c198e0487876916d5d63f480d064b75d4 Mon Sep 17 00:00:00 2001 From: Oliver Date: Sun, 23 Nov 2025 16:58:06 +0100 Subject: [PATCH] docs: Add some command documentation for FancyCore --- docs/src/fancycore/commands/chat.md | 1 - docs/src/fancycore/commands/economy.md | 1 - docs/src/fancycore/commands/inventory.md | 74 ++++++++++++ docs/src/fancycore/commands/moderation.md | 98 +++++++++++++++- docs/src/fancycore/commands/permissions.md | 95 ++++++++++++++- docs/src/fancycore/commands/player.md | 1 - docs/src/fancycore/commands/server.md | 1 - docs/src/fancycore/commands/teleportation.md | 117 ++++++++++++++++++- docs/src/fancycore/commands/world.md | 47 +++++++- docs/src/fancycore/fancycore.md | 3 +- 10 files changed, 429 insertions(+), 9 deletions(-) create mode 100644 docs/src/fancycore/commands/inventory.md diff --git a/docs/src/fancycore/commands/chat.md b/docs/src/fancycore/commands/chat.md index 92673c9f..113223c2 100644 --- 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) diff --git a/docs/src/fancycore/commands/economy.md b/docs/src/fancycore/commands/economy.md index a191f27a..96c31266 100644 --- 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) diff --git a/docs/src/fancycore/commands/inventory.md b/docs/src/fancycore/commands/inventory.md new file mode 100644 index 00000000..12ac0b96 --- /dev/null +++ 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
+Syntax: ``/CreateKit (name)``
+Permission: ``fancycore.commands.createkit`` + +### Delete Kit + +Description: Deletes the specified kit.
+Syntax: ``/DeleteKit (name)``
+Permission: ``fancycore.commands.deletekit`` + +### Give Kit + +Description: Gives the specified kit to the targeted player(s).
+Syntax: ``/Kit (name) [player]``
+Permission: ``fancycore.commands.kit.(name)`` + +### List Kits + +Description: Lists all available kits.
+Syntax: ``/Kits`` or ``/ListKits``
+Permission: ``fancycore.commands.listkits`` + +## Backpacks + +### Open Backpack + +Description: Opens the specified backpack of the targeted player.
+Syntax: ``/Backpack (name) [player]``
+Permission: ``fancycore.commands.backpack`` + +### Create Backpack + +Description: Creates a new backpack with the specified name and size.
+Syntax: ``/CreateBackpack (name) (size)``
+Permission: ``fancycore.commands.createbackpack`` + +### Delete Backpack + +Description: Deletes the specified backpack.
+Syntax: ``/DeleteBackpack (name)``
+Permission: ``fancycore.commands.deletebackpack`` + +### List Backpacks + +Description: Lists all available backpacks.
+Syntax: ``/Backpacks`` or ``/ListBackpacks``
+Permission: ``fancycore.commands.listbackpacks`` + +## Utilities + +### Clear Inventory + +Description: Clears the inventory of the targeted player(s).
+Syntax: ``/ClearInventory [player]``
+Permission: ``fancycore.commands.clearinventory`` + +### Open another Player's Inventory + +Description: Opens the inventory of the targeted player.
+Syntax: ``/OpenInventory (player)`` or ``/Invsee (player)``
+Permission: ``fancycore.commands.openinventory`` \ No newline at end of file diff --git a/docs/src/fancycore/commands/moderation.md b/docs/src/fancycore/commands/moderation.md index 6525bc21..71ab10e3 100644 --- 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.
+Syntax: ``/Report (player) [reason]``
+Permission: ``fancycore.commands.report`` + +### List Reports + +Description: Lists all active player reports.
+Syntax: ``/Reports list``
+Permission: ``fancycore.commands.reports.list`` + +### View Report Details + +Description: Views details of a specific report.
+Syntax: ``/Reports view (reportID)``
+Permission: ``fancycore.commands.reports.view`` + +### Close Report + +Description: Closes a specific report.
+Syntax: ``/Reports close (reportID)``
+Permission: ``fancycore.commands.reports.close`` + +## Warn + +### Warn a Player + +Description: Issues a warning to a player.
+Syntax: ``/Warn (player) [reason]``
+Permission: ``fancycore.commands.warn`` + +## Mute + +### Mute a Player + +Description: Mutes a player, preventing them from sending chat messages.
+Syntax: ``/Mute (player) [reason]``
+Permission: ``fancycore.commands.mute`` + +### Temporary Mute a Player + +Description: Temporarily mutes a player for a specified duration.
+Syntax: ``/Tempmute (player) (duration) [reason]``
+Permission: ``fancycore.commands.tempmute`` + +### Unmute a Player + +Description: Unmutes a player.
+Syntax: ``/Unmute (player)``
+Permission: ``fancycore.commands.unmute`` + + +## Kick + +### Kick a Player + +Description: Kicks a player from the server.
+Syntax: ``/Kick (player) [reason]``
+Permission: ``fancycore.commands.kick`` + +## Ban + +### Ban a Player + +Description: Bans a player from the server.
+Syntax: ``/Ban (player) [reason]``
+Permission: ``fancycore.commands.ban`` + +### Temporary Ban a Player + +Description: Temporarily bans a player from the server for a specified duration.
+Syntax: ``/Tempban (player) (duration) [reason]``
+Permission: ``fancycore.commands.tempban`` + +### Unban a Player + +Description: Unbans a player from the server.
+Syntax: ``/Unban (player)``
+Permission: ``fancycore.commands.unban`` + +## Logs + +### View Moderation Logs + +Description: Views the moderation logs.
+Syntax: ``/Modlogs [player]``
+Permission: ``fancycore.commands.modlogs`` + +### View Chat Logs + +Description: Views the chat logs.
+Syntax: ``/Chatlogs [player] [--withCommands]``
+Permission: ``fancycore.commands.chatlogs`` diff --git a/docs/src/fancycore/commands/permissions.md b/docs/src/fancycore/commands/permissions.md index d45b7b2c..c40557ce 100644 --- 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.
+Syntax: ``/Groups create (name)``
+Permission: ``fancycore.commands.creategroup`` + +### Delete Group + +Description: Deletes the specified permission group.
+Syntax: ``/Groups delete (name)``
+Permission: ``fancycore.commands.deletegroup`` + +### List Groups + +Description: Lists all available permission groups.
+Syntax: ``/Groups list``
+Permission: ``fancycore.commands.listgroups`` + +### Info Group + +Description: Displays information about the specified permission group.
+Syntax: ``/Groups info (name)``
+Permission: ``fancycore.commands.infogroup`` + +### Set Parent Group + +Description: Sets the parent group for the specified permission group.
+Syntax: ``/Groups parent (group) set (parent)``
+Permission: ``fancycore.commands.setparentgroup`` + +### Add Permission to Group + +Description: Adds the specified permission to the permission group.
+Syntax: ``/Groups permission (group) add (permission)``
+Permission: ``fancycore.commands.addpermtogroup`` + +### Remove Permission from Group + +Description: Removes the specified permission from the permission group.
+Syntax: ``/Groups permission (group) remove (permission)``
+Permission: ``fancycore.commands.removepermfromgroup`` + +### Set Prefix for Group + +Description: Sets the prefix for the specified permission group.
+Syntax: ``/Groups prefix (group) set (prefix)``
+Permission: ``fancycore.commands.setprefixforgroup`` + +### Set Suffix for Group + +Description: Sets the suffix for the specified permission group.
+Syntax: ``/Groups suffix (group) set (suffix)``
+Permission: ``fancycore.commands.setsuffixforgroup`` + +### Add Player to Group + +Description: Adds the specified player to the permission group.
+Syntax: ``/Groups player (player) add (group)``
+Permission: ``fancycore.commands.addplayertogroup`` + +### Remove Player from Group + +Description: Removes the specified player from the permission group.
+Syntax: ``/Groups player (player) remove (group)``
+Permission: ``fancycore.commands.removeplayerfromgroup`` + +## Player Permissions + +### Add Permission to Player + +Description: Adds the specified permission to the targeted player.
+Syntax: ``/Permission add (permission) [player]``
+Permission: ``fancycore.commands.addpermtoplayer`` + +### Remove Permission from Player + +Description: Removes the specified permission from the targeted player.
+Syntax: ``/Permission remove (permission) [player]``
+Permission: ``fancycore.commands.removepermfromplayer`` + +### Check Player Permission + +Description: Checks if the targeted player has the specified permission.
+Syntax: ``/Permission check (permission) [player]``
+Permission: ``fancycore.commands.checkplayerperm`` + +### List Player Permissions + +Description: Lists all permissions of the targeted player.
+Syntax: ``/Permission list [player]``
+Permission: ``fancycore.commands.listplayerperms`` diff --git a/docs/src/fancycore/commands/player.md b/docs/src/fancycore/commands/player.md index 082e856a..0cd3e584 100644 --- 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) diff --git a/docs/src/fancycore/commands/server.md b/docs/src/fancycore/commands/server.md index 9111cbe8..5d84ed03 100644 --- 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) diff --git a/docs/src/fancycore/commands/teleportation.md b/docs/src/fancycore/commands/teleportation.md index a8d1c0ac..7c804a75 100644 --- 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.
+Syntax: ``/TP (target player) [destination player]`` or ``/Teleport (target player) [destination player]``
+Permission: ``fancycore.commands.tp`` + +### Teleport another player to you + +Description: Teleports the specified player to your location.
+Syntax: ``/TPHere (player)`` or ``/TeleportHere (player)``
+Permission: ``fancycore.commands.tphere`` + +### Teleport all players to you + +Description: Teleports all players on the server to your location.
+Syntax: ``/TPAll`` or ``/TeleportAll``
+Permission: ``fancycore.commands.tpall`` + +### Teleport to specific coordinates + +Description: Teleports you to the specified coordinates
+Syntax: ``/TPPos (x) (y) (z) [world]`` or ``/TeleportPos (x) (y) (z) [world]``
+Permission: ``fancycore.commands.tppos`` + +### Request teleport to another player + +Description: Sends a teleport request to another player to teleport to their location.
+Syntax: ``/TPR (player)``, ``/TPRequest (player)`` or ``/TeleportRequest (player)``
+Permission: ``fancycore.commands.tprequest`` + +### Accept teleport request + +Description: Accepts a pending teleport request from another player.
+Syntax: ``/TPA [player]``, ``/TPAccept [player]`` or ``/TeleportAccept [player]``
+Permission: ``fancycore.commands.tpaccept`` + +### Deny teleport request + +Description: Denies a pending teleport request from another player.
+Syntax: ``/TPD [player]``, ``/TPDeny [player]`` or ``/TeleportDeny [player]``
+Permission: ``fancycore.commands.tpdeny`` + +### Teleport back to previous location + +Description: Teleports you back to your previous location before your last teleport.
+Syntax: ``/Back``
+Permission: ``fancycore.commands.back`` + +### Teleport to last death location + +Description: Teleports you to the location where you last died.
+Syntax: ``/DeathBack``, ``/DeathTP`` or ``/DeathTeleport``
+Permission: ``fancycore.commands.deathback`` + +## Spawn + +### Set spawn point + +Description: Sets the server's spawn point to your current location.
+Syntax: ``/SetSpawn``
+Permission: ``fancycore.commands.setspawn`` + +### Teleport to spawn point + +Description: Teleports you to the server's spawn point.
+Syntax: ``/Spawn``
+Permission: ``fancycore.commands.spawn`` + +## Warps + +### Create a warp point + +Description: Creates a warp point at your current location with the specified name.
+Syntax: ``/CreateWarp (name)``
+Permission: ``fancycore.commands.createwarp`` + +### Delete a warp point + +Description: Deletes the warp point with the specified name.
+Syntax: ``/DeleteWarp (name)``
+Permission: ``fancycore.commands.deletewarp`` + +### Teleport to a warp point + +Description: Teleports you to the warp point with the specified name.
+Syntax: ``/Warp (name)``
+Permission: ``fancycore.commands.warp.(name)`` + +### List all warp points + +Description: Lists all available warp points on the server.
+Syntax: ``/ListWarps``, ``/Warps``
+Permission: ``fancycore.commands.listwarps`` + +## Homes + +### Set home point + +Description: Sets your home point to your current location.
+Syntax: ``/SetHome (name)``
+Permission: ``fancycore.commands.sethome`` + +### Delete home point + +Description: Deletes your home point with the specified name.
+Syntax: ``/DeleteHome (name)``
+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.
+Syntax: ``/Home [name]``
+Permission: ``fancycore.commands.home`` \ No newline at end of file diff --git a/docs/src/fancycore/commands/world.md b/docs/src/fancycore/commands/world.md index 24c72274..de5a7fe3 100644 --- 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.
+Syntax: ``/CreateWorld (world name) [type]``
+Permission: ``fancycore.commands.createworld`` + +### Copy an existing world + +Description: Creates a copy of the specified world.
+Syntax: ``/CopyWorld (source world name) (new world name)``
+Permission: ``fancycore.commands.copyworld`` + +### Delete an existing world + +Description: Deletes the specified world from the server.
+Syntax: ``/DeleteWorld (world name)``
+Permission: ``fancycore.commands.deleteworld`` + +### List all worlds + +Description: Lists all available worlds on the server.
+Syntax: ``/ListWorlds``, ``/Worlds``
+Permission: ``fancycore.commands.listworlds`` + +### Teleport to a world + +Description: Teleports you to the specified world.
+Syntax: ``/World (world name)``
+Permission: ``fancycore.commands.world`` + +## Utility Commands + +### Set weather + +Description: Sets the weather in the current world.
+Syntax: ``/SetWeather (sun|rain)``
+Permission: ``fancycore.commands.setweather`` + +### Set time + +Description: Sets the time of day in the current world.
+Syntax: ``/SetTime (time)``
+Permission: ``fancycore.commands.settime`` \ No newline at end of file diff --git a/docs/src/fancycore/fancycore.md b/docs/src/fancycore/fancycore.md index ecd02d86..8811ee39 100644 --- 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