Config File

This page contains the configuration file reference for Velocitab. The config file is located in /plugins/velocitab/config.yml

Example config

config.yml
# ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
# ┃       Velocitab Config       ┃
# ┃    Developed by William278   ┃
# ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
# ┗╸ Placeholders: %players_online%, %max_players_online%, %local_players_online%, %current_date%, %current_time%, %username%, %server%, %ping%, %prefix%, %suffix%, %role%
headers:
  default: '&rainbow&Running Velocitab v(version) by William278'
footers:
  default: '[There are currently %players_online%/%max_players_online% players online](gray)'
formats:
  default: '&7[%server%] &f%prefix%%username%'
# Which text formatter to use (MINEDOWN or MINIMESSAGE)
formatting_type: MINEDOWN
# The servers in each group of servers
server_groups:
  default:
    - lobby1
    - lobby2
    - lobby3
# All servers which are not in other groups will be put in the fallback group.
# "false" will exclude them from Velocitab.
fallback_enabled: true
# The formats to use for the fallback group.
fallback_group: 'default'
enable_papi_hook: true
# If you are using MINIMESSAGE formatting, enable this to support MiniPlaceholders in formatting.
enable_miniplaceholders_hook: true
# How often to periodically update the TAB list, including header and footer, for all users.
# Will only update on player join/leave if set to 0.
update_rate: 0

Details

Server Groups

Which formatting to use for a player's TAB list is determined by the group they are on. See Server Groups for more information.

Formatting

Velocitab supports the full range of modern color formatting, including RGB colors and gradients, through either MineDown or MiniMessage syntax. See Formatting for more information.

Placeholders

You can use various placeholders that will be replaced with values (for example, %username%) in your config. Support for PlaceholderAPI is also available through a bridge library plugin, as is the component-based MiniPlaceholders for users of that plugin with the MiniMessage formatter. See Placeholders for more information.