TAB

https://github.com/neznamy/tab
Admin
TAB is a superior all-in-one Minecraft plugin designed for displaying information, outperforming...
Tokens:739,880
Snippets:4,306
Trust Score:6.1
License:Apache-2.0
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Bossbar configuration example with all properties

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Bossbar

Example bossbar configuration using all six properties: style, color, progress, text, announcement-bar, and display-condition. The style and color values are limited to predefined options from Mojang; progress accepts numbers between 0 and 100 with decimals; text supports RGB codes on 1.16+ but no newlines; announcement-bar set to true hides the bar unless used in announce command; display-condition must be met for players to see the bar.

```yaml
  bars:
    ServerInfo:
      style: "PROGRESS" 
      color: "PURPLE"
      progress: "100"
      text: "Welcome to the nether!"
      announcement-bar: false
      display-condition: "%world%=world_nether"
```

--------------------------------

### Example design with display-condition in config.yml

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Header-&-Footer

Example of a single design named 'MyDesign' with an optional display-condition. The comment notes to delete the display-condition line for no condition requirement.

```yaml
header-footer:
  enabled: true
  designs:
    MyDesign:  # Design name
      display-condition: "%world%=world"  # Delete the line for no condition requirement
      header:
        - "Header for world %world%"
      footer:
        - "Footer for world %world%"
```

--------------------------------

### Start Spark Profiler with Allocation

Source: https://github.com/neznamy/tab/blob/master/CONTRIBUTING.md

Use this command to start a Spark profiler with allocation profiling enabled. The timeout is set to 300 seconds, profiling all threads with a 0.1 second interval.

```text
/spark profiler start --timeout 300 --thread * --interval 0.1 --alloc
```

--------------------------------

### Start Spark Profiler

Source: https://github.com/neznamy/tab/blob/master/CONTRIBUTING.md

Use this command to start a Spark profiler for performance analysis. The timeout is set to 300 seconds, profiling all threads with a 0.1 second interval.

```text
/spark profiler start --timeout 300 --thread * --interval 0.1
```

--------------------------------

### Chaining designs with per-world and default in config.yml

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Header-&-Footer

Example of chaining two designs: 'per-world' with a display-condition and 'default' without one. The plugin checks designs from top to bottom; the first matching design is displayed.

```yaml
header-footer:
  enabled: true
  designs:
    per-world:
      display-condition: "%world%=world"
      header:
        - "Header for world world"
      footer:
        - "Footer for world world"
    default:  # No display condition
      header:
        - "Header for every world except world"
      footer:
        - "Footer for every world except world"
```

--------------------------------

### groups.yml - shared worlds and wildcard suffixes

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Nametags

Shares settings across multiple worlds by separating them with ';' and uses '*' wildcards for worlds starting or ending with a specified text. The example sets a shared tagsuffix for worlds 'world1' and 'world2', and a suffix for all worlds starting with 'lobby-'.

```yaml
per-world:
  world1;world2:
    _DEFAULT_:
      tagsuffix: "Shared tagsuffix in worlds world1 and world2"
  lobby-*:
    _DEFAULT_:
      tagsuffix: "Suffix in all worlds starting with lobby-"
```

--------------------------------

### Default shared-playerlist-world-groups configuration

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Per-world-playerlist

Example configuration from the docs showing two world groups, 'lobby' and 'minigames', each with two worlds. Used to share the playerlist among worlds in the same group.

```yaml
per-world-playerlist:
  shared-playerlist-world-groups:
    lobby:
      - lobby1
      - lobby2
    minigames:
      - paintball
      - bedwars
```

--------------------------------

### Scoreboard configuration example

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Scoreboard

Defines a scoreboard with a display condition, title, and lines. The display-condition uses a conditional expression to show the scoreboard only in world 'world'. The title supports placeholders and is limited to 32 characters on versions below 1.13.

```yaml
  scoreboards:
    MyScoreboard:
      display-condition: "%world%=world" # Only display it in world "world"
      title: "Scoreboard for world %world%"
      lines:
        - "Line1||Right side 1"
        - "Line2||Right side 2"
        - "Line3||Right side 3"
```

--------------------------------

### Font with RGB and gradients example

Source: https://github.com/neznamy/tab/wiki/How-to-use-Minecraft-components

When combining font with RGB or gradients, place the font tag outside and the color tags inside. This example uses a green-to-red gradient.

```text
<font:minecraft:alt><#00FF00>This is a colorful text written in minecraft enchantment table language which no one understands, but it looks pretty</#FF0000></font>
```

--------------------------------

### Empty fixed-slots list example

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Layout

Shows how to disable fixed slots by setting an empty list. Used when no fixed slots are desired.

```yaml
  layouts:
    staff:
      fixed-slots: []
```

--------------------------------

### Default server groups example

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Global-playerlist

Defines two server groups, 'lobbies' and 'group2', each listing two servers. Servers in the same group share a playerlist; unlisted servers are placed in a hidden default group and share playerlist with each other.

```yaml
global-playerlist:
  server-groups:
    lobbies:
      - lobby1
      - lobby2
    group2:
      - server1
      - server2
```

--------------------------------

### BossBar#getProgress()

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Bossbar

Returns the raw progress as a string.

```APIDOC
## BossBar#getProgress()

### Description
Returns the raw progress as a string.

### Method
getProgress

### Parameters
None

### Returns
String - The raw progress.
```

--------------------------------

### Relational condition example

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Conditional-placeholders

