diff --git a/docs/src/fancycore/api/events.md b/docs/src/fancycore/api/events.md index 63743e12..8f2dbb65 100644 --- a/docs/src/fancycore/api/events.md +++ b/docs/src/fancycore/api/events.md @@ -3,7 +3,7 @@ icon: dot order: 9 --- -# Events +# Events API FancyCore has its own event system that allows you to listen to various events that happen in the FancyCore system. diff --git a/docs/src/fancycore/api/punishments.md b/docs/src/fancycore/api/punishments.md new file mode 100644 index 00000000..6cbf0ae3 --- /dev/null +++ b/docs/src/fancycore/api/punishments.md @@ -0,0 +1,38 @@ +--- +icon: dot +order: 8 +--- + +# Punishment API + +FancyCore provides a comprehensive Punishment API that allows you to manage player punishments such as warnings, kicks, mutes, and bans. + +## Using the Punishment Service + +With the Punishment Service, you can easily issue various types of punishments to players. Below are examples of how to use the Punishment Service: + +```java +PunishmentService punishmentService = FancyCore.get().getPunishmentService(); + +punishmentService.warnPlayer(player, staff, "reason", duration); + +punishmentService.mutePlayer(player, staff, "reason"); // Permanent mute +punishmentService.mutePlayer(player, staff, "reason", 1000*60*60*4); // Temporary mute (4 hours) + +punishmentService.kickPlayer(player, staff, "reason"); + +punishmentService.banPlayer(player, staff, "reason", duration); // Permanent ban +punishmentService.banPlayer(player, staff, "reason", 1000*60*60*24); // Temporary ban (1 day) +``` + +You can also retrieve existing punishments for a player: + +```java +List punishments = punishmentService.getPunishmentsForPlayer(player); +``` + +Player reports are also managed through the Punishment Service: + +```java +punishmentService.reportPlayer(player, staff, "reason"); +``` \ No newline at end of file diff --git a/docs/src/fancycore/commands/chat.md b/docs/src/fancycore/commands/chat.md index 7d6c728c..25923900 100644 --- a/docs/src/fancycore/commands/chat.md +++ b/docs/src/fancycore/commands/chat.md @@ -7,6 +7,11 @@ title: Chat # Commands for the chat system +!!!warning +The command list is not complete and not all commands are properly documented yet. +Some commands might not be implemented yet. +!!! + ## Messages ### Message diff --git a/docs/src/fancycore/commands/economy.md b/docs/src/fancycore/commands/economy.md index 436e1d50..64812dd7 100644 --- a/docs/src/fancycore/commands/economy.md +++ b/docs/src/fancycore/commands/economy.md @@ -7,6 +7,11 @@ title: Economy # Commands for the economy system +!!!warning +The command list is not complete and not all commands are properly documented yet. +Some commands might not be implemented yet. +!!! + ### Balance Description: Displays the balance of the specified player or your own balance if no player is specified.
diff --git a/docs/src/fancycore/commands/inventory.md b/docs/src/fancycore/commands/inventory.md index 12ac0b96..9a4a6ff8 100644 --- a/docs/src/fancycore/commands/inventory.md +++ b/docs/src/fancycore/commands/inventory.md @@ -7,6 +7,11 @@ title: Inventory # Commands for the inventory system +!!!warning +The command list is not complete and not all commands are properly documented yet. +Some commands might not be implemented yet. +!!! + ## Kits ### Create Kit diff --git a/docs/src/fancycore/commands/moderation.md b/docs/src/fancycore/commands/moderation.md index 71ab10e3..94561f73 100644 --- a/docs/src/fancycore/commands/moderation.md +++ b/docs/src/fancycore/commands/moderation.md @@ -7,6 +7,11 @@ title: Moderation # Commands for the moderation system +!!!warning +The command list is not complete and not all commands are properly documented yet. +Some commands might not be implemented yet. +!!! + ## Report ### Report a Player diff --git a/docs/src/fancycore/commands/permissions.md b/docs/src/fancycore/commands/permissions.md index c40557ce..2d928f53 100644 --- a/docs/src/fancycore/commands/permissions.md +++ b/docs/src/fancycore/commands/permissions.md @@ -7,6 +7,11 @@ title: Permissions # Commands for the permissions system +!!!warning +The command list is not complete and not all commands are properly documented yet. +Some commands might not be implemented yet. +!!! + ## Groups ### Create Group diff --git a/docs/src/fancycore/commands/player.md b/docs/src/fancycore/commands/player.md index 4994b18b..b041d0bd 100644 --- a/docs/src/fancycore/commands/player.md +++ b/docs/src/fancycore/commands/player.md @@ -7,6 +7,11 @@ title: Player # Commands for the player system +!!!warning +The command list is not complete and not all commands are properly documented yet. +Some commands might not be implemented yet. +!!! + ### Gamemode Description: Changes the gamemode of a player.
diff --git a/docs/src/fancycore/commands/server.md b/docs/src/fancycore/commands/server.md index 1c73e246..c062d12c 100644 --- a/docs/src/fancycore/commands/server.md +++ b/docs/src/fancycore/commands/server.md @@ -7,6 +7,11 @@ title: Server # Commands for the server system +!!!warning +The command list is not complete and not all commands are properly documented yet. +Some commands might not be implemented yet. +!!! + ## Server control ### Restart diff --git a/docs/src/fancycore/commands/teleportation.md b/docs/src/fancycore/commands/teleportation.md index 7c804a75..d83e7242 100644 --- a/docs/src/fancycore/commands/teleportation.md +++ b/docs/src/fancycore/commands/teleportation.md @@ -7,6 +7,11 @@ title: Teleportation # Commands for the teleportation system +!!!warning +The command list is not complete and not all commands are properly documented yet. +Some commands might not be implemented yet. +!!! + ## Player Teleportation ### Teleport to another player diff --git a/docs/src/fancycore/commands/world.md b/docs/src/fancycore/commands/world.md index de5a7fe3..ef8de8a0 100644 --- a/docs/src/fancycore/commands/world.md +++ b/docs/src/fancycore/commands/world.md @@ -7,6 +7,11 @@ title: World # Commands for the world management system +!!!warning +The command list is not complete and not all commands are properly documented yet. +Some commands might not be implemented yet. +!!! + ## World Management ### Create a new world