Tablist Handlers

Creating your own handler

handlers:
    <handlerName>:
        type: <handlerType>

Placeholder usage for your handler: {<handlerName>}

Example:

handlers:
    example:
        type: EXAMPLE_TYPE

then the placeholder usage is {example}

Handler Types

Text Type

This allows you to show text on your tablist line. Type name: TEXT Fields:

• text Type: Text, List of Text, Text Frame, List Of Text Frame

• skin (Optional) Type: Text of UUID, Text of Player Name, List of Text of UUID/PlayerName, List of Frame

• ping (Optional) Type: Number, List Of Number, List of Frame

• refreshTicks (Optional) Type: Number

   animatedText:
      type: TEXT
      text:
      # list of list of string
      - - "&c&lONLINE PLAYERS"
        - "&e&lONLINE PLAYERS"
        - "&a&lONLINE PLAYERS"
        - "&b&lONLINE PLAYERS"
        - "&d&lONLINE PLAYERS" 
      ping:
      - text: 0
        delay: 3
      - text: 250
        delay: 3
      - text: 500
        delay: 3
      - text: 750
        delay: 3
      - text: 500
        delay: 3
      - text: 250
        delay: 3
      refreshTicks: 20 # default 20
      skin:
      - md_5
      - Septogeddon

Compound Type

This allows you to combine multiple handlers, and allowing them to have dynamic size. Type name: COMPOUND Fields:

• overflowFormat (Optional) text when there is not enough space left to put this placeholder Type: Text, List of Text, Text Frame, List of Text Frame

• header (Optional) the text shown before the list Type: Text,List of Text,TextFrame,List of Text Frame

• hideEmpty (Optional, default true) hide the header when the content is empty? Type: Boolean, List of Boolean, List of Boolean Frame

• items

  • <the items>

    • fixedSize size for the handler, -1 for dynamic size Type: Number

   information:
      type: COMPOUND
      overflowFormat: "... and {overflow_count} ..."
      items:
         serverInfo:
            fixedSize: -1
         playerInfo:
            fixedSize: -1
         worlds:
            fixedSize: -1

Player List Type

This allows you to show list of online players. Type name: PLAYER_LIST Fields:

• text The text for every player entry

• skin The skin for every entry

• ping (Optional) The ping for every entry

• refreshTicks (Optional) interval time to refresh the entry

• condition (Optional) Filter the entry using script condition Type: JavaScript,List of JavaScript , List of Frame

• sort (Optional) Sort the entry (CASE SENSITIVE ORDER) Type: Text , List of Text , List of Frame

• order (Optional, default ASCEND) Type: ASCEND or DESCEND

• hideEmpty (Optional) Hide header when its empty

• header Text shown before the entry

• overflowFormat Text shown at the bottom when it reached the limit

• grouping Prevent the entry to be duplicated in same context

  • groupName Type: Text, List of Text, Text Frame, List of Text Frame

  • priority Type: Number, List Of Number, List of Frame

   players:
      type: PLAYER_LIST
      sorter: "{player_displayname}"
      skin: "{player_uuid}"
      header: "&e&lPLAYERS"
      # hide header if list is empty
      hideEmpty: true
      order: ASCEND # or DESCEND
      text: "{player_displayname} &7{player_ping}"
      condition: "{player_has_permission_server.players}"
      ping: "{player_ping}"
      overflowFormat: "... and {overflow_count} more ..."
      grouping:
         groupName: "GLOBAL"
         priority: 0 # highest number goes first in the context

Field Type Explanation

Text

A text. Example: "this is a text"

Number

A number. Example: 2020

Boolean

A toggle switch between true or false . Example: true

Frame

A frame containing delay for this value. Example:

text: "this is the value"
delay: 20 # in ticks, 20 ticks = 1 second, optional, default: the type refreshTicks

List

A list. Example:

- "first item"
- true
- false
- 2020
- text: "this is a list of frames"
  delay: 20
- text: "this is text frame"
  ping: 1000
  delay: 40
  skin: "Septogeddon"

Text Frame

A frame that supports skin and ping. Example:

text: "this is the text"
ping: 1000 # optional
skin: "md_5" # optional
delay: 10 # optional, default: the type refreshTicks