Checks if the viewer is in the same server as the target player. Uses '%viewer:server%' to reference the viewer's placeholder and '%server%' for the target player.

```text
%viewer:server%=%server%
```

--------------------------------

### Exact match server group

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Global-playerlist

Matches server names exactly as listed.

```yaml
server-groups:
  lobbies:
    - lobby1
    - lobby2
```

--------------------------------

### Per-world layout with display conditions

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Layout

Creates two layouts, one for world1 and one for world2, each showing only players in that world. Fixed slots are ignored in the example and can be configured as desired.

```yaml
  layouts:
    layout1:
      display-condition: "%world%=world1"
      fixed-slots: []
      groups:
        players:
          display-condition: "%world%=world1"
          slots:
            - 1-80
    layout2:
      display-condition: "%world%=world2"
      fixed-slots: []
      groups:
        players:
          display-condition: "%world%=world2"
          slots:
            - 1-80

```

--------------------------------

### Wildcard pattern world group configuration

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Per-world-playerlist

Configuration using wildcard patterns for prefix and suffix matching. 'World-*' matches worlds starting with 'World-', and '*-world' matches worlds ending with '-world'. Wildcards are case-insensitive.

```yaml
  shared-playerlist-world-groups:
    worlds:
      - "World-*"      # Matches: World-1, World-2, World-Hub, etc.
      - "*-world"      # Matches: eu-world, us-world, etc.
```

--------------------------------

### Prefixes/suffixes from permission plugin using Vault placeholders

Source: https://github.com/neznamy/tab/wiki/Mini-guides-collection

Replace all groups in groups.yml with this default group to take prefixes and suffixes from a permission plugin via Vault placeholders. Requires Vault and a permission plugin. If LuckPerms is installed on the same server, use %luckperms-prefix% and %luckperms-suffix% instead. On a proxy, use %vault_prefix% or %luckperms_prefix% with PlaceholderAPI support on proxy.

```yaml
_DEFAULT_:
  tabprefix: "%vault_prefix%"
  tagprefix: "%vault_prefix%"    
  tabsuffix: "%vault_suffix%"    
  tagsuffix: "%vault_suffix%"
```

--------------------------------

### Configure PLACEHOLDER_A_TO_Z sorting type

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Sorting-players-in-tablist

Sorts players alphabetically according to placeholder output. Write the placeholder to use. Example sorts by player name.

```yaml
scoreboard-teams:
  sorting-types:
    - "PLACEHOLDER_A_TO_Z:%player%"
```

--------------------------------

### BossBar#getStyle()

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Bossbar

Returns the raw style as a string.

```APIDOC
## BossBar#getStyle()

### Description
Returns the raw style as a string.

### Method
getStyle

### Parameters
None

### Returns
String - The raw style.
```

--------------------------------

### Dynamic line count with animation

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Header-&-Footer

Shows how to create a header with dynamic line count using an animation that includes newline characters. The animation is defined in animations.yml and referenced in config.yml.

```yaml
MyAnimation:
  change-interval: 1000
  texts:
    - "First frame with only 1 line"
    - "Second frame\nconsisting of 2 lines"
```

```yaml
header-footer:
  designs:
    DesignName:
      header:
        - "%animation:MyAnimation%"
```

--------------------------------

### Player groups configuration example

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Layout

Defines player groups with display conditions and slot intervals. Groups are checked in order; players not meeting any condition are not displayed. Slots can have multiple intervals to exclude slots.

```yaml
  layouts:
    myLayout:
      groups:
        staff:
          display-condition: permission:tab.staff
          slots:
            - '24-40'
        players:
          slots:
            - '44-80'
```

--------------------------------

### Configure PLACEHOLDER_Z_TO_A sorting type

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Sorting-players-in-tablist

Sorts players reverse alphabetically according to placeholder output. Write the placeholder to use. Example sorts by player name in reverse.

```yaml
scoreboard-teams:
  sorting-types:
    - "PLACEHOLDER_Z_TO_A:%player%"
```

--------------------------------

### Atlas sprite example in YAML config

Source: https://github.com/neznamy/tab/wiki/How-to-use-Minecraft-components

Example of using atlas sprites in a TAB configuration header. Note that sprite values change across Minecraft versions; verify correct atlas and sprite names for your version.

```yaml
  header:
    - '&bDiamond helmet: <sprite:"minecraft:items":"minecraft:item/diamond_helmet">'
    - 'Diamond chestplate: <sprite:"minecraft:items":"minecraft:item/diamond_chestplate">'
    - 'Diamond leggings: <sprite:"minecraft:items":"minecraft:item/diamond_leggings">'
    - 'Diamond boots: <sprite:"minecraft:items":"minecraft:item/diamond_boots">'
```

--------------------------------

### Font syntax example

Source: https://github.com/neznamy/tab/wiki/How-to-use-Minecraft-components

Use the `<font:FONT_NAME>Text</font>` syntax to apply a custom font. Replace `FONT_NAME` with the desired font name.

```text
<font:minecraft:alt>This is a text written in minecraft enchantment table language which no one understands</font>
```

--------------------------------

### Fixed slots configuration example

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Layout

Defines fixed slots with position, text, and optional skin. Slots are numbered 1-80, default direction is columns. Supports placeholders in text.

```yaml
    fixed-slots:
      - '1|&3RAM&f:'
      - '2|&b%memory-used%MB / %memory-max%MB'
      - '3|&8&m                       '
      - '4|&3TPS&f:'
      - '5|&b%tps%'
```

