Velocitab is a super-simple Velocity TAB menu plugin that uses scoreboard team client-bound packets to actually sort player lists without the need for a backend plugin. Supporting modern RGB formatting, animations, comprehensive placeholder support and defining multiple TAB menus for different groups of servers, Velocitab is a versatile plugin, useful for any Velocity-based proxy network.
Setup
Simply add the jar to your Velocity /plugins/ folder. It's also recommended that you install LuckPerms for prefix/suffix/role (and sorting) support. Then, edit the plugin config.yml to your liking.
Configuration
Velocitab has a simple config file that lets you define a header, footer and format for the player list. You can additionally configure groups of servers to display different formats in the TAB menu depending on which server the player is viewing it from.
Formatting
Velocitab supports the full range of RGB colors and gradients, with options to use either MineDown (default), MiniMessage, or legacy formatting.
Placeholders
You can include placeholders in the header, footer and player name format of the TAB list. The following placeholders are supported:
| Placeholder | Description | Example |
|---|---|---|
%players_online% | Players online on the proxy | 6 |
%max_players_online% | Player capacity of the proxy | 500 |
%local_players_online% | Players online on the server the player is on | 3 |
%current_date% | Current real-world date of the server | 24 Feb 2023 |
%current_time% | Current real-world time of the server | 21:45:32 |
%username% | The player's username | William278 |
%server% | Name of the server the player is on | alpha |
%ping% | Ping of the player (in ms) | 6 |
%prefix% | The player's prefix (from LuckPerms) | &4[Admin] |
%suffix% | The player's suffix (from LuckPerms) | &c |
%role% | The player's primary LuckPerms group | admin |
%debug_team_name% | Internal team value, used for list sorting | 1_alpha_William2 |
PlaceholderAPI placeholders are also supported. To use them, just install PAPIProxyBridge on your Velocity proxy and backend Spigot servers. Additionally, a hook for MiniPlaceholders is supported for servers using the MiniMessage formatter.
Command
You can use the /velocitab reload command to reload the plugin config file (permission: velocitab.command.reload), and /velocitab update to check for updates (permission: velocitab.command.update).
Building
To build Velocitab, simply run the following in the root of the repository:
./gradlew clean buildThe build will be output as /target/Velocitab-x.xx.jar.
License
Velocitab is licensed under the Apache 2.0 license.
Links
- Website — Visit my website!
- Docs — Read the plugin docs!
- Modrinth — View the plugin Modrinth page (Also: Hangar)
- Issues — File a bug report or feature request
- Discord — Get support, ask questions!
© William278, 2023. Licensed under the Apache-2.0 License.
