Fork/Velocitab
2
0
Fork 0
forked from Upstream/Velocitab
Code Pull Requests Actions Releases Activity

[ci skip] Update README

Browse Source
This commit is contained in:
William 2023-03-04 19:00:54 +00:00 committed by GitHub
parent ef99015d01
commit f5aa9fc367
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,5 +1,8 @@
<p align="center">
<img src="images/banner.png" alt="HuskChat" />
<img src="images/banner.png" alt="Velocitab" />
<a href="https://modrinth.com/plugin/velocitab">
<img src="https://img.shields.io/modrinth/v/velocitab?color=%231bd96a&label=modrinth&logo=modrinth&logoColor=%23fffff" />
</a>
<a href="https://github.com/WiIIiam278/Velocitab/actions/workflows/java_ci.yml">
<img src="https://img.shields.io/github/actions/workflow/status/WiIIiam278/Velocitab/java_ci.yml?branch=master&logo=github"/>
</a>
@ -10,7 +13,7 @@
<br/>
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.
## Installation
## Setup
Requires [Protocolize](https://github.com/Exceptionflug/protocolize) v2.2.5 to be installed on your proxy. [LuckPerms](https://luckperms.net) is also strongly recommended for prefix/suffix/role (and sorting) support.
Simply download the latest release and place it in your Velocity plugins folder (along with Protocolize).
@ -18,6 +21,9 @@ Simply download the latest release and place it in your Velocity plugins folder
## Configuration
Velocitab has a simple config file that lets you define a header, footer and format for the player list, as well as a set of servers you do not want to have the custom player list appear on (i.e. if you want certain backend servers to manage the tab list instead of the proxy).
### Formatting
Formatting is handled through [MineDown](https://github.com/Phoenix616/MineDown), supporting the full range of RGB colors and gradients. If you use my other plugin using MineDown, HuskChat, you'll feel right at home.
### Placeholders
You can include placeholders in the header, footer and player name format of the TAB list. The following placeholders are supported:
@ -36,10 +42,22 @@ You can include placeholders in the header, footer and player name format of the
| `%role%` | The player's primary LuckPerms group | `admin` |
| `%debug_team_name%` | Internal team value, used for list sorting | `1_alpha_William2` |
## License
## Building
To build Velocitab, simply run the following in the root of the repository:
```
./gradlew clean build
```
The build will be output as `/build/lib/Velocitab-X.XX-all.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!
* **[Discord](https://discord.com/invite/tVYhJfyDWG)** — Get support, ask questions!
* **[GitHub](https://github.com/WiIIiam278/Velocitab)** — Check out the plugin source code!
---
&copy; [William278](https://william278.net/), 2023. Licensed under the Apache-2.0 License.