--------------------------------

### Pattern 3: else fallback example

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Placeholder-output-replacements

Uses the 'else' key as a fallback when no other pattern matches.

```yaml
placeholder-output-replacements:
  "%tps%":
    "20": "Running at perfect 20 TPS!"
    "15-20": "Solid"
    "5-15": "Bad"
    "else": "Terrible" #0-5 in this case
```

--------------------------------

### Per-world header/footer configuration

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Header-&-Footer

Configures header/footer designs based on player's world using display-condition with %world% placeholder. Includes a default design for all other worlds.

```yaml
header-footer:
  enabled: true
  designs:
    world:
      display-condition: "%world%=world" # Only show if player is in world "world"
      header:
        - "Header for world world"
      footer:
        - "Footer for world world"
    world2:
      display-condition: "%world%=world2" # Only show if player is in world "world2"
      header:
        - "Header for world world2"
      footer:
        - "Footer for world world2"
    default:
      header:
        - "Header for all worlds except world and world2"
      footer:
        - "Footer for all worlds except world and world2"
```

--------------------------------

### Set tabsuffix via in-game command

Source: https://github.com/neznamy/tab/wiki/Mini-guides-collection

Alternative to the groups.yml configuration: run /tab group _DEFAULT_ tabsuffix with the same placeholder combination.

```text
/tab group _DEFAULT_ tabsuffix %luckperms-suffix%%essentials_afk%
```

--------------------------------

### Enable global playerlist feature

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Global-playerlist

Set enabled to true to activate the feature. Check /tab dump output to verify if the feature is disabled.

```yaml
global-playerlist:
  enabled: true
```

--------------------------------

### Pattern 1: Exact text replacement example

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Placeholder-output-replacements

Replaces exact placeholder outputs, including empty strings. Note: text must match exactly, including color codes.

```yaml
placeholder-output-replacements:
  "%tps%":
    "20": "Running at perfect 20 TPS!"
  "%essentials_vanished%":
    "yes": " &7[V]"
    "no": ""
```

--------------------------------

### Wildcard patterns for server groups

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Global-playerlist

Uses '*' for prefix or suffix matching. Wildcard patterns are case-insensitive.

```yaml
server-groups:
  lobbies:
    - "Lobby-*"      # Matches: Lobby-1, Lobby-2, Lobby-Hub, etc.
    - "*-lobby"      # Matches: eu-lobby, us-lobby, etc.
```

--------------------------------

### Configure isolated servers with server-groups

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Global-playerlist

Create a new group for each isolated server and list only that server in the group. Not needed when isolate-unlisted-servers is set to true.

```yaml
global-playerlist:
  server-groups:
    test1:
      - isolatedServer1
    test2:
      - isolatedServer2
```

--------------------------------

### Per-version header/footer configuration

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Header-&-Footer

Configures header/footer designs based on client version, using display-condition with %player-version-id%>=773 for 1.21.9+ and a fallback for older clients.

```yaml
header-footer:
  enabled: true
  designs:
    newer-client:
      display-condition: "%player-version-id%>=773" # 1.21.9 uses 773
      header:
        - "Look, it's your head! <head:name:%player%>"
      footer:
        - "Cool, isn't it?"
    older-client:
      header:
        - "Regular header for old clients"
      footer:
        - "Consider updating your game"
```

--------------------------------

### Configure placeholder output replacements for AFK placeholder

Source: https://github.com/neznamy/tab/wiki/Mini-guides-collection

Customize the output of %essentials_afk% (which returns yes/no by default) using placeholder-output-replacements in config.yml. Replace yes with a red AFK tag and no with an empty string.

```yaml
placeholder-output-replacements:
  "%essentials_afk%":
    "yes": " &4&lAFK"
    "no": "" # display nothing if not afk
```

--------------------------------

### TabListFormatManager#getOriginalRawPrefix(TabPlayer)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Tablist-name-formatting

Gets the original prefix set by the plugin based on configuration, with raw placeholder identifiers.

```APIDOC
## TabListFormatManager#getOriginalRawPrefix(TabPlayer)

### Description
Gets the original prefix set by the plugin based on configuration, with raw placeholder identifiers.

### Method
GET

### Endpoint
TabListFormatManager#getOriginalRawPrefix(TabPlayer)

### Parameters
- **player** (TabPlayer) - Required - The player to get the original raw prefix for.

### Response
#### Success Response
- **String** - The original raw prefix.
```

--------------------------------

### animations.yml Welcome animation example

Source: https://github.com/neznamy/tab/wiki/Animations

Defines an animation named 'Welcome' in animations.yml with a 400ms change interval and 18 text frames. The frames create a typing effect for the word 'Welcome' with a trailing underscore. Use %animation:Welcome% to display it.

```yaml
animations:  
Welcome:  #this is name of the animation
  change-interval: 400  #this is refresh interval of the animation in milliseconds
  texts:  #the frames of animation
    - "&7&lW_"  
    - "&7&lW_"  
    - "&7&lWe_"  
    - "&7&lWel_"  
    - "&7&lWelc_"  
    - "&7&lWelco_"  
    - "&7&lWelcom_"  
    - "&7&lWelcome_"  
    - "&7&lWelcome_"  
    - "&7&lWelcome_"  
    - "&7&lWelcome_"  
    - "&7&lWelcom_"  
    - "&7&lWelco_"  
    - "&7&lWelc_"  
    - "&7&lWel_"  
    - "&7&lWe_"  
    - "&7&lW_"  
    - "&7&lW_"
```

