Configuration

This page will go in-depth about how to configure DisplayTags in your server, and what each configuration property is.

config.yml

This is the configuration file for DisplayTags. You should find this in the plugins/DisplayTags/config.yml file.

Once you are done re-configuring DisplayTags, run the command /displaytags reload to apply the changes!

# ---------------------------------- #
#         DisplayTags Config         #
# ---------------------------------- #
# This is the configuration file for DisplayTags.
# To apply any changes you make here, run: /displaytags reload
# Wiki: https://github.com/imskeptical/DisplayTags/wiki

nametags:
  # Enable the nametags.
  # Set this to false if you want the vanilla player nametags shown instead.
  enabled: true

  # Should players see their own nametag?
  # Set to true to show your own nametag above your head (in first-person view).
  # Set to false to hide it.
  show-self: true

  # How often nametags should update (in seconds).
  # Lower = more frequent updates = more accurate, but slightly more CPU usage.
  # Recommended: 1 second
  update-interval: 1

  # How far away other players must be to see someone's nametag (in blocks).
  # Example: 32 = players can see nametags from up to 32 blocks away.
  visibility-distance: 32

  # Nametag Text Display Properties
  display:
    # The lines of text shown on the nametag, top to bottom.
    # Supports MiniMessage formatting: https://webui.advntr.dev/
    # PlaceholderAPI is supported for dynamic data.
    #
    # Built-in placeholders (no extra plugin needed):
    # {player}  - Player's name
    # {health}  - Player's current health (e.g. 20)
    lines:
      - "{player}"

    # Enable text shadow for the text display of a nametag.
    # Available values: true, false
    text-shadow: true

    # Should the text display of nametags be see through?
    # Available values: true, false
    see-through: false

    # The text alignment of the nametag's text display.
    # Available values: left, right, center
    text-alignment: "center"

    # The background color of the nametag's text display.
    # Use a hex color (like "#FFFFFF" for white), or "transparent" for no background.
    # Available values (excluding hex colors): default, transparent
    background: "default"

    # The billboard of the nametag's display.
    # Available values: fixed, vertical, horizontal, center
    billboard: "center"

    # The scale of the nametag's display.
    # This can be used to change the size of the nametag.
    scale:
      x: 1
      y: 1
      z: 1

Nametags

enabled

Whether custom nametags created by DisplayTags should be enabled. If disabled, only Minecraft's vanilla player nametags will be rendered.

Values: true, false

Default: true

nametags:
  enabled: true # DisplayTags will render custom nametags!

show-self

Should players be able to see their own nametag? If enabled, typically visible when the player uses F5 to change their perspective.

Values: true, false

Default: true

nametags:
  show-self: true # All players will be able to see their own nametag (again, typically using F5).

update-interval

How often should nametags update, in seconds? This handles rendering/un-rendering nametags when players are too far away, and the text of the nametag, if you use placeholders like {health} or ones provided by PlaceholderAPI, this will also update according to this number.

Value: number in seconds

Default: 1

nametags:
  update-interval: 1 # Representing 1 second, meaning, nametags will update every second.

visibility-distance

How close a player needs to be to see another player's nametag, in blocks. When a player is not close enough to another player, as in, within the range set by this value, there will be no nametag (not even Minecraft's vanilla player nametag) shown to the player.

Value: number in blocks

Default: 32

nametags:
  visibility-distance: 32 # This means that a player needs to be within 32 blocks of another player, to see their nametag.

Display

lines

The lines displayed in the nametag's text displays. Reminder:

• Supports MiniMessage Formatting - you can build each line in the official MiniMessage web viewer.
• Supports PlaceholderAPI's placeholders

Value: list of strings (text)

Default:

- "<gray>{player}</gray>"
- "<red>❤ <white>{health}"

nametags:
  lines:
    - "<gray>{player}</gray>"
    - "<red>❤ <white>{health}"

text-shadow

Enable text shadow for the text display of a nametag.

Values: true, false

Default: true

nametags:
  text-shadow: true

see-through

Should the text display of nametags be see through?

Values: true, false

Default: false

nametags:
  see-through: false

text-alignment

The text alignment of the nametag's text display.

Values: left, right, center

Default: center

nametags:
  text-alignment: "center"

background

This is the background colour of a player's nametag text display shown above the player.

Values: Hex Code (e.g. #FFFFFF for white) or "transparent" for no background.

Default: transparent

nametags:
  background: "transparent" # No background will be shown in the nametag text display.

nametags:
  background: "#FFFFFF" # A white background will be shown in the nametag text display.

billboard

This is the billboard of a player's nametag text display. You can learn more about Display Billboards by clicking here.

Values: fixed, vertical, horizontal, center

Default: center

nametags:
  billboard: "center" # The billboard of the nametag text display is will pivot around the center point.

scale

The size of the nametag's text display entity.

Value: numbers (accepted by x, y, z)

Default:

nametags:
  scale:
    x: 1
    y: 1
    z: 1

Once you are done re-configuring DisplayTags, run the command /displaytags reload to apply the changes!