Initial commit

.gitignore

@@ -0,0 +1,118 @@
+# User-specific stuff
+.idea/
+
+*.iml
+*.ipr
+*.iws
+
+# IntelliJ
+out/
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+.gradle
+build/
+
+# Ignore Gradle GUI config
+gradle-app.setting
+
+# Cache of project
+.gradletasknamecache
+
+**/build/
+
+# Common working directory
+run/
+
+# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
+!gradle-wrapper.jar

build.gradle

@@ -0,0 +1,74 @@
+plugins {
+    id 'java'
+    id 'com.github.johnrengelman.shadow' version '7.1.2'
+    id 'org.ajoberstar.grgit' version '5.0.0'
+}
+
+group = 'net.william278'
+version = "1.0-${versionMetadata()}"
+
+repositories {
+    mavenCentral()
+    maven { url = 'https://repo.papermc.io/repository/maven-public/' }
+    maven { url = 'https://jitpack.io' }
+    maven { url = 'https://repo.minebench.de/' }
+}
+
+dependencies {
+    compileOnly 'com.velocitypowered:velocity-api:3.1.1'
+    compileOnly 'net.luckperms:api:5.4'
+
+    implementation 'net.william278:Annotaml:2.0.1'
+    implementation 'de.themoep:minedown-adventure:1.7.1-SNAPSHOT'
+
+    annotationProcessor 'com.velocitypowered:velocity-api:3.1.1'
+}
+
+shadowJar {
+    relocate 'de.themoep', 'net.william278.velocitab.libraries'
+    relocate 'net.william278.annotaml', 'net.william278.velocitab.libraries.annotaml'
+
+    dependencies {
+        //noinspection GroovyAssignabilityCheck
+        exclude dependency(':slf4j-api')
+    }
+}
+
+def targetJavaVersion = 16
+java {
+    def javaVersion = JavaVersion.toVersion(targetJavaVersion)
+    sourceCompatibility = javaVersion
+    targetCompatibility = javaVersion
+    if (JavaVersion.current() < javaVersion) {
+        toolchain.languageVersion = JavaLanguageVersion.of(targetJavaVersion)
+    }
+}
+
+jar.dependsOn shadowJar
+
+tasks.withType(JavaCompile).configureEach {
+    options.release = targetJavaVersion
+}
+
+def templateSource = file('src/main/templates')
+def templateDest = layout.buildDirectory.dir('generated/sources/templates')
+def generateTemplates = tasks.register('generateTemplates', Copy) { task ->
+    def props = [
+            'version': project.version
+    ]
+    task.inputs.properties props
+
+    task.from templateSource
+    task.into templateDest
+    task.expand props
+}
+
+sourceSets.main.java.srcDir(generateTemplates.map { it.outputs })
+
+@SuppressWarnings('GrMethodMayBeStatic')
+def versionMetadata() {
+    if (grgit == null) {
+        return System.getenv("GITHUB_RUN_NUMBER") ? 'build.' + System.getenv("GITHUB_RUN_NUMBER") : 'unknown'
+    }
+    return grgit.head().abbreviatedId + (grgit.status().clean ? '' : '-indev')
+}

gradle.properties

@@ -0,0 +1,4 @@
+javaVersion=16
+
+org.gradle.jvmargs='-Dfile.encoding=UTF-8'
+org.gradle.daemon=true

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

gradlew