--------------------------------

### Default global-playerlist configuration in config.yml

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Global-playerlist

Default configuration for the global-playerlist feature in config.yml. All options are explained in the table below.

```yaml
global-playerlist:
  enabled: false
  display-others-as-spectators: false
  display-vanished-players-as-spectators: true
  isolate-unlisted-servers: false
  update-latency: false
  spy-servers:
    - spyserver1
    - spyserver2
  server-groups:
    lobbies:
      - lobby1
      - lobby2
    group2:
      - server1
      - server2
```

--------------------------------

### Using relational condition in groups.yml

Source: https://github.com/neznamy/tab/wiki/Mini-guides-collection

Example configuration in groups.yml that uses the relational condition %rel_condition:head% in the tabprefix and displays player version information in the tabsuffix.

```yaml
_DEFAULT_:
  tabprefix: "%rel_condition:head%"
  tabsuffix: " %player-version% (%player-version-id%)"
```

--------------------------------

### HeaderFooterManager#setFooter(TabPlayer, String)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Header-&-Footer

Sets the footer for a player. Pass null to reset to the original value.

```APIDOC
## setFooter(TabPlayer, String)

### Description
Sets the footer for a player. Pass null to reset to the original value.

### Method
setFooter

### Parameters
- **player** (TabPlayer) - Required - The player to set the footer for.
- **footer** (String) - Required - The footer text to set, or null to reset.

### Return Value
void
```

--------------------------------

### groups.yml - per-world and per-server tagprefix

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Nametags

Applies tagprefix values per-world and per-server. These values take priority over global settings. The example sets a default tagprefix for all players in world 'world1' and server 'server1'.

```yaml
per-world:
  world1:
    _DEFAULT_:
      tagprefix: "&a" # Everyone in world "world1" will have this prefix
per-server:
  server1:
    _DEFAULT_:
      tagprefix: "&a" # Everyone in server "server1" will have this prefix
```

--------------------------------

### Supported content in values example

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Placeholder-output-replacements

Placeholders can be used inside output values, including the original placeholder, which returns its original output.

```yaml
placeholder-output-replacements:
  "%tps%":
    "20": "Running at perfect 20 TPS!"
    "15-20": "%tps% (Solid)"
    "5-15": "%tps% (Bad)"
    "else": "%tps% (Terrible)"
```

--------------------------------

### groups.yml - Shared worlds and wildcard suffixes

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Tablist-name-formatting

Defines tabsuffix values for multiple worlds separated by semicolons and for worlds starting with a specified text using a wildcard.

```yaml
per-world:
  world1;world2:
    _DEFAULT_:
      tabsuffix: "Shared tagsuffix in worlds world1 and world2"
  lobby-*:
    _DEFAULT_:
      tabsuffix: "Suffix in all worlds starting with lobby-"
```

--------------------------------

### Register server placeholder with PlaceholderManager

Source: https://github.com/neznamy/tab/wiki/Placeholders

Registers a server placeholder using `PlaceholderManager#registerServerPlaceholder(String, int, Supplier<Object>)`. The placeholder `%system-time%` updates every 50 milliseconds and returns the current system time.

```java
TabAPI.getInstance().getPlaceholderManager().registerServerPlaceholder("%system-time%", 50, () -> System.currentTimeMillis());
```

--------------------------------

### Chaining scoreboards with conditions

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Scoreboard

Define multiple scoreboards with conditions; the first matching condition is displayed. If none match, no scoreboard is shown.

```yaml
  scoreboards:
    scoreboard1:
      display-condition: "permission:tab.scoreboard.admin"
      title: "Title 1"
      lines:
        - "Scoreboard for admins"
    scoreboard2:
      display-condition: "%world%=myWorld"
      title: "Title 2"
      lines:
        - "Scoreboard in world myWorld"
    scoreboard3:
      title: "Title 3"
      lines:
        - "Line 1"
```

--------------------------------

### Example 1 - Taking prefix/suffix from permission plugin

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Tablist-name-formatting

Configure groups.yml to use permission plugin prefixes/suffixes. Delete all groups except _DEFAULT_ and set tabprefix/tabsuffix to placeholders like %luckperms-prefix% or a PlaceholderAPI placeholder. Be careful not to delete tagprefix/tagsuffix from the nametag feature.

```yaml
_DEFAULT_:
  tabprefix: "%luckperms-prefix%"
  tabsuffix: "%luckperms-suffix%"
```

--------------------------------

### Example of all player head syntaxes in TAB config

Source: https://github.com/neznamy/tab/wiki/How-to-use-Minecraft-components

Shows all four ways to display player heads in TAB's footer configuration: by player name, UUID, Mineskin ID, and texture. Note that the player name and UUID methods may not work in offline mode, and the name method may or may not work depending on skin plugins.

```yaml
      footer:
      - 'Head by id: <head:%uuid%>'  # This will obviously not work in offline mode
      - 'Head by name: <head:%player%>'  # May or may not work in offline mode (see above for full explanation)
      - 'Head by mineskin: <mineskin:37e93c8e12cd426cb28fce31969e0674>'
      - 'Head by texture: <head_texture:ff9bb9e56125c8227b94bbda9f6e0f862931c229255ba8f1205d13c44c1bb561>'
```

--------------------------------

### Enable header-footer feature in config

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Header-&-Footer

