Creating

Registering

To create a new Scoreboard, we need to add it as a node in the scoreboards.yml file.

Creating Example

Example of how to create a new scoreboard:

newboard:

Essential Scoreboard Options

Next, we have to add the following to the scoreboard:

weight

This represents how important the board is. If a player qualifies for 2 boards, one with a weigh of 10 and the other with a weight of 11, the board with a weight of 11 will be shown as it is more important.

This is an integer value.

criteria

To determine whether a player is allowed to have a boss bar displayed, BetterScoreboard uses a placeholder-based system called conditions. You can read more about criteria here.

mode

This determines how the criteria should be handled. You can read more about the mode here.

Essential Scoreboard Options Example

newboard:
  weight: 10
  criteria:
    - "permission:example.permission"

Title/Lines

Adding a Title Animation

Next, add a node called title to the scoreboard. The following are options for the title.

random

This option decides whether animation lines should be randomly chosen. If false, they will proceed sequentially.

This is a boolean value.

speed

This value represents how many ticks should pass between animation lines being switched. Set to -1 to disable. Remember that there are 20 ticks in a second.

This is an integer value.

text

This is a list of strings that should be displayed as the title.

These can include placeholders to substitute applicable text into the message.

Adding a Title Animation Example

newboard:
  weight: 10
  criteria:
    - "permission:example.permission"

  title:
    random: false
    speed: 100
    text:
      - "&1This is a title!"
      - "&9This is a title!"

Adding Lines

For every line you want to add, you must have a section titled line#. This can be up to 15 (line1 to line15) and must increase sequentially.

A non-sequential jump will result in lines not being read. (Example: lin1, line2, line4 will result in only line1 and line2 being read).

Adding lines example

newboard:
  weight: 10
  criteria:
    - "permission:example.permission"

  title:
    random: false
    speed: 100
    text:
      - "&1This is a title!"
      - "&9This is a title!"

  line1:

Adding Text to Lines

To add text to a line, you must first define whether it should be aligned to the left or the right.

Add either left-aligned and/or right-aligned as a node to your line, and then add the following settings:

random

This option decides whether animation lines should be randomly chosen. If false, they will proceed sequentially.

This is a boolean value.

speed

This value represents how many ticks should pass between animation lines being switched. Set to -1 to disable. Remember that there are 20 ticks in a second.

This is an integer value.

text

This is a list of strings that should be displayed as the line.

These can include placeholders to substitute applicable text into the message.

If you wish to have a blank line, make sure to define a left-aligned or right-aligned side and put the text as the following:

text:
  - ""

Adding Line Animations Example

newboard:
  weight: 10
  criteria:
    - "permission:example.permission"

  title:
    random: false
    speed: 100
    text:
      - "&1This is a title!"
      - "&9This is a title!"

  line1:
    left-aligned:
      random: false
      speed: -1
      text:
        - "&1Welcome %displayname%."

  line2:
    left-aligned:
      random: false
      speed: 2000
      text:
        - ""
        - "&4This line updates every &c100 &4seconds."

    right-aligned:
      random: false
      speed: 2000
      text:
        - "&cThis line updates every &4100 &cseconds."
        - ""

  line3:
    right-aligned:
      random: false
      speed: 10
      text:
        - "&cLine3"
        - "&bLine3"

  line4:
    left-aligned:
      random: true
      speed: 100
      text:
        - "&c&lThis line randomly selects,"
        - "&b&lWhich is extremely cool,"
        - "&a&lDont you agree?"

  line5:
    left-aligned:
      random: false
      speed: -1
      text:
        - "Your ping is on the right! "

    right-aligned:
      random: false
      speed: 10
      text:
      - "&1%ping%"