@@ -0,0 +1,234 @@
+#!/bin/sh
+
+#
+# Copyright © 2015-2021 the original authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+##############################################################################
+#
+#   Gradle start up script for POSIX generated by Gradle.
+#
+#   Important for running:
+#
+#   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
+#       noncompliant, but you have some other compliant shell such as ksh or
+#       bash, then to run this script, type that shell name before the whole
+#       command line, like:
+#
+#           ksh Gradle
+#
+#       Busybox and similar reduced shells will NOT work, because this script
+#       requires all of these POSIX shell features:
+#         * functions;
+#         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
+#           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
+#         * compound commands having a testable exit status, especially «case»;
+#         * various built-in commands including «command», «set», and «ulimit».
+#
+#   Important for patching:
+#
+#   (2) This script targets any POSIX shell, so it avoids extensions provided
+#       by Bash, Ksh, etc; in particular arrays are avoided.
+#
+#       The "traditional" practice of packing multiple parameters into a
+#       space-separated string is a well documented source of bugs and security
+#       problems, so this is (mostly) avoided, by progressively accumulating
+#       options in "$@", and eventually passing that to Java.
+#
+#       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
+#       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
+#       see the in-line comments for details.
+#
+#       There are tweaks for specific operating systems such as AIX, CygWin,
+#       Darwin, MinGW, and NonStop.
+#
+#   (3) This script is generated from the Groovy template
+#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       within the Gradle project.
+#
+#       You can find Gradle at https://github.com/gradle/gradle/.
+#
+##############################################################################
+
+# Attempt to set APP_HOME
+
+# Resolve links: $0 may be a link
+app_path=$0
+
+# Need this for daisy-chained symlinks.
+while
+    APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
+    [ -h "$app_path" ]
+do
+    ls=$( ls -ld "$app_path" )
+    link=${ls#*' -> '}
+    case $link in             #(
+      /*)   app_path=$link ;; #(
+      *)    app_path=$APP_HOME$link ;;
+    esac
+done
+
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
+
+APP_NAME="Gradle"
+APP_BASE_NAME=${0##*/}
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD=maximum
+
+warn () {
+    echo "$*"
+} >&2
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+} >&2
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "$( uname )" in                #(
+  CYGWIN* )         cygwin=true  ;; #(
+  Darwin* )         darwin=true  ;; #(
+  MSYS* | MINGW* )  msys=true    ;; #(
+  NONSTOP* )        nonstop=true ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD=$JAVA_HOME/jre/sh/java
+    else
+        JAVACMD=$JAVA_HOME/bin/java
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD=java
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
+    case $MAX_FD in #(
+      max*)
+        MAX_FD=$( ulimit -H -n ) ||
+            warn "Could not query maximum file descriptor limit"
+    esac
+    case $MAX_FD in  #(
+      '' | soft) :;; #(
+      *)
+        ulimit -n "$MAX_FD" ||
+            warn "Could not set maximum file descriptor limit to $MAX_FD"
+    esac
+fi
+
+# Collect all arguments for the java command, stacking in reverse order:
+#   * args from the command line
+#   * the main class name
+#   * -classpath
+#   * -D...appname settings
+#   * --module-path (only if needed)
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if "$cygwin" || "$msys" ; then
+    APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
+    CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
+
+    JAVACMD=$( cygpath --unix "$JAVACMD" )
+
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    for arg do
+        if
+            case $arg in                                #(
+              -*)   false ;;                            # don't mess with options #(
+              /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
+                    [ -e "$t" ] ;;                      #(
+              *)    false ;;
+            esac
+        then
+            arg=$( cygpath --path --ignore --mixed "$arg" )
+        fi
+        # Roll the args list around exactly as many times as the number of
+        # args, so each arg winds up back in the position where it started, but
+        # possibly modified.
+        #
+        # NB: a `for` loop captures its iteration list before it begins, so
+        # changing the positional parameters here affects neither the number of
+        # iterations, nor the values presented in `arg`.
+        shift                   # remove old arg
+        set -- "$@" "$arg"      # push replacement arg
+    done
+fi
+
+# Collect all arguments for the java command;
+#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
+#     shell script including quotes and variable substitutions, so put them in
+#     double quotes to make sure that they get re-expanded; and
+#   * put everything else in single quotes, so that it's not re-expanded.
+
+set -- \
+        "-Dorg.gradle.appname=$APP_BASE_NAME" \
+        -classpath "$CLASSPATH" \
+        org.gradle.wrapper.GradleWrapperMain \
+        "$@"
+
+# Use "xargs" to parse quoted args.
+#
+# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
+#
+# In Bash we could simply go:
+#
+#   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
+#   set -- "${ARGS[@]}" "$@"
+#
+# but POSIX shell has neither arrays nor command substitution, so instead we
+# post-process each arg (as a line of input to sed) to backslash-escape any
+# character that might be a shell metacharacter, then use eval to reverse
+# that process (while maintaining the separation between arguments), and wrap
+# the whole thing up as a single "set" statement.
+#
+# This will of course break if any of these variables contains a newline or
+# an unmatched quote.
+#
+
+eval "set -- $(
+        printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
+        xargs -n1 |
+        sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
+        tr '\n' ' '
+    )" '"$@"'
+
+exec "$JAVACMD" "$@"