Set header-footer.enabled to true to enable the feature. Used when troubleshooting shows 'HeaderFooter: Feature is disabled'.

```yaml
header-footer:
  enabled: true
```

--------------------------------

### Configure PLACEHOLDER sorting type

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Sorting-players-in-tablist

Sorts players using the output of a placeholder compared to pre-defined values. Write placeholder, colon, then comma-separated outputs to check against. Example sorts AFK players to bottom.

```yaml
scoreboard-teams:
  sorting-types:
    - "PLACEHOLDER:%essentials_afk%:no,yes"
```

--------------------------------

### Pattern 2: Number intervals example

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Placeholder-output-replacements

Replaces numeric outputs within intervals. If a number falls in multiple intervals, the higher interval is used.

```yaml
placeholder-output-replacements:
  "%tps%":
    "15-20": "Solid"
    "5-15": "Bad"
    "0-5": "Terrible"
```

--------------------------------

### Configure PLACEHOLDER_HIGH_TO_LOW sorting type

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Sorting-players-in-tablist

Sorts players numerically by placeholder output from highest to lowest. Only numeric placeholders work; supported range -1,000,000,000 to 1,000,000,000 with 5 decimal places. Example sorts by LuckPerms weight.

```yaml
scoreboard-teams:
  sorting-types:
    - "PLACEHOLDER_HIGH_TO_LOW:%luckperms_highest_group_weight%"
```

--------------------------------

### Regex patterns for server groups

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Global-playerlist

Uses 'regex:' prefix for advanced pattern matching. Regex patterns are case-sensitive by default; use '(?i)' flag for case-insensitive matching.

```yaml
server-groups:
  lobbies:
    - regex:Lobby-[0-9]+        # Matches: Lobby-1, Lobby-23, but not Lobby-Hub
  smp:
    - regex:SMP-(EU|US)-[0-9]+  # Matches: SMP-EU-1, SMP-US-2, etc.
```

--------------------------------

### Sort teams with PLACEHOLDER_A_TO_Z and %bw1058_player_team%

Source: https://github.com/neznamy/tab/wiki/Mini-guides-collection

Configure sorting-types in TAB's config.yml to sort teams alphabetically by the BedWars1058 team placeholder, then by permission groups, then by player name.

```yaml
sorting-types:
  - "PLACEHOLDER_A_TO_Z:%bw1058_player_team%"
  - "GROUPS:admin,mod,default"
  - "PLACEHOLDER_A_TO_Z:%player%"
```

--------------------------------

### LayoutManager.createNewLayout(String name)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Layout

Creates a new layout with the given internal name and 80 slots. Returns the created Layout object.

```APIDOC
## LayoutManager.createNewLayout(String name)

### Description
Creates a new layout with the given internal name and 80 slots.

### Method
createNewLayout

### Parameters
- **name** (String) - Required - The internal name of the layout.

### Returns
- **Layout** - The newly created layout.

```

--------------------------------

### Display health as 0-10 or 0-100 with PlaceholderAPI math

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Belowname

Use PlaceholderAPI math expansions to convert the player's health (0-20) to a 0-10 scale or a 0-100 percentage. The examples are %math_0_{player_health}/2% for 0-10 and %math_0_{player_health}*5% for 0-100.

```text
%math_0_{player_health}/2%
```

```text
%math_0_{player_health}*5%
```

--------------------------------

### BossBar#getColor()

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Bossbar

Returns the raw color as a string.

```APIDOC
## BossBar#getColor()

### Description
Returns the raw color as a string.

### Method
getColor

### Parameters
None

### Returns
String - The raw color.
```

--------------------------------

### Configure PLACEHOLDER_LOW_TO_HIGH sorting type

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Sorting-players-in-tablist

Sorts players numerically by placeholder output from lowest to highest. Only numeric placeholders work; supported range -1,000,000,000 to 1,000,000,000 with 5 decimal places. Example sorts by health.

```yaml
scoreboard-teams:
  sorting-types:
    - "PLACEHOLDER_LOW_TO_HIGH:%health%"
```

--------------------------------

### BossBar#getTitle()

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Bossbar

Returns the raw title of the boss bar.

```APIDOC
## BossBar#getTitle()

### Description
Returns the raw title of the boss bar.

### Method
getTitle

### Parameters
None

### Returns
String - The raw title.
```

--------------------------------

### Exact match world group configuration

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Per-world-playerlist

Configuration for exact world name matching in a group named 'worlds'. Only worlds with names exactly 'world1' and 'world2' will share the playerlist.

```yaml
  shared-playerlist-world-groups:
    worlds:
      - world1
      - world2
```

--------------------------------

### BossBarManager#getAnnouncedBossBars()

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Bossbar

Returns all boss bars that are currently being announced.

```APIDOC
## BossBarManager#getAnnouncedBossBars()

### Description
Returns all boss bars that are currently being announced.

### Method
getAnnouncedBossBars

### Parameters
None

### Returns
Collection<BossBar> - All currently announced boss bars.
```

--------------------------------

### Configure spy-servers to see all players

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Global-playerlist

List servers whose players see everyone on the network in the tablist. Players on spy servers are not visible to others unless on another spy server or in the same server group.

```yaml
global-playerlist:
  spy-servers:
    - spyserver1
    - spyserver2
```

--------------------------------

### ScoreboardManager#hasScoreboardVisible(TabPlayer)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Scoreboard

Determines whether a player can see scoreboards.

