Plugin hooks
AnimatedScoreboard can hook into all of the following plugins but none are mandatory for the plugin to operate! Plugins are categorized into two different categories: Placeholder hooks and Permission hooks.

Placeholder hooks
These plugins allow AnimatedScoreboard to use placeholders on the scoreboard such as %player_name%.

• PlaceholderAPI
• MVdWPlaceholderAPI

Permission hooks
These plugin hooks allow AnimatedScoreboard to automatically switch scoreboards for a player if their permissions change and they are now able to view a new scoreboard or are no longer able to view their current scoreboard.

• LuckPerms
• GroupManager
• zPermissions

ASB PlaceholderAPI placeholders
AnimatedScoreboard will add its own placeholders to PlaceholderAPI if that plugin is found on the server.

• The latest version of ASB contains two placeholders: %animatedscoreboard_enabled% which returns whether or not the scoreboard is enabled for that player. And %animatedscoreboard_scoreboard% which returns the name of the scoreboard they have currently displayed.
• These placeholders are directly included inside of ASB and do not require a PlaceholderAPI pack to be downloaded.
• Both placeholders have configurable return values which can be changed in the new placeholders.yml file. In this file you can set what string should be returned when they have a scoreboard enabled, disabled or they do not have any scoreboard active currently. You can also set a friendly scoreboard name for each enabled scoreboard! This file may look as follows:

Code (YAML):

scoreboard:
  names :
    # Value returned by %animatedscoreboard_scoreboard% when they are viewing scoreboard_name
    scoreboard_name : "&aScoreboard Name"
  # Value returned by %animatedscoreboard_enabled% when they have the scoreboard disabled
  disabled : '&cDisabled'
  # Value returned by %animatedscoreboard_enabled% when they have the scoreboard enabled
  enabled : '&a&lEnabled'
  # Value returned by %animatedscoreboard_scoreboard% when they have no scoreboard active
  none-active : '&7None'

Supported scoreboard formats
AnimatedScoreboard has support for three different scoreboard formats to make setting up as easy as possible if all you want is a very simple scoreboard.

For the purpose of this showcase we will set up the following scoreboard using the three different formats:


Expanded syntax:
This format allows for the most customization but is therefore also overkill for most scoreboards that are used nowadays. However, if you want the absolute most customizability then this is the best choice. For this you need to create a separate section (e.g. title, line-1, .. line-15) for each scoreboard line that you want to use. Each line has its own interval and other settings.

Spoiler: Expanded syntax for scoreboard above

Code (YAML):

display:
    title:
      text :
     - '&lAnimatedScoreboard'
      random : false
      interval : 2
    line-1:
      text :
     - ''
      random : false #optional
      interval : 1
      score : 6 #optional
    line-2:
      text :
     - 'Welcome to example.com!'
      interval : 1
    line-3:
      text :
     - ''
      interval : 1
    line-4:
      text:
      - 'Balance : &a$%vault_eco_balance_formatted%'
      interval : 1
    line-5:
      text:
      - 'Online players : &a%server_online%'
      interval : 1
    line-6:
      text :
     - ''
      interval : 1
    line-7:
      text :
     - '&eplay.example.com'
      interval : 1

Compact list syntax:
Useful if you only want to have static lines with placeholders. With this you only have to create a single list that contains at most 16 lines: 1 title and up to 15 board lines. Each line that has a placeholder is updated 20 times a second.

To get the scoreboard from above using this syntax you need to have the following configuration setup:

Spoiler: Compact list syntax for scoreboard above

Code (YAML):

#The first line is the title, the rest after that is the board that is display in game
display :
- '&lAnimatedScoreboard'
- ''
- 'Welcome to example.com!'
- ''
- 'Balance : &a$%vault_eco_balance_formatted%'
- 'Online players : &a%server_online%'
- ''
- '&eplay.example.com'
 

Title separated lists:
This syntax gives a bit more freedom than the previous syntax as it has a separate list for the title. This means that the title can have some animations if that is desired. The title can have it's own update interval but all other lines that have placeholders are updated 20 times a second.

To achieve the example scoreboard with this syntax we have to create the following scoreboard file:

Spoiler: Title separated list syntax for scoreboard above

Code (YAML):

display :
  # The update interval for the title in ticks
  title-interval : 2
  # The title lines
  title :
 - "&lAnimatedScoreboard"
  # The board lines
  board :
 - ''
  - 'Welcome to example.com!'
  - ''
  - 'Balance : &a$%vault_eco_balance_formatted%'
  - 'Online players : &a%server_online%'
  - ''
  - '&eplay.example.com'
 

API for developers
The current API of AnimatedScoreboard is lacking certain features and is in the process of being rewritten. Compatibility with the current API will be maintained. This documentation will be updated once the new API has been released but for now you can view the documentation here.