gradlew.bat

@@ -0,0 +1,89 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem      https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
+@if "%DEBUG%" == "" @echo off
+@rem ##########################################################################
+@rem
+@rem  Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%" == "" set DIRNAME=.
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if "%ERRORLEVEL%" == "0" goto execute
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto execute
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
+
+:end
+@rem End local scope for the variables with windows NT shell
+if "%ERRORLEVEL%"=="0" goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
+exit /b 1
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega

settings.gradle

@@ -0,0 +1 @@
+rootProject.name = 'Velocitab'

src/main/java/net/william278/velocitab/Velocitab.java

@@ -0,0 +1,103 @@
+package net.william278.velocitab;
+
+import com.google.inject.Inject;
+import com.velocitypowered.api.event.proxy.ProxyInitializeEvent;
+import com.velocitypowered.api.event.Subscribe;
+import com.velocitypowered.api.plugin.Dependency;
+import com.velocitypowered.api.plugin.Plugin;
+import com.velocitypowered.api.plugin.annotation.DataDirectory;
+import com.velocitypowered.api.proxy.Player;
+import com.velocitypowered.api.proxy.ProxyServer;
+import net.william278.annotaml.Annotaml;
+import net.william278.velocitab.config.Settings;
+import net.william278.velocitab.luckperms.LuckPermsHook;
+import net.william278.velocitab.player.Role;
+import net.william278.velocitab.player.TabPlayer;
+import net.william278.velocitab.tab.PlayerTabList;
+import org.jetbrains.annotations.NotNull;
+import org.slf4j.Logger;
+
+import java.io.File;
+import java.io.IOException;
+import java.lang.reflect.InvocationTargetException;
+import java.nio.file.Path;
+import java.util.Optional;
+
+@Plugin(
+        id = "velocitab",
+        name = "Velocitab",
+        version = BuildConstants.VERSION,
+        description = "Simple velocity TAB menu plugin",
+        url = "https://william278.net/",
+        authors = {"William278"},
+        dependencies = {@Dependency(id = "luckperms", optional = true)}
+)
+public class Velocitab {
+
+    private Settings settings;
+    private final ProxyServer server;
+    private final Logger logger;
+    private final Path dataDirectory;
+    private PlayerTabList tabList;
+    private LuckPermsHook luckPerms;
+
+    @Inject
+    public Velocitab(ProxyServer server, Logger logger, @DataDirectory Path dataDirectory) {
+        this.server = server;
+        this.logger = logger;
+        this.dataDirectory = dataDirectory;
+    }
+
+    @Subscribe
+    public void onProxyInitialization(ProxyInitializeEvent event) {
+        loadSettings();
+        loadHooks();
+        prepareTabList();
+    }
+
+    @NotNull
+    public ProxyServer getServer() {
+        return server;
+    }
+
+    @NotNull
+    public Settings getSettings() {
+        return settings;
+    }
+
+    private void loadSettings() {
+        try {
+            settings = Annotaml.create(new File(dataDirectory.toFile(), "config.yml"), Settings.class).get();
+        } catch (IOException | InvocationTargetException | InstantiationException | IllegalAccessException e) {
+            logger.error("Failed to load config file: " + e.getMessage(), e);
+        }
+    }
+
+    public Optional<LuckPermsHook> getLuckPerms() {
+        return Optional.ofNullable(luckPerms);
+    }
+
+    private void loadHooks() {
+        if (server.getPluginManager().getPlugin("luckperms").isEmpty()) {
+            return;
+        }
+
+        // If LuckPerms is present, load the hook
+        try {
+            luckPerms = new LuckPermsHook();
+        } catch (IllegalArgumentException e) {
+            logger.warn("LuckPerms was not loaded: " + e.getMessage(), e);
+        }
+    }
+
+    private void prepareTabList() {
+        this.tabList = new PlayerTabList(this);
+        server.getEventManager().register(this, new PlayerTabList(this));
+    }
+
+    @NotNull
+    public TabPlayer getTabPlayer(@NotNull Player player) {
+        return new TabPlayer(player, getLuckPerms().map(hook -> hook.getPlayerRole(player)).orElse(Role.DEFAULT_ROLE));
+    }
+
+}