```APIDOC
## ScoreboardManager#hasScoreboardVisible(TabPlayer)

### Description
Determines whether a player can see scoreboards.

### Method
hasScoreboardVisible

### Parameters
- **player** (TabPlayer) - Required - The player to check.

### Returns
- **boolean** - True if the player can see scoreboards, false otherwise.
```

--------------------------------

### BossBar#getPlayers()

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Bossbar

Returns all players that can currently see this boss bar.

```APIDOC
## BossBar#getPlayers()

### Description
Returns all players that can currently see this boss bar.

### Method
getPlayers

### Parameters
None

### Returns
Collection<TabPlayer> - All players currently seeing the boss bar.
```

--------------------------------

### Enable playerlist-objective in config.yml

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Playerlist-Objective

Set `playerlist-objective.enabled` to `true` to enable the feature when troubleshooting shows it is disabled.

```yaml
playerlist-objective:
  enabled: true
```

--------------------------------

### BossBar#removePlayer(TabPlayer)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Bossbar

Removes the boss bar from the specified player.

```APIDOC
## BossBar#removePlayer(TabPlayer)

### Description
Removes the boss bar from the specified player.

### Method
removePlayer

### Parameters
- **player** (TabPlayer) - Required - The player to remove the boss bar from.

### Returns
void
```

--------------------------------

### BossBar#addPlayer(TabPlayer)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Bossbar

Sends the boss bar to the specified player.

```APIDOC
## BossBar#addPlayer(TabPlayer)

### Description
Sends the boss bar to the specified player.

### Method
addPlayer

### Parameters
- **player** (TabPlayer) - Required - The player to send the boss bar to.

### Returns
void
```

--------------------------------

### Chaining layouts with display-condition

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Layout

Define multiple layouts in config; the plugin checks them top-down and displays the first whose condition is met or unset. If none match, no layout is shown. In this example, players with tab.staff see the staff layout, others see default.

```yaml
layouts:
  staff:
    display-condition: "permission:tab.staff"
    fixed-slots:
      ...
    groups:
      ...
  default:
    fixed-slots:
      ...
    groups:
      ...
```

--------------------------------

### BossBar#setProgress(float)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Bossbar

Sets the progress of the boss bar to a float value.

```APIDOC
## BossBar#setProgress(float)

### Description
Sets the progress of the boss bar to a float value.

### Method
setProgress

### Parameters
- **progress** (float) - Required - The progress value from 0 to 100.

### Returns
void
```

--------------------------------

### BossBarManager#getBossBar(String)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Bossbar

Returns a boss bar by its name as defined in the configuration.

```APIDOC
## BossBarManager#getBossBar(String)

### Description
Returns a boss bar by its name as defined in the configuration.

### Method
getBossBar

### Parameters
- **name** (String) - Required - The name of the boss bar as defined in the config.

### Returns
BossBar - The boss bar with the given name, or null if not found.
```

--------------------------------

### TabListFormatManager#getOriginalReplacedSuffix(TabPlayer)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Tablist-name-formatting

Gets the original suffix set by the plugin based on configuration, with all placeholders parsed.

```APIDOC
## TabListFormatManager#getOriginalReplacedSuffix(TabPlayer)

### Description
Gets the original suffix set by the plugin based on configuration, with all placeholders parsed.

### Method
GET

### Endpoint
TabListFormatManager#getOriginalReplacedSuffix(TabPlayer)

### Parameters
- **player** (TabPlayer) - Required - The player to get the original replaced suffix for.

### Response
#### Success Response
- **String** - The original replaced suffix.
```

--------------------------------

### TabListFormatManager#getOriginalReplacedName(TabPlayer)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Tablist-name-formatting

Gets the original name set by the plugin based on configuration, with all placeholders parsed.

```APIDOC
## TabListFormatManager#getOriginalReplacedName(TabPlayer)

### Description
Gets the original name set by the plugin based on configuration, with all placeholders parsed.

### Method
GET

### Endpoint
TabListFormatManager#getOriginalReplacedName(TabPlayer)

### Parameters
- **player** (TabPlayer) - Required - The player to get the original replaced name for.

### Response
#### Success Response
- **String** - The original replaced name.
```

--------------------------------

### TabListFormatManager#getOriginalReplacedPrefix(TabPlayer)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Tablist-name-formatting

Gets the original prefix set by the plugin based on configuration, with all placeholders parsed.

```APIDOC
## TabListFormatManager#getOriginalReplacedPrefix(TabPlayer)

### Description
Gets the original prefix set by the plugin based on configuration, with all placeholders parsed.

### Method
GET

### Endpoint
TabListFormatManager#getOriginalReplacedPrefix(TabPlayer)

### Parameters
- **player** (TabPlayer) - Required - The player to get the original replaced prefix for.

### Response
#### Success Response
- **String** - The original replaced prefix.
```

--------------------------------

### BossBar#setStyle(BarStyle)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Bossbar

Sets the style of the boss bar to a BarStyle enum value.

```APIDOC
## BossBar#setStyle(BarStyle)

### Description
Sets the style of the boss bar to a BarStyle enum value.

### Method
setStyle

### Parameters
- **style** (BarStyle) - Required - The style to set.

### Returns
void
```

--------------------------------

### BossBar#setColor(BarColor)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Bossbar

Sets the color of the boss bar to a BarColor enum value.

```APIDOC
## BossBar#setColor(BarColor)

### Description
Sets the color of the boss bar to a BarColor enum value.

### Method
setColor

### Parameters
- **color** (BarColor) - Required - The color to set.

### Returns
void
```

