Fabric Custom Names

This mod adds three useful commands to Minecraft: /name, /itemname, and /itemlore, which allow players to configure prefixes, suffixes, and nicknames, as well as give items colored names and descriptions. Primarily designed for small private servers, but with the name group system, you can restrict which players can use specific prefixes, suffixes, and nicknames.

The mod also supports prefixes and suffixes set via LuckPerms!

Supported Versions

Support is maintained for the latest major and minor versions of Minecraft. Updates for new versions may sometimes be delayed.

Usage

The mod is oriented towards Fabric servers but also works on the client. Requires Fabric API.

/name Command

• /name prefix - sets a prefix for your name, or clears it if no prefix is given
  • Requires operator or customname.prefix permission
• /name suffix - sets a suffix for your name, or clears it if no suffix is given
  • Requires operator or customname.suffix permission
• /name nickname - sets a nickname that will appear instead of your original name, or clears it if no nickname is given
  • Requires operator or customname.nick permission
• /name other <prefix|suffix|nickname> <player> - similar to the respective commands, but for setting another player's prefix/suffix/nickname
  • Requires operator or customname.other permission in addition to the respective permission

When hovering over a player's name with advanced tooltips enabled, their real name will be displayed.

Item Commands

• /itemname - renames the item you're holding
  • Requires operator or customname.itemname permission
• /itemlore - sets the description for the item you're holding
  • Requires operator or customname.itemlore permission
  • \n is used to create new lines, \ to escape a backslash

Running the commands without arguments resets the item's name/description.

Formatting

You can use Minecraft formatting codes to style prefixes, suffixes, nicknames, and item names. Instead of the § character, use & (to use & in a name, type &&). The &#<hex code> format for colors is also supported.

The use of formatting codes in names can be disabled in the configuration file.

Configuration

The configuration file is located at {root config directory}/eclipsescustomname.json. By default, it looks like this:

{
  "enable_formatting": true,
  "require_permissions": true,
  "blacklisted_names": [],
  "max_name_length": 16,
  "operators_bypass_restrictions": false,
  "display_above_player": false,
  "name_groups": {
    "prefix": {},
    "nickname": {},
    "suffix": {}
  }
}

• enable_formatting - disables the use of formatting codes in names
• require_permissions - disables the permission requirement
• blacklisted_names - list of regular expressions for banned names
• max_name_length - maximum length of prefix/nickname/suffix (maximum 32)
• operators_bypass_restrictions - disables restrictions for operators
• display_above_player - displays the custom name above the player's head
• name_groups - creates name groups for each type

Example Name Groups

"name_groups": {
  "prefix": {
    "vip": [
      "&f&l[&7VIP&f&l]",
      "&f&l[&9VIP&f&l]",
      "&f&l[&aVIP&f&l]",
      "&f&l[&bVIP&f&l]",
      "&f&l[&cVIP&f&l]"
    ],
    "legendary": [
      "&f&l[&7Legendary&f&l]",
      "&f&l[&9Legendary&f&l]",
      "&f&l[&aLegendary&f&l]",
      "&f&l[&bLegendary&f&l]",
      "&f&l[&cLegendary&f&l]"
    ]
  },
  "nickname": {},
  "suffix": {}
}

You can give players the customname.group.prefix.vip permission to use prefixes from the vip group and customname.group.prefix.legendary for prefixes from the legendary group. Players will see these prefixes in suggestions when entering the /name prefix command, and when running the command without arguments, a menu will appear for selecting a prefix.

Note that granting players the customname.prefix permission will still allow them to use any prefix. Everything mentioned above also applies to nicknames and suffixes.