src/main/java/net/william278/velocitab/config/Placeholder.java

@@ -0,0 +1,46 @@
+package net.william278.velocitab.config;
+
+import com.velocitypowered.api.proxy.ServerConnection;
+import com.velocitypowered.api.proxy.server.RegisteredServer;
+import com.velocitypowered.api.proxy.server.ServerInfo;
+import net.william278.velocitab.Velocitab;
+import net.william278.velocitab.player.TabPlayer;
+import org.jetbrains.annotations.NotNull;
+
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+import java.util.function.BiFunction;
+
+public enum Placeholder {
+
+    PLAYERS_ONLINE((plugin, player) -> Integer.toString(plugin.getServer().getPlayerCount())),
+    MAX_PLAYERS_ONLINE((plugin, player) -> Integer.toString(plugin.getServer().getConfiguration().getShowMaxPlayers())),
+    LOCAL_PLAYERS_ONLINE((plugin, player) -> player.player().getCurrentServer()
+            .map(ServerConnection::getServer)
+            .map(RegisteredServer::getPlayersConnected)
+            .map(players -> Integer.toString(players.size()))
+            .orElse("")),
+    CURRENT_DATE((plugin, player) -> DateTimeFormatter.ofPattern("dd MMM yyyy").format(LocalDateTime.now())),
+    CURRENT_TIME((plugin, player) -> DateTimeFormatter.ofPattern("HH:mm:ss").format(LocalDateTime.now())),
+    USERNAME((plugin, player) -> player.player().getUsername()),
+    SERVER((plugin, player) -> player.player().getCurrentServer()
+            .map(ServerConnection::getServerInfo)
+            .map(ServerInfo::getName).orElse("")),
+    PING((plugin, player) -> Long.toString(player.player().getPing())),
+    PREFIX((plugin, player) -> player.role().getPrefix().orElse("")),
+    SUFFIX((plugin, player) -> player.role().getSuffix().orElse(""));
+
+    private final BiFunction<Velocitab, TabPlayer, String> formatter;
+
+    Placeholder(@NotNull BiFunction<Velocitab, TabPlayer, String> formatter) {
+        this.formatter = formatter;
+    }
+
+    public static String format(@NotNull String format, @NotNull Velocitab plugin, @NotNull TabPlayer player) {
+        for (Placeholder placeholder : values()) {
+            format = format.replace("%" + placeholder.name().toLowerCase() + "%", placeholder.formatter.apply(plugin, player));
+        }
+        return format;
+    }
+
+}

src/main/java/net/william278/velocitab/config/Settings.java

@@ -0,0 +1,46 @@
+package net.william278.velocitab.config;
+
+import net.william278.annotaml.YamlComment;
+import net.william278.annotaml.YamlFile;
+import net.william278.annotaml.YamlKey;
+import org.jetbrains.annotations.NotNull;
+
+@YamlFile(header = "Velocitab Config File")
+public class Settings {
+
+    @YamlKey("tab_list.header")
+    private String header = "Welcome to the server!";
+
+    @YamlKey("tab_list.footer")
+    private String footer = "Welcome to the server!";
+
+    @YamlKey("tab_list.format")
+    private String format;
+
+    @YamlComment("Use LuckPerms for tab list formatting (if installed)")
+    @YamlKey("use_luckperms")
+    private boolean useLuckPerms = true;
+
+    private Settings() {
+    }
+
+    @NotNull
+    public String getHeader() {
+        return header;
+    }
+
+    @NotNull
+    public String getFooter() {
+        return footer;
+    }
+
+    @NotNull
+    public String getFormat() {
+        return format;
+    }
+
+    public boolean isUseLuckPerms() {
+        return useLuckPerms;
+    }
+
+}