--------------------------------

### Register relational placeholder with PlaceholderManager

Source: https://github.com/neznamy/tab/wiki/Placeholders

Registers a relational placeholder using `PlaceholderManager#registerRelationalPlaceholder(String, int, BiFunction<TabPlayer, TabPlayer, Object>)`. The placeholder `%rel_staff_version%` shows the target's version only to viewers with `tab.staff` permission, refreshing every 1000 ms. The first parameter is the viewer, the second is the target.

```java
TabAPI.getInstance().getPlaceholderManager().registerRelationalPlaceholder("%rel_staff_version%", 1000, (viewer, target) -> {
    if (viewer.hasPermission("tab.staff")) {
        return target.getVersion().getFriendlyName();
    } else {
        return "";
    }
});
```

--------------------------------

### Configure tabsuffix with AFK placeholder in groups.yml

Source: https://github.com/neznamy/tab/wiki/Mini-guides-collection

Use the _DEFAULT_ group keyword in groups.yml to set a default tabsuffix for all players, combining a LuckPerms suffix with an AFK placeholder like %essentials_afk%. Requires PlaceholderAPI and the respective expansion.

```yaml
_DEFAULT_:
  tabsuffix: "%luckperms-suffix%%essentials_afk%"
```

--------------------------------

### TabListFormatManager#getOriginalRawSuffix(TabPlayer)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Tablist-name-formatting

Gets the original suffix set by the plugin based on configuration, with raw placeholder identifiers.

```APIDOC
## TabListFormatManager#getOriginalRawSuffix(TabPlayer)

### Description
Gets the original suffix set by the plugin based on configuration, with raw placeholder identifiers.

### Method
GET

### Endpoint
TabListFormatManager#getOriginalRawSuffix(TabPlayer)

### Parameters
- **player** (TabPlayer) - Required - The player to get the original raw suffix for.

### Response
#### Success Response
- **String** - The original raw suffix.
```

--------------------------------

### Scoreboard configuration with per-version display conditions

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Scoreboard

Configure two scoreboards to handle version-specific features. The first scoreboard targets players with protocol version 765 or higher (1.20.3+) and non-bedrock players using the display-condition `%player-version-id%>=765;%bedrock%=false`. The second scoreboard serves as a fallback for older versions and bedrock players. Placeholders `%player-version-id%` and `%bedrock%` are used for the condition.

```yaml
  scoreboards:
    scoreboard-1.20.3+:
      title: "Scoreboard for 1.20.3+ and not bedrock"
      display-condition: "%player-version-id%>=765;%bedrock%=false" # Only display it to players using 1.20.3+ AND NOT bedrock edition
      lines:
        - "* &eOnline&7:||%online%"
        - "* &eCurrent World&7:||%worldonline%"
        - "* &eStaff&7:||%staffonline%"
        - "* &bRank&7:||%group%"
        - "* &bPing&7:||%ping%&8ms"
        - "* &bWorld&7:||%world%"
    scoreboard:
      title: "Scoreboard for <1.20.3 and bedrock"
      lines:
        - "* &eOnline&7: &f%online%"
        - "* &eCurrent World&7: &f%worldonline%"
        - "* &eStaff&7: &f%staffonline%"
        - "* &bRank&7: &f%group%"
        - "* &bPing&7: &f%ping%&8ms"
        - "* &bWorld&7: &f%world%"

```

--------------------------------

### TabListFormatManager#getOriginalRawName(TabPlayer)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Tablist-name-formatting

Gets the original name set by the plugin based on configuration, with raw placeholder identifiers.

```APIDOC
## TabListFormatManager#getOriginalRawName(TabPlayer)

### Description
Gets the original name set by the plugin based on configuration, with raw placeholder identifiers.

### Method
GET

### Endpoint
TabListFormatManager#getOriginalRawName(TabPlayer)

### Parameters
- **player** (TabPlayer) - Required - The player to get the original raw name for.

### Response
#### Success Response
- **String** - The original raw name.
```

--------------------------------

### Death counter in tablist using PlaceholderAPI

Source: https://github.com/neznamy/tab/wiki/Mini-guides-collection

Configure the playerlist-objective to display a player's death count using the PlaceholderAPI placeholder %statistic_deaths%. Values are taken from server stats and can be modified or reset in the <main world>/stats/<player uuid>.json file.

```yaml
playerlist-objective:
  enabled: true
  value: "%statistic_deaths%"
```

--------------------------------

### Kill counter in tablist using PlaceholderAPI

Source: https://github.com/neznamy/tab/wiki/Mini-guides-collection

Configure the playerlist-objective to display a player's kill count using the PlaceholderAPI placeholder %statistic_player_kills%. Values are taken from server stats and can be modified or reset in the <main world>/stats/<player uuid>.json file.

```yaml
playerlist-objective:
  enabled: true
  value: "%statistic_player_kills%"
```

--------------------------------

### ScoreboardManager#resetScoreboard(TabPlayer)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Scoreboard

Resets the scoreboard that a player is using to the default scoreboard determined by the config.

```APIDOC
## ScoreboardManager#resetScoreboard(TabPlayer)

### Description
Resets the scoreboard that a player is using to the default scoreboard determined by the config.

### Method
resetScoreboard

### Parameters
- **player** (TabPlayer) - Required - The player whose scoreboard to reset.

### Returns
- **void** - No return value.
```

--------------------------------

### Per-world playerlist layout configuration

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Layout

