Bossbars

Module info
Configuration	bossbars.yml
Manager	BossbarManager
Support	Bukkit: 1.8+[?] Sponge: v5.0+ (MC 1.9+)
Free version	❌
Proxy-configurable	❌

Bossbars are progress bars displayed in the upper part of the player's screen. This module prints them in configurable time intervals. They can be used to show useful information and reminders or, more generally, advertisements. The following is an example of a 75% full bossbar with a custom style:

Default configuration (bossbars.yml in 1.9+)

bossbars:
  settings:
    enabled: true
    random-order: false
    abbreviate-long-titles: true
    send-full-to-legacy-players: true
    reflection-wither-teleportation:
      distance: 42.0
      timeout-ms: 250
    sending-timeout-ms: 10000
    placeholder-types:
    - JUST_NAME
    enabled-worlds:
    - '*'
    loading-bossbar:
      enabled: true
      sending-timeout-ms: 200
      titles:
        english: '&aLoading next bossbar... &f{loading_bossbar_remaining_seconds} &aremaining.'
        italian: '&aCaricamento prossima bossbar... &f{loading_bossbar_remaining_seconds} &arimanenti.'
      color: RANDOM
      style: SOLID
  discord:
    titles:
      english: '&9Join the Discord server to chat with your friends!'
      italian: '&9Entra nel server Discord per chattare con i tuoi amici!'
    color: BLUE
  ping-command:
    titles:
      english: '&aYou can check your ping with &f/ping&a.'
      italian: '&aPuoi controllare il tuo ping con &f/ping&a.'
    value: 75
    color: GREEN
  placeholders:
    titles:
      english: '&cPlaceholders are supported. Hi, &f{player}&c!'
      italian: '&cI placeholders sono supportati. Ciao, &f{player}&c!'
    value: 50
    color: RED
  bossbar-command:
    titles:
      english: '&5Bossbar can be toggled off using &f/bossbar&5.'
      italian: '&5La bossbar può essere disattivata con &f/bossbar&5.'
    value: 25
    color: PURPLE
  5-star-review:
    titles:
      english: '&eLeave a &f5-star &ereview on the plugin''s page!'
      italian: '&eLascia una recensione &f5-stelle &esulla pagina del plugin!'
    value: 0
    color: YELLOW
  language-command:
    titles:
      english: '&aChange the plugin''s language with &f/language&a!'
      italian: '&aCambia la lingua del plugin con &f/language&a!'
    value: 25
    color: GREEN
  instagram:
    titles:
      english: '&dVisit our Instagram page for memes about the Staff members!'
      italian: '&dVisita la pagina Instagram per memes sui membri dello Staff!'
    value: 50
    color: PINK
  random:
    titles:
      english: '&cThis bar will have a random color and style.'
      italian: '&cQuesta barra avrà colore e stile casuali.'
    value: 75
    color: RANDOM
    style: RANDOM
  last:
    titles:
      english: '&fLast bossbar. The next one will not be shown.'
      italian: '&fUltima bossbar. La prossima non verrà mostrata.'
    color: WHITE
  hidden:
    titles:
      english: '&7This bossbar will not be shown.'
      italian: '&7Questa bossbar non verrà mostrata.'
    hidden: true

Setup

The following snippet of code represents and explains the bossbars' configuration.

bossbars:  
  settings:
    enabled: true # whether to enable or disable this module
    random-order: false # whether to use a random order when sending the bossbars
    abbreviate-long-titles: true # whether to abbreviate long titl...
    send-full-to-legacy-players: true # whether to always send full bossbars to 1.7-1.8 players
    reflection-wither-teleportation: # read below
      distance: 42.0
      timeout-ms: 250
    sending-timeout-ms: 10000 # timeout between sendings, in milliseconds
    placeholder-types: # read below
    - JUST_NAME
    enabled-worlds: # enabled worlds' names
    - '*' # this indicates all the worlds
  # ...loading bossbar's settings...

NOTE

This module is disabled by default in 1.8.

The reflection-wither-teleportation section is used to display bossbars on 1.8 servers. It uses an alternative way to render it which has some limitations due to its nature. It is recommended not to touch its configuration and keep the bossbars' values over 50% if running 1.8, otherwise players may notice invisible withers in the distance.

Just like for the other modules, you have to specify which placeholder types you wish to use. Refer to the Modules/Placeholders page for more info.

Loading bossbar

Due to how the module works, bossbars are sent once for each configured time interval. To avoid leaving the bossbar blank, the loading bossbar has been introduced. Plus, its animation is really nice.

    # ...bossbars' settings...
    loading-bossbar: 
      enabled: true # whether to enable or disable the loading bossbar
      sending-timeout-ms: 200 # timeout between sendings, in milliseconds
      titles:
        english: '&aLoading next bossbar... &f{loading_bossbar_remaining_seconds} &aremaining.' # main language's translation - required
        italian: '&aCaricamento prossima bossbar... &f{loading_bossbar_remaining_seconds} &arimanenti.' # other language's translation - optional
      color: RANDOM # loading bossbar's color - optional, PINK if not specified
      style: SOLID # loading bossbar's style - optional, SOLID if not specified
    # ...default bossbars...

Read below to discover the available colors and styles.

Adding bossbars

To add a new bossbar, you just need to specify its ID and its titles. The ID has to respect the following pattern: ^[a-zA-Z0-9-_]{2,36}$.

    # ...bossbars' settings...
    placeholder-types: 
    - PLAYER # this is required to use the {health} and {max_health} placeholders
    # ...loading bossbar's settings...
  # ...default bossbars...
  new-bossbar: # ID - required
    titles:
      english: '&c&lHealth' # main language's translation - required
      italian: '&c&lVita' # other language's translation - optional
    value: '{health}' # bossbar's value - optional, 100 if not specified
    max-value: '{max_health}' # bossbar's max value - optional, 100 if not specified
    color: RED # bossbar's color - optional, PINK if not specified
    style: RANDOM # bossbar's style - optional, SOLID if not specified
    hidden: false # bossbar's visibility - optional; false if not specified

Note that value and max-value accept either fixed values or placeholders that represent a numeric value.

Colors

The plugin supports 8 colors specifiable at color:

• BLUE - displays a blue color; minimum version: 1.9
• GREEN - displays a green color; minimum version: 1.9
• PINK - displays a pink color
• PURPLE - displays a purple color; minimum version: 1.9
• RED - displays a red color; minimum version: 1.9
• WHITE - displays a white color; minimum version: 1.9
• YELLOW - displays a yellow color; minimum version: 1.9
• RANDOM - displays a random color

Styles

It supports 6 styles specifiable at style:

• SEGMENTED_6 - displays the bossbar split into 6 segments; minimum version: 1.9
• SEGMENTED_10 - displays the bossbar split into 10 segments; minimum version: 1.9
• SEGMENTED_12 - displays the bossbar split into 12 segments; minimum version: 1.9
• SEGMENTED_20 - displays the bossbar split into 20 segments; minimum version: 1.9
• SOLID - displays the bossbar as a solid segment
• RANDOM - displays a random style

Remember to perform /chatplugin reload after applying changes to configuration files.

/bossbar command

You can toggle your bossbar's visibility by typing /bossbar.

Refer to the Getting started/Commands/User page for more info.

---

ChatPlugin - A complete yet lightweight plugin which handles just too many features!
© 2024  Remigio07

This wiki is currently updated to version 1.9.10.
Please report any mistakes and misspellings as described at Home/Reporting issues.