diff --git a/CHANGELOG.md b/CHANGELOG.md index 53b1172..a6466eb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Plugin Changelog +# 3.1.1 - Dependency Bumps + +- Bumped dependencies. +- Officially added 1.20+ support (it worked already, but now I've tested it). + +This is an optional update. You will likely see no difference in game. + # 3.1.0 - Hello Hikari - Started using [HikariCP](https://github.com/brettwooldridge/HikariCP) for managing MySQL. diff --git a/docs/docs/chat-formatting.md b/docs/docs/chat-formatting.md index a7bb990..efe366d 100644 --- a/docs/docs/chat-formatting.md +++ b/docs/docs/chat-formatting.md @@ -7,9 +7,9 @@ slug: /chat-formatting The built-in chat formatter allows HexNicks to control how your chat is formatted. If you would rather use a different plugin to format your chat then HexNicks' chat formatter can always be disabled in the config. Modify the chat format to your liking in the `chat-format` field of the config -[here](https://github.com/MajekDev/HexNicks/blob/57e09bd43cfd9df96d74263f192dea6c03f3fe6f/src/main/resources/config.yml#L22). +[here](https://github.com/MajekDev/HexNicks/blob/main/src/main/resources/config.yml#L22). -> Read about the config options [here](https://github.com/MajekDev/HexNicks/wiki/Configuration-Options). +> Read about the config options [here](https://hexnicks.majek.dev/config-options). By default, the chat format is the same as vanilla Minecraft, with angle brackets around the display name (nickname). This can be changed to whatever format you like, but please remember to maintain correct YAML syntax. Use a syntax checker diff --git a/docs/docs/color-formatting.md b/docs/docs/color-formatting.md index c3805fb..392ccbb 100644 --- a/docs/docs/color-formatting.md +++ b/docs/docs/color-formatting.md @@ -5,19 +5,20 @@ slug: /color-formatting --- One of the most important parts of HexNicks is, of course, colors! With the addition of -[MiniMessage](https://github.com/KyoriPowered/adventure/tree/main/4/text-minimessage) there are now even more ways to +[MiniMessage](https://docs.advntr.dev/minimessage/index.html) there are now even more ways to customize colors in your nickname. HexNicks can support legacy colors but supports, and encourages, MiniMessage colors. ## MiniMessage Colors MiniMessage uses tags for colors and formatting. Tags have a start tag and an end tag. Start tags are mandatory (obviously), end tags aren’t. `Hello World!` and `Hello World!` and even `Hello World!` all do the same. Read the full documentation -for MiniMessage [here](https://docs.adventure.kyori.net/minimessage/format). +for MiniMessage [here](https://docs.advntr.dev/minimessage/format.html). ## Legacy Colors These are the color codes that a lot of people are still used to. Codes like `&a`, `&l`, `&x&r&r&g&g&b&b`. These are called legacy codes because the Minecraft chat, and other things, does not use raw strings anymore. -By default, HexNicks will not parse these codes. If you want to use them in your nicknames you need to enable `legacy-support` in the config. +By default, HexNicks will not parse these codes. If you want to use them in your nicknames you need to +enable `legacy-support` in the config. > See config documentation [here](https://hexnicks.majek.dev/config-options). @@ -27,6 +28,6 @@ You will **not** receive support for issues with legacy color codes. You should ## Gradients Everyone's favorite thing as of late, gradients! Gradients are parsed using MiniMessage, and you can read the -documentation for them [here](https://docs.adventure.kyori.net/minimessage/format#gradient). +documentation for them [here](https://docs.advntr.dev/minimessage/format.html#gradient). -> View nickname examples using gradients [here](https://docs.adventure.kyori.net/minimessage/format#gradient). +> View nickname examples using gradients [here](https://docs.advntr.dev/minimessage/format.html#gradient). diff --git a/docs/docs/commands.md b/docs/docs/commands.md index 3b31b2c..fc8ab64 100644 --- a/docs/docs/commands.md +++ b/docs/docs/commands.md @@ -14,7 +14,7 @@ Usage: `/nick ` This is the command players will use to change their nickname. It requires one argument (the nickname) and unless you disable `require-alphanumeric` in the -[config](https://hexnicks.majek.dev/config-options#Require-Alphanumeric) +[config](https://hexnicks.majek.dev/config-options#require-alphanumeric) then the nickname may only contain valid color codes, letters, and numbers. If you want nicknames with spaces, special characters, etc. then go ahead and disable that config option. @@ -81,7 +81,7 @@ This will either create a new link to the config file in pastebin or apply chang 1. First, execute `/hexnicks config-editor new` to create a new pastebin with your config. The command will give you the link. 2. Then, make all your desired changes to the config in the pastebin. -3. Make sure to press save in the upper left corner of the pastebin. You will get a new link. (It should copy to your clipboard automatically) +3. Make sure to press save in the upper left corner of the pastebin. You will get a new link (It should copy to your clipboard automatically). 4. Take your new link and execute `/hexnicks config-editor apply ` to apply your changes. 5. That's it! The plugin will automatically reload, and you're good to go. diff --git a/docs/docs/config-options.md b/docs/docs/config-options.md index c1d2957..7792b10 100644 --- a/docs/docs/config-options.md +++ b/docs/docs/config-options.md @@ -7,6 +7,16 @@ slug: /config-options HexNicks' [config](https://github.com/MajekDev/HexNicks/blob/main/src/main/resources/config.yml) is documented fairly well but this page will try to explain some of the more confusing bits. +# Config File Editing +You are now able to edit the plugin config file in your browser. Steps: +1. First, execute `/hexnicks config-editor new` to create a new pastebin with your config. The command will give you the link. +2. Then, make all your desired changes to the config in the pastebin. +3. Make sure to press save in the upper left corner of the pastebin. You will get a new link (It should copy to your clipboard automatically). +4. Take your new link and execute `/hexnicks config-editor apply ` to apply your changes. +5. That's it! The plugin will automatically reload, and you're good to go. + +# Options + ## Require Alphanumeric This config option requires all nicknames to contain nothing but characters a-z, lower and upper case, diff --git a/docs/docs/developers.md b/docs/docs/developers.md index 27ca627..2921fd4 100644 --- a/docs/docs/developers.md +++ b/docs/docs/developers.md @@ -22,7 +22,7 @@ HexNicks is hosted in Majekdor's Maven Repository [here](https://repo.majek.dev) dev.majek hexnicks - 3.1.0 + 3.1.1 provided @@ -38,7 +38,7 @@ repositories { } dependencies { - compileOnly "dev.majek:hexnicks:3.1.0" + compileOnly "dev.majek:hexnicks:3.1.1" } ``` diff --git a/docs/docs/home.md b/docs/docs/home.md index 7e4e587..ed3c266 100644 --- a/docs/docs/home.md +++ b/docs/docs/home.md @@ -12,8 +12,8 @@ There are only a few commands and permissions to limit what players use what com for MySQL storage, it's mostly intended to be a simple nickname plugin for smaller Paper servers. This documentation is a constant work in progress so if you feel something is missing feel free to open an issue. -The wiki is organized into different pages for things like commands, permissions, etc. If you have questions the wiki -doesn't cover, please either post in [discussions](https://github.com/Majekdor/HexNicks/discussions) or +The docs are organized into different pages for things like commands, permissions, etc. If you have questions the docs +don't cover, please either post in [discussions](https://github.com/Majekdor/HexNicks/discussions) or join my [Discord](https://discord.majek.dev). The HexNicks code lives on GitHub. If you have a bug report, or even a feature request, feel free to open an diff --git a/docs/docs/permissions.md b/docs/docs/permissions.md index 3385ccb..c49ad11 100644 --- a/docs/docs/permissions.md +++ b/docs/docs/permissions.md @@ -8,47 +8,47 @@ All permissions except `hexnicks.nick.other`, `hexnicks.nonick.other`, `hexnicks `hexnicks.config-editor`, and `hexnicks.reload` are given to all players by default but can be negated by a permissions manager like [LuckPerms](https://luckperms.net/). Learn how to do that [here](#how-to-negate-permissions-with-LuckPerms). -A lot of these permissions are tied to commands, read command documentation [here](https://github.com/Majekdor/HexNicks/wiki/Commands). +A lot of these permissions are tied to commands, read command documentation [here](https://hexnicks.majek.dev/commands). ## hexnicks.nick -This permission node allows players to use the command [/nick](https://github.com/Majekdor/HexNicks/wiki/Commands#nick) +This permission node allows players to use the command [/nick](https://hexnicks.majek.dev/commands#nick) to change their nickname. ## hexnicks.nick.other This permission node is intended for staff and allows them to use the command -[/nickother](https://github.com/Majekdor/HexNicks/wiki/Commands#nickother) to change the nickname of other players. +[/nickother](https://hexnicks.majek.dev/commands#nickother) to change the nickname of other players. ## hexnicks.nonick -This permission node allows players to use the command [/nonick](https://github.com/Majekdor/HexNicks/wiki/Commands#nonick) +This permission node allows players to use the command [/nonick](https://hexnicks.majek.dev/commands#nonick) to remove their nickname. ## hexnicks.nonick.other This permission node is intended for staff and allows them to remove the nickname of another player using -[/nonick](https://github.com/Majekdor/HexNicks/wiki/Commands#nonick). +[/nonick](https://hexnicks.majek.dev/commands#nonick). ## hexnicks.nickcolor -This permission node allows players to use [/nickcolor](https://github.com/Majekdor/HexNicks/wiki/Commands#nickcolor) +This permission node allows players to use [/nickcolor](https://hexnicks.majek.dev/commands#nickcolor) to change just the color of their nickname. ## hexnicks.realname -This permission node allows players to use [/realname](https://github.com/Majekdor/HexNicks/wiki/Commands#realname) +This permission node allows players to use [/realname](https://hexnicks.majek.dev/commands#realname) to view the name of a player using a certain nickname. ## hexnicks.config-editor This permission node is intended for staff and allows them to edit the HexNicks config via -[pastebin](https://paste.majek.dev) using [/hexnicks config-editor](https://github.com/Majekdor/HexNicks/wiki/Commands#hexnicks). +[pastebin](https://paste.majek.dev) using [/hexnicks config-editor](https://hexnicks.majek.dev/commands#hexnicks). ## hexnicks.reload This permission node is intended for staff and allows them to use -[/hexnicks reload](https://github.com/Majekdor/HexNicks/wiki/Commands#hexnicks) to reload the plugin. +[/hexnicks reload](https://hexnicks.majek.dev/commands#hexnicks) to reload the plugin. ## hexnicks.chat.advanced diff --git a/docs/docs/version-3.md b/docs/docs/version-3.md index 3cce5be..1d32a9a 100644 --- a/docs/docs/version-3.md +++ b/docs/docs/version-3.md @@ -13,7 +13,7 @@ You are now able to edit the plugin config file in your browser. Steps: 1. Type `/hexnicks config-editor new` to get a link to the config file. 2. Follow the link and make all of your changes. 3. Save the file in paste bin and copy the link. -4. Type `/hexnicks config-editor apply `, replacing `` with the link you copied +4. Type `/hexnicks config-editor apply `, replacing `` with the link you copied. 5. That's it! Your config file is updated and reloaded automatically. ### New Placeholders diff --git a/pom.xml b/pom.xml index 8e3fc7e..c9698f3 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ dev.majek hexnicks - 3.1.0 + 3.1.1 jar HexNicks @@ -41,7 +41,7 @@ org.apache.maven.plugins maven-compiler-plugin - 3.10.1 + 3.11.0 17 17 @@ -50,7 +50,7 @@ org.apache.maven.plugins maven-javadoc-plugin - 3.4.1 + 3.5.0 attach-javadocs @@ -151,7 +151,7 @@ org.jetbrains annotations - 24.0.0 + 24.0.1 compile @@ -165,7 +165,7 @@ org.bstats bstats-bukkit - 3.0.0 + 3.0.1 compile