Reproduces the per-world-playerlist feature using relational conditions. The display condition checks if the viewer's world matches the target player's world. For proxy servers, use `%viewer:server%=%server%` instead.

```yaml
layout:
  enabled: true
  direction: COLUMNS
  default-skin: mineskin:383747683
  enable-remaining-players-text: true
  remaining-players-text: '... and %s more'
  empty-slot-ping-value: 1000
  layouts:
    default:
      slot-count: 80
      fixed-slots:
        - '1|&3Website&f:'
        - '2|&bmyserver.net'
        - '3|&8&m                       '
        - '4|&3Name&f:'
        - '5|&b%player%'
        - '7|&3Rank&f:'
        - '8|Rank: %group%'
        - '10|&3World&f:'
        - '11|&b%world%'
        - '13|&3Time&f:'
        - '14|&b%time%'
        - '21|&3Teamspeak&f:'
        - '22|&bts.myserver.net'
        - '23|&8&m                       '
        - '41|&3Store&f:'
        - '42|&bshop.myserver.net'
        - '43|&8&m                       '
      groups:
        players:
          display-condition: "%viewer:world%=%world%"
          slots:
            - 24-40
            - 44-80
```

--------------------------------

### BossBar#containsPlayer(TabPlayer)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Bossbar

Returns true if the player can see this boss bar, false otherwise.

```APIDOC
## BossBar#containsPlayer(TabPlayer)

### Description
Returns true if the player can see this boss bar, false otherwise.

### Method
containsPlayer

### Parameters
- **player** (TabPlayer) - Required - The player to check.

### Returns
boolean - true if the player can see the boss bar, false otherwise.
```

--------------------------------

### Show player version in tablist with /tab group command

Source: https://github.com/neznamy/tab/wiki/Mini-guides-collection

Run this command to append the player's version placeholder to the _DEFAULT_ group's tabsuffix. You can adjust colors or add other placeholders. Alternatively, modify groups.yml directly.

```text
/tab group _DEFAULT_ tabsuffix " &8[&3%player-version%&8]"
```

--------------------------------

### users.yml - tabprefix by username and UUID

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Tablist-name-formatting

Defines a tabprefix for a user by username and by UUID in users.yml. Can also be set with in-game commands /tab player _NEZNAMY_ tabprefix "&6&lTAB &r" and /tab playeruuid _NEZNAMY_ tabprefix "&6&lTAB &r" (the player must be online for uuid option to work).

```yaml
_NEZNAMY_:
  tabprefix: "&6&lTAB &r"

# An alternate way using UUID
237d8b55-3f97-4749-aa60-e9fe97b45062:
  tabprefix: "&6&lTAB &r"
```

--------------------------------

### ScoreboardManager#hasCustomScoreboard(TabPlayer)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Scoreboard

Determines whether a player has a custom scoreboard set (one that was shown through the API).

```APIDOC
## ScoreboardManager#hasCustomScoreboard(TabPlayer)

### Description
Determines whether a player has a custom scoreboard set (one that was shown through the API).

### Method
hasCustomScoreboard

### Parameters
- **player** (TabPlayer) - Required - The player to check.

### Returns
- **boolean** - True if the player has a custom scoreboard, false otherwise.
```

--------------------------------

### Configure placeholder refresh intervals in config.yml

Source: https://github.com/neznamy/tab/wiki/Placeholders

Set refresh intervals for internal and PlaceholderAPI placeholders. Values are in milliseconds and must be divisible by 50. CPU measurement resets every 10 seconds, so intervals above 10000 can cause misleading CPU output.

```yaml
placeholder-refresh-intervals:
  default-refresh-interval: 500
  "%server_uptime%": 1000
  "%server_tps_1_colored%": 1000
  "%player_health%": 200
  "%player_ping%": 1000
  "%vault_prefix%": 1000
  "%rel_factionsuuid_relation_color%": 500
```

--------------------------------

### BossBar#setStyle(String)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Bossbar

Sets the style of the boss bar. Accepts placeholders that will be replaced and periodically updated.

```APIDOC
## BossBar#setStyle(String)

### Description
Sets the style of the boss bar.

### Method
setStyle

### Parameters
- **style** (String) - Required - The style as a string, may contain placeholders.

### Returns
void
```

--------------------------------

### NameTagManager#getCustomPrefix(TabPlayer)

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Nametags

Returns the custom prefix previously set via the API, or null if no custom value is set.

```APIDOC
## NameTagManager#getCustomPrefix(TabPlayer)

### Description
Returns the custom prefix previously set via the API, or null if no custom value is set.

### Method
getCustomPrefix

### Parameters
- **player** (TabPlayer) - Required - The player whose custom prefix to retrieve.

### Response
- **prefix** (String) - The custom prefix, or null if not set.
```

--------------------------------

### Use both original and replaced output via animation

Source: https://github.com/neznamy/tab/wiki/Feature-guide:-Placeholder-output-replacements

Workaround to have both original and replaced placeholder output. Create an animation with a single frame containing the placeholder, then configure replacements for the animation placeholder. Use '%ping%' for original and '%animation:ping%' for replaced.

```yaml
ping:
  change-interval: 50 # Actual value doesn't matter
  texts:
    - "%ping%"
```

```yaml
placeholder-output-replacements:
  "%animation:ping%":
    "0-50": "&a%animation:ping%" # %ping% would work too
    "51-100": "&e%animation:ping%"
    "else": "&c%animation:ping%"
```
Tokens:
Raw