https://github.com/wiiiiam278/velocitab

A beautiful and versatile TAB list plugin for Velocity proxies
https://github.com/wiiiiam278/velocitab

minecraft plugin tab-list velocity

Last synced: 2 days ago
JSON representation

A beautiful and versatile TAB list plugin for Velocity proxies

• Host: GitHub
• URL: https://github.com/wiiiiam278/velocitab
• Owner: WiIIiam278
• License: apache-2.0
• Created: 2023-02-19T01:36:11.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-12-15T21:10:21.000Z (9 days ago)
• Last Synced: 2024-12-15T21:29:08.896Z (9 days ago)
• Topics: minecraft, plugin, tab-list, velocity
• Language: Java
• Homepage: https://william278.net/project/velocitab
• Size: 4.45 MB
• Stars: 97
• Watchers: 1
• Forks: 28
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/funding.yml
  • License: LICENSE

Awesome Lists containing this project

README

        



    

    

        

     

    

        

    

    

        

     

    


    

        Modrinth

     —

    

        Setup

     — 

    

        Docs

     — 

    

        Issues

    






**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.

![Showcase of different TAB menus made with Velocitab.png](images/showcase.png)

## Features

**⭐ Flexible list sorting** — Customizable TAB [list sorting](https://william278.net/docs/velocitab/sorting) based on user role, server, placeholder, and more.

**⭐ Versatile formatting support** — Make your TAB list beautiful with full RGB color support, supporting MiniMessage, MineDown and legacy [formatting modes](https://william278.net/docs/velocitab/formatting).

**⭐ Multiple TAB menus for different servers** — Create [server groups](https://william278.net/docs/velocitab/server-groups) and configure different TAB lists to show for each group!

**⭐ Animations support** — Add extra flair to your TAB list or display additional information by creating pretty looking [animations](https://william278.net/docs/velocitab/animations).

**⭐ Player nametags** — Customize how over-the-head [nametags](https://william278.net/docs/velocitab/nametags) look to help players stand out in-game.

**⭐ Full placeholder support** — Comes with a robust set of built-in [placeholders](https://william278.net/docs/velocitab/placeholders), MiniPlaceholders support, as well as PAPIProxyBridge for PlaceholderAPI support

**Ready?** [Get started in a new TAB…](https://william278.net/docs/velocitab/setup)

## Setup

We suggest installing [LuckPerms](https://luckperms.net) on your Velocity proxy and backend (Spigot, Paper, Fabric, etc.) servers for prefix/suffix formatting right out the box.

1. Turn off your Velocity proxy server

2. [Download](https://github.com/WiIIiam278/Velocitab/releases/latest) and place the plugin jar file in the `/plugins/` folder of your Velocity proxy server.

3. Start your Velocity proxy, and allow the plugin to generate its config file

4. Edit the [`config.yml` file](https://william278.net/docs/velocitab/config-file) to your liking

5. Restart your Velocity proxy again

Need to make a quick config change? You can use the in-game `/velocitab reload` (permission: `velocitab.command.reload`) command, though we recommend restarting your proxy server for any major changes.

## Building

To build Velocitab, run the following in the root of the repository:

```bash

./gradlew clean build

```

The build will be output as `/target/Velocitab-x.xx.jar`.

### License

Velocitab is licensed under the Apache 2.0 license.

- [License](https://github.com/WiIIiam278/Velocitab/blob/master/LICENSE)

## Links

* **[Website](https://william278.net/project/velocitab)** — Visit my website!

* **[Docs](https://william278.net/docs/velocitab)** — Read the plugin docs!

* **[Modrinth](https://modrinth.com/plugin/velocitab)** — View the plugin Modrinth page (Also: [Hangar](https://hangar.papermc.io/William278/Velocitab))

* **[Issues](https://github.com/WiIIiam278/Velocitab/issues)** — File a bug report or feature request

* **[Discord](https://discord.com/invite/tVYhJfyDWG)** — Get support, ask questions!

---

© [William278](https://william278.net/), 2024. Licensed under the Apache-2.0 License.