Scoreboard Creation

On this page, we'll explain the different parts of a scoreboard config file.

Priority

priority: 1

The priority determines which scoreboard gets shown to a player if they meet the criteria of more than one scoreboard.

Criteria

criteria:
  - type: PERMISSION
    permission: 'scoreboard.example'
    default: true

The criteria determines if a player can view this scoreboard.
You can combine criteria to make multiple requirements for your scoreboard.

criteria:
  - type: PERMISSION
    permission: 'scoreboard.example'
    default: true
  - type: PERMISSION
    permission: 'group.vip'
    default: true

In this case, we need both the scoreboard.example permission, and the group.vip permission.
We can make it require only one of them like so:

criteria:
  - type: OR
    children:
    - type: PERMISSION
      permission: 'scoreboard.example'
      default: true
    - type: PERMISSION
      permission: 'group.vip'
      default: true

Notice the first criteria is an OR criteria. The two PERMISSION criteria are actually children of the OR criteria.
In this case, we need either the scoreboard.example permission, or the group.vip permission.

You can add as many criteria as you like! You can mix and/or criteria!
You can read more about the different types of criteria here!

Lines

lines:
  - frames: []
  interval: 1
  delay: 0

The lines determine what will appear on the scoreboard.
Here's a couple ways you can make a blank line on your scoreboard:

lines:
  - frames: []
  - frames: ""

Frames

Frames are the actual content on that specific line. If you only have one frame, it will just be a static line.
However, you can add as many frames as you need for each line. If you add more frames, they will cycle through them depending on the interval. You can think of this as an animation.

lines:
  - frames:
    - 'frame 1'
    - 'frame 2'
    - 'frame 3'

This is an example of a line with multiple frames. It will loop through the frames at a 1 tick interval. This is because we didn't specify an interval.

Interval

lines:
  - frames:
    - 'frame 1'
    - 'frame 2'
    - 'frame 3'
  interval: 20

Now we've specified an interval of 20 ticks (1 second). This means it will loop through the frames with 1 second between each frame.

Delay

lines:
  - frames:
    - 'frame 1'
    - 'frame 2'
    - 'frame 3'
  interval: 20
  delay: 60

We can customize further by adding a delay. This delay is only for the first frame. In this example, the first frame will remain on screen for 60 ticks (3 seconds), before moving to the next frame. The next frames will go at the interval's speed. This is basically a delayed start to the animation.

Dynamic Lines

Dynamic lines are used to update placeholders!
Without this, even ever-changing placeholders will remain static!
To make a line dynamic, prefix it with d|.

lines:
  - frames: 'd|<green>$%vault_eco_balance%`

In this example, it's important the frame is dynamic, otherwise the player's balance won't update!
It's important to know, however, dynamic lines won't work if there's more than one frame.