Skip to content

Placeholders

Jump to bottom
goflishMC edited this page Aug 19, 2023 · 9 revisions

Placeholder API

You can use placeholders from PlaceholderAPI if the plugin is installed. PlaceholderAPI provides placeholders for a wide range of plugins.

Format: {papi: } (example: {papi: player_gamemode}).

Note: you can also use the short format with percent signs if enabled in the configuration (example %player_gamemode%).

Default Placeholders

{rainbow}

  • Animated rainbow color. The text placed after this placeholder will dynamically change color.

{player}

  • The name of player.

{displayname}

  • The display name of the player. The display name can be changed by plugins like Essentials.

{online}

  • Number of online players.

{max_players}

  • Number of available player slots.

{world: , [other world names]}

  • Players online in a specific world (example: {online: world_nether}).
  • Combine multiple worlds by separating them with a comma (example: {world: world, world_nether}).

{time}

  • Displays the real world's time. You can change the format and the time zone in configuration.

{online: , [other server names]}

  • Number of players online in another server in the same BungeeCord network (example: {online: hub}).
  • Combine multiple servers by separating them with a comma (example: {online: hub, hub2}).

{online: ALL}

  • Number of players online in the whole BungeeCord network.

{status: }

  • Checks if another server is online.
  • Requires the "pinger" enabled and configured with server IPs in config.yml.

{max_players: }

  • The max amount of players in another server.
  • Requires the "pinger" enabled and configured with server IPs in config.yml.

{motd: }

  • The first line of the MOTD of another server.
  • Requires the "pinger" enabled and configured with server IPs in config.yml.

{motd2: }

  • The second line of the MOTD of another server.
  • Requires the "pinger" enabled and configured with server IPs in config.yml.

Custom Placeholders

You can add custom placeholders that contain text, colors, formatting or normal placeholders (they can't contain other custom placeholders). They are useful if you need to insert the same text or formatting in multiple holograms and you want to be able to modify it in a single place, or they can assist in writing special characters (You can find unicode symbols on websites like Unicode Table).

Default Custom Placeholders

placeholders:
  '{custom_placeholder}': 'This is a custom placeholder.'
  '{primary_color}': '&b'
  '{secondary_color}': '&7'
  '{separator}': '&8&m          '  # Horizontal line using strikethrough format (&m)

Adding custom placeholders

The file /plugins/HolographicDisplays/custom-placeholders.yml contains the list of custom placeholders. To add a new placeholder:

  1. Open /plugins/HolographicDisplays/placeholders.yml.
  2. Add a new line, following the YAML syntax (e.g. '{placeholder}': 'replacement').
  3. Reload the plugin with /hd reload.
  4. You can now use your custom placeholder in holograms.

The placeholder doesn't have to be enclosed in curly braces, it can be even used to search and replace text inside all holograms, but it is advised to follow the same format as normal placeholders to keep things simple and tidy.

Example:

placeholders:
  '{test1}': 'Hello'
  '{test2}': 'World'

Clone this wiki locally