Scoreboard Config

A scoreboard config is a YAML file which describes everithing of a scoreboard. The name of the scoreboard is the name of its file.

REMEMBER: Scoreboard configs must be put inside the plugins/UltimateScoreboards/scoreboards folder in order to be loaded by the plugin.

To create a new scoreboard run the command ul createscoreboard <scoreboardname>, then edit the <scoreboardname>.yml file in scoreboards folder.

An example scoreboard can be found here.

---

Scoreboard configs may be thought as divided into three main sections: general settings, lines, and lines declaration.

General Settings

In the upper section of a scoreboard config there are some options which modify the entire scoreboard behaviour. They're grouped up in the following table.

Field	Value
scoreboard-type	LONG, LITE, STATIC, or v1_13 (for more information see Scoreboard Types)
update-frequency	How many ticks should scoreboard update animations and placeholders (1 sec = 20 ticks)
per-player-scoreboard	Whether scoreboard contains per-player options (like some placeholders)
ensure-uniqueness	Make sure that no line bugs and disappears in certain circumstances. For more information see the Ensure Uniqueness Problem page

Lines

After the general settings there are two fields for setting the lines of the scoreboards. To actually declared the lines (their text, colors, ect.) see the line declarations part of the config down below.

Field	Value
title	The title of the scoreboard. Can either be the name of a line declared below or some text.
scoreboard-lines	The list of the scoreboard lines. Every line can either be the name of a line declared below or some text.

Lines declaration

The lines used inside title and scoreboard-lines are declared in the last part of the config under the lines field. There are three types of line: TEXT, SLIDING, and STEP. For more information check out the Line Types.

Example:

lines:
  textline:
    type: TEXT
    text: "&eThis &6is &5a &cline"
    placeholders: false
  slidingline:
    type: SLIDING
    text: "&5This line will slide!"
    update-frequency: 1
    skip-blanks: true
    reverse: false
    placeholders: false
  stepline:
    type: STEP
    steps:
      - "&eA Step Line"
      - "&6A Step Line"
    update-frequency: 1
    placeholders: false