src/main/java/net/william278/velocitab/luckperms/LuckPermsHook.java

@@ -0,0 +1,52 @@
+package net.william278.velocitab.luckperms;
+
+import com.velocitypowered.api.proxy.Player;
+import net.luckperms.api.LuckPerms;
+import net.luckperms.api.LuckPermsProvider;
+import net.luckperms.api.cacheddata.CachedMetaData;
+import net.luckperms.api.model.group.Group;
+import net.luckperms.api.model.user.User;
+import net.william278.velocitab.player.Role;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.OptionalInt;
+import java.util.UUID;
+
+public class LuckPermsHook {
+
+    private final LuckPerms api;
+
+    public LuckPermsHook() throws IllegalStateException {
+        this.api = LuckPermsProvider.get();
+    }
+
+    @NotNull
+    public Role getPlayerRole(@NotNull Player player) {
+        final CachedMetaData metaData = getUser(player.getUniqueId()).getCachedData().getMetaData();
+        final OptionalInt roleWeight = getWeight(metaData.getPrimaryGroup());
+        if (roleWeight.isPresent()) {
+            return new Role(
+                    roleWeight.getAsInt(),
+                    metaData.getPrimaryGroup(),
+                    metaData.getPrefix(),
+                    metaData.getSuffix()
+            );
+        }
+        return Role.DEFAULT_ROLE;
+    }
+
+    private OptionalInt getWeight(@Nullable String groupName) {
+        final Group group;
+        if (groupName == null || (group = api.getGroupManager().getGroup(groupName)) == null) {
+            return OptionalInt.empty();
+        }
+        return group.getWeight();
+    }
+
+    private User getUser(@NotNull UUID uuid) {
+        return api.getUserManager().getUser(uuid);
+    }
+
+
+}

src/main/java/net/william278/velocitab/player/Role.java

@@ -0,0 +1,47 @@
+package net.william278.velocitab.player;
+
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Optional;
+
+public class Role implements Comparable<Role> {
+    public static final int DEFAULT_WEIGHT = 0;
+    public static final Role DEFAULT_ROLE = new Role(DEFAULT_WEIGHT, null, null, null);
+    private final int weight;
+    @Nullable
+    private final String name;
+    @Nullable
+    private final String prefix;
+    @Nullable
+    private final String suffix;
+
+    public Role(int weight, @Nullable String name, @Nullable String prefix, @Nullable String suffix) {
+        this.weight = weight;
+        this.name = name;
+        this.prefix = prefix;
+        this.suffix = suffix;
+    }
+
+    @Override
+    public int compareTo(@NotNull Role o) {
+        return o.weight - weight;
+    }
+
+    public Optional<String> getPrefix() {
+        return Optional.ofNullable(prefix);
+    }
+
+    public Optional<String> getSuffix() {
+        return Optional.ofNullable(suffix);
+    }
+
+    public Optional<String> getName() {
+        return Optional.ofNullable(name);
+    }
+
+    @NotNull
+    public String getStringComparableWeight() {
+        return String.format("%05d", weight);
+    }
+}

src/main/java/net/william278/velocitab/player/TabPlayer.java

