SimpleNicks
Simple Nickname plugin that allows usage of minimessage tagging
Install / Use
/learn @Simplexity-Development/SimpleNicksREADME
Features
<table> <tr> <td valign="middle"> <strong>Set Nicknames With <a href="https://docs.advntr.dev/minimessage/">MiniMessage</a></strong><br> Use MiniMessage formatting in nicknames. </td> <td> <img width="430" height="117" alt="" src="https://github.com/user-attachments/assets/cbb35336-8cc6-4297-9c45-d160a342a1db" /> </td> </tr> <tr> <td valign="middle"> <strong>Allow Nicknames in Tab List</strong><br> Display player nicknames in the tab list. </td> <td> <img width="210" height="45" alt="" src="https://github.com/user-attachments/assets/91a8af30-6224-47b7-a70a-f5fd9bc9f594" /> </td> </tr> <tr> <td valign="middle"> <strong>Save Nicknames</strong><br> Nicknames can be saved for future use, like in roleplaying. </td> <td> <img width="599" height="137" alt="" src="https://github.com/user-attachments/assets/594d2bd2-777c-436c-a41b-6c1647b0f7b6" /> </td> </tr> <tr> <td valign="middle"> <strong>Nickname Protection</strong><br> Prevent confusion with username / nickname copying. </td> <td> <img width="665" height="119" alt="" src="https://github.com/user-attachments/assets/e78e8615-f173-4adf-8160-b726e48fb5e7" /> </td> </tr> <tr> <td valign="middle"> <strong>"Who Is That?"</strong><br> Find out a player's secret identity. </td> <td> <img width="367" height="155" alt="" src="https://github.com/user-attachments/assets/f93ad1a5-ffcc-4bbf-9562-aa223385fd57" /> </td> </tr> </table>And More
- Permissions support, use something like LuckPerms.
- SQL-based storage, choose between MySQL (Server) or SQLite (Local, default).
- No, you do not need any SQL setup to run this plugin.
- Control whether specific nickname functionality requires permissions.
- Control how long a username or nickname is protected for.
- Nickname prefixing, so you know who is hiding their identity.
- PlaceholderAPI expansion, so you can put the nicknames wherever you need to.
Commands
Player Commands
| Command | Description |
|-|-|
| /nick help | Displays help text. |
| /nick set <nickname>| Sets your nickname.<br>Supports MiniMessage formatting. |
| /nick save [nickname] | Saves your current nickname for later use.<br>You can also provide a nickname to save directly. |
| /nick delete <nickname> | Deletes one of your saved nicknames. |
| /nick reset | Resets your nickname to your original username. |
| /nick who <nickname> | Displays the username of the player with the supplied nickname. |
Admin Commands
| Command | Description |
|-|-|
| /nick admin set <username> <nickname> | Sets another player’s nickname.<br>Uses the admin’s permissions for formatting. |
| /nick admin reset <username> | Resets another player’s nickname. |
| /nick admin delete <username> <nickname> | Deletes a saved nickname from a player’s list. |
| /nick admin lookup <username> | Displays a player’s current nickname and all saved nicknames.|
| /nick reload | Reloads the configuration and locale. |
Permissions
Player Permissions
| Permission | Description | Default |
|--------------------------|--------------------------------------------------|---------|
| simplenick.nick.set | Set your own nickname. | op |
| simplenick.nick.reset | Reset your own nickname. | op |
| simplenick.nick.delete | Delete one of your saved nicknames. | op |
| simplenick.nick.who | Use /nick who <nickname> to look up usernames. | true |
Color Permissions
| Permission | Description | Default |
|-----------------------------|----------------------------------------------|---------|
| simplenick.color.basic | Use color tags (<red>, <color:#aabbcc>). | op |
| simplenick.color.gradient | Use gradient tags (<gradient:red:blue>). | op |
| simplenick.color.rainbow | Use <rainbow>. | op |
| simplenick.color.reset | Use <reset>. | op |
Format Permissions
| Permission | Description | Default |
|-----------------------------------|-----------------------|---------|
| simplenick.format.bold | Use <b>/</b>. | op |
| simplenick.format.italic | Use <i>/</i>. | op |
| simplenick.format.underline | Use <u>/</u>. | op |
| simplenick.format.strikethrough | Use <st>/</st>. | op |
| simplenick.format.obfuscated | Use <obf>/</obf>. | op |
Admin Permissions
| Permission | Description | Default |
|---------------------------|------------------------------------------------|---------|
| simplenick.admin.set | Set another player’s nickname. | op |
| simplenick.admin.reset | Reset another player’s nickname. | op |
| simplenick.admin.delete | Delete a saved nickname from another player. | op |
| simplenick.admin.lookup | Lookup a player’s current and saved nicknames. | op |
| simplenick.reload | Reload plugin configuration and locale. | op |
Bypass Permissions
| Permission | Description | Default |
|-------------------------------------|------------------------------------------------------|---------|
| simplenick.bypass.username | Use another player’s username as a nickname. | false |
| simplenick.bypass.length | Set nicknames longer than the configured max length. | false |
| simplenick.bypass.regex | Set nicknames that don’t match the configured regex. | false |
| simplenick.bypass.nick-protection | Bypass nickname protection (online/offline/expires). | false |
PlaceholderAPI
All placeholders now start with simplenick for consistency.
| Placeholder | Description | Example |
|----------------------------------|------------------------------------------|---------|
| %simplenick_nickname% | Player’s parsed nickname. |<img width="167" height="20" alt="" src="https://github.com/user-attachments/assets/08cee7cf-8cbd-4ee9-9453-e7db16ec1b17" />|
| %simplenick_mininick% | Player’s raw MiniMessage nickname. |<img width="264" height="21" alt="" src="https://github.com/user-attachments/assets/350ed8a8-da73-4c10-8332-cff65d1c3f05" />|
| %simplenick_prefixed-nickname% | Nickname with configured prefix applied. |<img width="167" height="20" alt="" src="https://github.com/user-attachments/assets/bb591810-9c60-42fd-9005-0d68b1408f3e" />|
| %simplenick_prefixed-mininick% | Raw MiniMessage nickname with prefix. |<img width="264" height="21" alt="" src="https://github.com/user-attachments/assets/70785e7c-94e7-4bcc-9128-a7db9293554b" />|
Configuration
MySQL
Plugin uses a local .db SQLite by default. This requires no additional setup but cannot be shared between a network of servers.
If you would like to use MySQL, you can do so by enabling it and filling out the information in the configuration.
mysql:
enabled: false
ip: "localhost:3306"
name: simplenicks
username: username1
password: badpassword!
Nickname Length
This is the max length that someone's nickname can be after the colors and formats have been figured out.
So, if you're doing a nickname like
<blue>ThisIs</blue><green>AConvoluted</green><rainbow>Exam</rainbow><b>ple</b>
the text that will be checked will be ThisIsAConvolutedExample.
[!Warning] It's not recommended to set the value below 3, as there may be unintended side effects.
# The max amount of characters a nickname should be, not including formatting
# (so a name like <red>Billy<yellow>Bob would only count 'BillyBob' - and would be 8 characters)
# Setting this number to any number below "3" could cause unintended side effects
max-nickname-length: 30
Nickname Regex
This is the allowed characters in a nickname. The default allows only alphanumeric characters and underscores [A-Za-z0-9_]+ - you can add additional characters into this, use a resource like https://regexr.com/ to make sure your regex properly parses.
[!Warning] Using non-alphanumeric characters is generally unsupported and can have unintended side effects.
# The regex of valid final nickname characters.
# Be warned that putting non-alphanumeric characters may result in issues with other plugins and other unintended side effects
nickname-regex: "[A-Za-z0-9_]+"
Require Permission
These set whether or not specific functionalities require a permission. If you don't know what a permissions plugin is, and you just want the plugin to work, you can set the functions you want to 'false'. If you do know what permissions are and how to use them, you probably don't need this section.
Nick
Gives functionality for:
/nick set/nick reset/nick saveAllows a player to change the name they appear as.
