From 7c517aa4bba17ca12c0e3dbf69012c751c36e7fe Mon Sep 17 00:00:00 2001 From: Telesphoreo Date: Mon, 2 Dec 2024 15:00:34 -0600 Subject: [PATCH] Add information on NickMiniMessage --- docs/customization/messages.md | 2 +- docs/modules/introduction.md | 17 +++++++++-------- docs/modules/nickminimessage.md | 23 +++++++++++++++++++++++ docs/permissions.md | 6 ++++++ sidebars.ts | 9 +++++---- 5 files changed, 44 insertions(+), 13 deletions(-) create mode 100644 docs/modules/nickminimessage.md diff --git a/docs/customization/messages.md b/docs/customization/messages.md index c8ccb95..9e84301 100644 --- a/docs/customization/messages.md +++ b/docs/customization/messages.md @@ -302,7 +302,7 @@ commandAliases: "Aliases for {0} are: {1}" The `messages.yml` file uses MiniMessage for coloring messages. For example, writing ``, will color the text aqua. This is not like HTML, and you should not close the tag (``). There are some special functions as well, such as ``. The default color will be gray. For a complete guide on using MiniMessage, -visit: [https://docs.adventure.kyori.net/minimessage/format.html](https://docs.adventure.kyori.net/minimessage/format.html). +visit: [https://docs.advntr.dev/minimessage/format.html](https://docs.advntr.dev/minimessage/format.html). ## Troubleshooting diff --git a/docs/modules/introduction.md b/docs/modules/introduction.md index a0cf1b3..c123b08 100644 --- a/docs/modules/introduction.md +++ b/docs/modules/introduction.md @@ -11,11 +11,12 @@ server owners who may want a specific feature that's not built in to Plex. Below is a list of official and supported modules -| Name | Versions | -|---------------|--------------| -| BukkitTelnet | 1.5 | -| HTTPD | 1.5-SNAPSHOT | -| LibsDisguises | 1.5-SNAPSHOT | -| FalseOp | 1.5-SNAPSHOT | -| NUSH | 1.5-SNAPSHOT | -| TFMExtras | 1.5-SNAPSHOT | +| Name | Versions | +|-----------------|--------------| +| BukkitTelnet | 1.5 | +| HTTPD | 1.5-SNAPSHOT | +| LibsDisguises | 1.5-SNAPSHOT | +| NickMiniMessage | 1.5 | +| FalseOp | 1.5-SNAPSHOT | +| NUSH | 1.5-SNAPSHOT | +| TFMExtras | 1.5-SNAPSHOT | diff --git a/docs/modules/nickminimessage.md b/docs/modules/nickminimessage.md new file mode 100644 index 0000000..44360cb --- /dev/null +++ b/docs/modules/nickminimessage.md @@ -0,0 +1,23 @@ +--- +id: nickminimessage +title: NickMiniMessage +--- + +# NickMiniMessage + +The NickMiniMessage module allows players to set their nickname in Essentials using MiniMessage. This module requires +EssentialsX to be on the server. + +# Commands + +## nickmm \ + +The permission for the command is `plex.nickmm`. Simply run the command with the desired nickname you would like. You +can use MiniMessage formatting. + +Examples: +- Rainbow nickname: `/nickmm MyNickname` +- One color: `/nickmm MyNickname` +- Multiple colors: `/nickmm MyNickname` + +You can find the full MiniMessage documentation [here](https://docs.advntr.dev/minimessage/format.html). \ No newline at end of file diff --git a/docs/permissions.md b/docs/permissions.md index 90127f8..2e28152 100644 --- a/docs/permissions.md +++ b/docs/permissions.md @@ -102,6 +102,12 @@ modification) are defined by the server config and may vary. | undisguiseall | plex.libsdisguises.undisguiseall | Undisguise all players | | undisguiseall | plex.libsdisguises.bypass | Bypass being undisguised. This can be overridden regardless of permission with the \`-a\` flag. | +## NickMiniMessage Module + +| Command | Permission | Description | +|---------|-------------|----------------------------------------------------| +| nickmm | plex.nickmm | Change your nickname using MiniMessage formatting! | + ## NUSH Module | Command | Permission | Description | diff --git a/sidebars.ts b/sidebars.ts index 510d954..985c0e4 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -47,12 +47,13 @@ const sidebars: SidebarsConfig = { { type: 'category', label: 'Modules', - items: ['modules/introduction', 'modules/bukkittelnet', 'modules/falseop', 'modules/httpd', 'modules/libsdisguises', 'modules/nush'], + items: ['modules/introduction', 'modules/bukkittelnet', 'modules/falseop', 'modules/httpd', + 'modules/libsdisguises', 'modules/nickminimessage', 'modules/nush'], }, { - type: 'doc', - label: 'Creating a Module', - id: 'create_module', + type: 'doc', + label: 'Creating a Module', + id: 'create_module', }, { type: 'doc',