@@ -0,0 +1,53 @@
+package net.william278.velocitab.player;
+
+import com.velocitypowered.api.proxy.Player;
+import com.velocitypowered.api.proxy.player.TabList;
+import com.velocitypowered.api.proxy.player.TabListEntry;
+import com.velocitypowered.api.util.GameProfile;
+import de.themoep.minedown.adventure.MineDown;
+import net.kyori.adventure.text.Component;
+import net.william278.velocitab.Velocitab;
+import net.william278.velocitab.config.Placeholder;
+import net.william278.velocitab.tab.PlayerTabList;
+import org.jetbrains.annotations.NotNull;
+
+public record TabPlayer(@NotNull Player player, @NotNull Role role) implements Comparable<TabPlayer> {
+    @NotNull
+    private Component getFormattedEntry(@NotNull Velocitab plugin) {
+        return new MineDown(Placeholder.format(plugin.getSettings().getFormat(), plugin, this)).toComponent();
+    }
+
+    private TabListEntry getEntry(@NotNull Velocitab plugin, @NotNull TabList list) {
+        return TabListEntry.builder()
+                .displayName(getFormattedEntry(plugin))
+                .latency((int) player.getPing())
+                .tabList(list)
+                .profile(new GameProfile(player.getUniqueId(),
+                        role.getStringComparableWeight() + " " + player.getUsername(),
+                        player.getGameProfileProperties()))
+                .build();
+    }
+
+    public void sendHeaderAndFooter(@NotNull PlayerTabList tabList) {
+        this.player.sendPlayerListHeaderAndFooter(tabList.getHeader(this), tabList.getFooter(this));
+    }
+
+    public void addPlayer(@NotNull TabPlayer player, @NotNull Velocitab plugin) {
+        this.player.getTabList().addEntry(player.getEntry(plugin, this.player.getTabList()));
+    }
+
+    public void removePlayer(@NotNull TabPlayer player) {
+        this.player.getTabList().removeEntry(player.player().getUniqueId());
+    }
+
+
+    @Override
+    public int compareTo(@NotNull TabPlayer o) {
+        final int roleDifference = role.compareTo(o.role);
+        if (roleDifference == 0) {
+            return player.getUsername().compareTo(o.player.getUsername());
+        }
+        return roleDifference;
+    }
+
+}

src/main/java/net/william278/velocitab/tab/PlayerTabList.java

@@ -0,0 +1,68 @@
+package net.william278.velocitab.tab;
+
+import com.velocitypowered.api.event.Subscribe;
+import com.velocitypowered.api.event.connection.DisconnectEvent;
+import com.velocitypowered.api.event.player.ServerPostConnectEvent;
+import com.velocitypowered.api.proxy.Player;
+import de.themoep.minedown.adventure.MineDown;
+import net.kyori.adventure.text.Component;
+import net.william278.velocitab.Velocitab;
+import net.william278.velocitab.config.Placeholder;
+import net.william278.velocitab.player.TabPlayer;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+
+public class PlayerTabList {
+    private final Velocitab plugin;
+    private final List<TabPlayer> players;
+
+    public PlayerTabList(@NotNull Velocitab plugin) {
+        this.plugin = plugin;
+        this.players = new ArrayList<>();
+    }
+
+    @NotNull
+    public Component getHeader(@NotNull TabPlayer player) {
+        return new MineDown(Placeholder.format(plugin.getSettings().getHeader(), plugin, player)).toComponent();
+    }
+
+    @NotNull
+    public Component getFooter(@NotNull TabPlayer player) {
+        return new MineDown(Placeholder.format(plugin.getSettings().getFooter(), plugin, player)).toComponent();
+    }
+
+
+    @SuppressWarnings("UnstableApiUsage")
+    @Subscribe
+    public void onPlayerJoin(@NotNull ServerPostConnectEvent event) {
+        final TabPlayer player = plugin.getTabPlayer(event.getPlayer());
+
+        // Show existing list to new player
+        players.forEach(listPlayer -> player.addPlayer(listPlayer, plugin));
+
+        // Update list for all players with new player
+        players.add(player);
+        players.forEach(tabPlayer -> {
+            tabPlayer.addPlayer(player, plugin);
+            tabPlayer.sendHeaderAndFooter(this);
+        });
+    }
+
+    @Subscribe
+    public void onPlayerQuit(@NotNull DisconnectEvent event) {
+        final Player quitPlayer = event.getPlayer();
+        final Optional<TabPlayer> quitTabPlayer = players.stream()
+                .filter(player -> player.player().equals(quitPlayer)).findFirst();
+        if (quitTabPlayer.isPresent()) {
+            players.remove(quitTabPlayer.get());
+            players.forEach(tabPlayer -> {
+                tabPlayer.removePlayer(quitTabPlayer.get());
+                tabPlayer.sendHeaderAndFooter(this);
+            });
+        }
+    }
+
+}

src/main/templates/net/william278/velocitab/BuildConstants.java

@@ -0,0 +1,7 @@
+package net.william278.velocitab;
+
+// The constants are replaced before compilation
+public class BuildConstants {
+
+    public static final String VERSION = "${version}";
+}