New Versions
This plugin is still receiving updates and works on 1.19+ and 1.20+. However, version 3.0.0 and above only supports Paper. Version 2.2.2 is the last version to support Spigot and as such will remain posted here, though it will not receive updates. Newer versions can be downloaded here.
What is HexNicks?
HexNicks is a simple nickname plugin that allows players to set their nickname to anything they like containing normal colors, hex colors, and even gradients! It fully supports Spigot and Paper, though forks of those should work as well. There are only a few commands and permissions to limit what players use what commands. Though the plugin does have support for MySQL storage, it's mostly intended to be a simple nickname plugin for smaller Spigot/Paper servers.
Features
- Parsing via
MiniMessage - here's a
handy website to pracitce.
- Optimized support for Spigot and Paper. Forks of either should work as well.
-
PlaceholderAPI support with the placeholder
%hexnicks_nick% for player's nicknames.
- MySQL storage support for users on BungeeCord/Velocity.
- Metrics through
bStats.
- Active plugin and developer.
- Ability to format chat on it's own, no external chat formatter needed.
- Fully-featured
api for developers.
- Full documentation
here.
Commands
There are 6 plugin commands:
- /nick <nickname> - Set your own nickname.
- /nickother <player> <nickname> - Set another player's nickname.
- /nonick [player] - Remove your nickname or another player's nickname.
- /nickcolor <color> - Change the color of your nickname.
- /realname <nickname> - Get the username of the player with a specific nickname.
- /nicksreload - Reload the plugin.
Permissions
All permissions except
hexnicks.nick.other,
hexnicks.nonick.other,
hexnicks.chat.advanced, and
hexnicks.reload are given to all players by default but can be negated by a permissions manager like
LuckPerms.
-
hexnicks.nick - Permission to change your own nickname.
-
hexnicks.color.* - Permission to use all standard color codes in nicknames.
-
hexnicks.color.hex - Permission to use hex color codes in nicknames.
-
hexnicks.color.gradient - Permission to use gradients in nicknames.
-
hexnicks.nick.other - Permissions to change other player's nicknames.
-
hexnicks.nonick - Permission to remove your own nickname.
-
hexnicks.nonick.other - Permission to remove other player's nicknames.
-
hexnicks.nickcolor - Permission to use the nickcolor command to change only the nickname's color.
-
hexnicks.reload - Permission to reload the plugin.
-
hexnicks.chat.advanced - Permission to inject things like click events into chat messages via MiniMessage.
Colors
Introducing gradients!
Unless changed in the config, legacy color codes (&c, &l, etc.) are not supported. They can be losely supported when the config option is enabled, but the plugin uses
MiniMessage for colors and formatting.
Now HexNicks makes it easy to get beautiful gradients in your nicknames. The formatting is simple, for the example above the command was:
Code (Text):
/nick <gradient:#1eae98:#d8b5ff>Majekdor</gradient>
Note: The closing tag is optional if you don't want anything after the initial text.
The first gradient tag can also take more than 2 hex codes, though they must be in the standard six-character hex format.
View a bunch of hex codes
here.
Developers
HexNicks does have an api and all commands trigger an event when executed. These events can be listened to the same way as other Bukkit events. You can see the events
here and all JavaDocs
here.
Event example:
Code (Text):
@EventHandler
public void onNickname(SetNickEvent event) {
Player player = event.player();
player.sendMessage("Setting nickname...");
event.newNick(Component.text("New nickname"));
}
There are multiple ways to retrieve nicknames, but the easiest way is:
Code (Text):
Nicks.api().getNick(player); // You can pass thru a player, offlineplayer, or uuid
Support
If you need help with the plugin and can't find the answer on Spigot, then the best way to get help is to join my
Discord. Make sure you read the frequently-asked channel before posting in the bug-reports channel (if it's a bug) or in the hexnicks channel (for general help).
If you have discovered a bug you can either join my
Discord and report it there or open an issue on
GitHub. Please do not message me on Spigot in regard to a bug, there are easier ways to communicate.
![[IMG]](//proxy.spigotmc.org/15706237070df1033f81c13b83218fbd745b63d9/68747470733a2f2f692e696d6775722e636f6d2f617975427175552e706e67)
*Please do not post bug reports or issues as a review! The fastest way to get support is Discord!