Skip to content

Feature guide: Belowname

NEZNAMY edited this page Aug 20, 2022 · 51 revisions

Content

About

The scoreboard objective with BELOW_NAME display slot that adds another line of text below nametag of players.

This line automatically appears on all player entities when enabled. Therefore, it is not possible to only display it on some players or not display it on NPCs.
However, if you want to only display it on real players, you can disable this feature, enable Unlimited nametag mode and run /tab group _DEFAULT_ belowname %health% Health (or any other text you want). That way an armor stand will be used to display text instead, not being on NPCs.

The line is formatted as white number + space + text, where the text must be same on all players. Therefore, text doesn't support placeholders with player-specific output such as a faction. Only the number can be per-player.

The feature can be configured in config.yml under belowname-objective section.

Configuration

Option name Default value Description
enabled true Enables / Disables the feature
number "%health%" An integer from -2147483648 to 2147483647, doesn't support decimal values. The number is always white. Supports placeholders with player-specific output, such as player health.
text Health Text displayed after number. It is formally called scoreboard title, which is displayed on all player entities and value is shared on all players and therefore not bound to specific players, which makes it unable to display the value per-player. It should only contain static text or placeholders which return same value for all players. All inserted placeholders are parsed for the player viewing the text. This is intentional to allow advanced configuration with conditions for per-world values for example.

Disabling in worlds / servers

belowname-objective:
  disable-in-worlds:
    - disabledworld
  disable-in-servers:
    - disabledserver

To disable the feature in all worlds except listed ones, add WHITELIST keyword to the list, which will make it a list of enabled worlds / servers instead. Example:

belowname-objective:
  disable-in-worlds:
    - WHITELIST
    - enabledworld

Note: Disabling in servers is BungeeCord only. To make disabling in worlds work on BungeeCord, install TAB-Bridge plugin on backend servers.

Additional Info

Additional note 1 - Unlimited nametag mode incompatibility

The feature is affected by nametag visibility rule. This means that when nametag is set to invisible, belowname will be invisible as well. This is important to know, especially when enabling unlimited nametag mode which makes nametags invisible so it can display armor stands instead. To make it visible again, configure belowname property for your groups again (for example by running /tab group _DEFAULT_ belowname &c%health% &fHealth).

Additional note 2 - Hidden on sneak on 1.8

Belowname is not visible on 1.8.x clients when player is sneaking. This is client-sided behavior and cannot be changed by the server.

Tips & Tricks

Tip 1 - Heart symbol

If you want to show health of players and display a heart symbol as text, you can use this one: . Make sure you save config in UTF-8 encoding so it's loaded correctly.

belowname-objective:
  text: "&4❤"

Tip 2 - Displaying health as 0-10 or in %

If you want health to display health as 0-10 instead of 0-20, you can achieve it with PlaceholderAPI and its Math expansion:

  • Install PlaceholderAPI
  • Run /papi ecloud download math
  • Run /papi ecloud download player
  • Run /papi reload
  • Use a math expression on %player_health%. Information can be found here or contact PAPI support.

Limitations

  • The format is a white number + space + shared text.
  • The text is same on all players, therefore cannot be personalized (such as player's faction). Only the number can be per-player.
  • Color of the number doesn't seem to be configurable.
  • It appears on all entites of player type. This includes player NPCs.
  • Text length is limited to 32 characters on <1.13

All of these limits can be bypassed by enabling unlimited nametag mode and configuring belowname property for your groups (for example by running /tab group _DEFAULT_ belowname &c%health% &fHealth).

Clone this wiki locally