Custom Names

This mod adds a /name, a /itemname and a /itemlore command to Minecraft, which players can use to set a prefix, suffix, or nickname, or give their items colourful names and lore. Mostly designed to be used in small, private servers.

Supports prefixes/suffixes set with LuckPerms as well!

Feel free to report any bugs, or suggest new features, at the issue tracker.

License

This mod is licensed under GNU LGPLv3.

Donating

If you like this mod, consider donating! It really helps me a ton!

Usage

This mod is oriented at Fabric Minecraft servers, but works on the client as well. This mod requires the Fabric API, and is currently available for Minecraft 1.21+1 (1.20.5+6, 1.20.4, 1.20.1, 1.19.4 and 1.19.2 ports exist, but are no longer updated). You can make a version port request at the issue tracker.

The /name command can be used as follows:

• /name prefix - sets a prefix for your name, or when no prefix is given, clears your prefix.
  • Requires operator or the customname.prefix permission.
• /name suffix - sets a suffix for your name, or when no suffix is given, clears your suffix.
  • Requires operator or the customname.suffix permission.
• /name nickname - sets a nickname that will appear instead of your IGN. When hovered above this nickname, your IGN will show. When no nickname is given, clears your nickname.
  • Requires operator or the customname.nick permission.

The /itemname command can be used to rename the item you're currently holding. Requires operator or the customname.itemname permission. Similarly, the /itemlore can be used to set the lore of an item you're holding. Requires operator or the customname.itemlore permission.

Minecraft's formatting codes can be used to format your prefix, suffix, nickname, or your item names/lores. Instead of the § character, use & (to use & in an (item)name, type &&). Alongside Minecraft's default formatting codes, the &#<hex code> format can be used as well.

Useful tools to easily create formatted names are available here and here. Usage of formatting codes in names can be disabled in the config file.

Alongside the /name command, this mod also supports reading prefixes and suffixes from the LuckPerms mod.

Config file

The mod's configuration file is present in {root config directory}/eclipsescustomname.json. By default, the configuration file looks like this:

{
  "enable_formatting": true,
  "require_permissions": true,
  "blacklisted_names": [],
  "max_name_length": 16
}

• enable_formatting can be used to disable the use of Minecraft formatting codes in names.
• require_permissions can be used to disable the permission requirement. When set to false, the /name, /itemname and /itemlore commands are available to everyone.
• blacklisted_names is a list of regexes that are blacklisted. When a prefix, suffix or nickname matches one of these regexes, they won't be able to be used.
• max_name_length controls how long a player prefix/nickname/suffix can be, which can be 32 at most.