Scoreboard

The scoreboard is the sidebar on the right of the screen. Each player sees their own copy, so placeholders show that player's values, and you can show different boards to different players.

It needs PacketEvents. Without it, BusyTab still runs but has no sidebar, and logs a warning if scoreboard.enabled is true.

Configuration

yaml
scoreboard:
  enabled: false
  refresh-interval: 1s
  hidden-by-default: false
  remember-toggle-choice: true
  boards:
    staff:
      display-condition: 'permission:busytab.scoreboard.staff'
      title: '%animation:title%'
      lines:
        - '&8%animation:divider%'
        - '&7Rank:||&e%vault_rank%'
        - '&7Ping:||&a%player_ping%ms'
        - '&7TPS:||&a%busytab_tps%'
        - ''
        - '&7Online:||&a%server_online%'
        - '&8%animation:divider%'
    default:
      title: '%animation:title%'
      lines:
        - '&8%animation:divider%'
        - '&fWelcome, &e%player_name%'
        - ''
        - '&7Rank:||&e%vault_rank%'
        - '&7Ping:||&a%player_ping%ms'
        - ''
        - '&7Online:||&a%server_online%'
        - '&8%animation:divider%'
        - '%animation:tips%'
Option Default Description
enabled false Turn the sidebar on or off
refresh-interval 1s How often placeholders are refreshed. Accepts ticks (20t), seconds (1s) or milliseconds (500ms)
hidden-by-default false New players start with the sidebar hidden until they run /sb
remember-toggle-choice true Keep each player's /sb choice after they leave and rejoin
boards Two example boards The boards, checked from top to bottom

Each board has:

Option Description
display-condition Who sees this board. Leave it out and the board is shown to everyone who didn't match a board above it
title The line above the board
lines Up to 15 lines, top to bottom

The default config ships with enabled: false. Set it to true and run /busytab reload.

Lines

  • Same formatting as the tab list. MiniMessage, gradients, & codes, &#RRGGBB and &x&R&R&G&G&B&B hex all work. See Text Formatting.
  • Same placeholders as the tab list, plus %animation:<name>%. See Animations.
  • '' is an empty line.
  • No length limit. Each line is one piece of text, not split across team prefixes.
  • No red numbers. The score numbers on the right are hidden.

Text on the right

Put || in a line to push the rest of it to the right edge, where the score numbers used to be:

yaml
lines:
  - '&7Coins:||&e%vault_eco_balance%'
  - '&7Kills:||&c%statistic_player_kills%'

The left part lines up on the left, the right part on the right, whatever their length.

Choosing a board

Each player sees the first board whose display-condition passes, checked from the top. A board with no condition always passes, so put it last as the fallback. If no board passes, the player has no sidebar.

Conditions are checked again on every refresh-interval, so a player moves to another board within one interval.

Check Passes when
%placeholder%=value The placeholder equals the value (case doesn't matter)
%placeholder%!=value It doesn't equal the value
%placeholder%>10, >=, <, <= Both sides are numbers and the comparison is true
permission:<node> The player has the permission
world:<name>,<name> The player is in one of these worlds
%placeholder% The placeholder is true or yes
  • Put ! in front of a check to turn it around: !world:spawn.
  • Join checks with ; when all of them must pass: permission:vip;world:survival.
  • Join them with | when any one is enough: world:spawn|world:hub.

Example: a combat board

yaml
boards:
  combat:
    display-condition: '%solaritycombat_in_combat%=true'
    title: 'FE4FF&lSOLARITY&f&lMC'
    lines:
      - '&#FF3375In Combat!'
      - '&fTagged for||BFF11%solaritycombat_time_formatted%'
  normal:
    title: 'FE4FF&lSOLARITY&f&lMC'
    lines:
      - 'FE4FF%player_name%||&8%player_ping%ms'

Hiding the sidebar

Players toggle their own sidebar with /sb (or /sidebar). /sb on and /sb off set it directly. See Commands & Permissions.

With remember-toggle-choice: true the choice is saved with the player's data, so it survives rejoining and restarts.

Moving from TAB

Most of a TAB scoreboard works as it is:

  • scoreboards: is read the same as boards:, and display-condition uses the same ; and | rules.
  • Animations from TAB's animations.yml can be pasted under animations: without changes. See Animations.
  • TAB's own placeholders need their PlaceholderAPI versions:
TAB BusyTab
%player% %player_name%
%ping% %player_ping%
%world% %player_world%
%online% %server_online%
%date% %server_time_dd/MM/yyyy%
%luckperms-prefix% %luckperms_prefix%

toggle-command isn't needed; the command is always /sb. Remove TAB's scoreboard (or TAB itself) so the two don't fight over the sidebar.

Good to know

  • Clients older than 1.20.3 (through ViaVersion) see the lines, but without the right-hand text, and with red numbers.
  • Other sidebar plugins. Only one sidebar can show at a time. Whichever plugin sends it last wins, so turn off the sidebar in other plugins.
  • Nametags keep working. The sidebar is sent straight to each player and doesn't swap their scoreboard, so Nametags and Rank Sorting aren't affected.
  • Only changed lines are sent. A line is rebuilt when the refresh interval comes round or when an animation in it moves on, and sent to the player only if it looks different. See Performance Guide.