Velocity Whitelist · Manual

Manual

Install, configure and use Velocity Whitelist on a Velocity proxy.

Overview

Velocity Whitelist manages a Minecraft whitelist for a Velocity proxy, using MySQL or MariaDB as the backend storage. Players who are not on the whitelist are kicked with a message you choose.

Installation

  1. Download the latest release from the Releases page or from Modrinth.
  2. Place the JAR file in the plugins directory of your Velocity proxy.
  3. Start or restart the proxy.

Configuration

The plugin reads config.properties in the plugins/velocitywhitelist directory. It is created with these defaults:

# Whitelist Status
enabled: false

# Enable Debug Messages
debug: false

# MySQL settings
host: localhost
user: username
password: strongpassword
database: velocity
port: 3306
table: g_whitelist

# Kick message
message: Sorry, you are not in the whitelist.

Options

enabled
Set to true to enable the whitelist.
debug
Set to true to show debug messages.
host, user, password, database, port, table
The MySQL or MariaDB connection details and the table that holds the whitelist.
message
The kick message shown to players who are not on the whitelist.

Commands

All commands start with /vwl.

Basic commands

/vwl add <player>
Add a player to the whitelist.
/vwl del <player>
Remove a player from the whitelist. Names are completed from the database.
/vwl list <search>
List players matching the search. The search needs at least 2 characters.

Admin commands

/vwl enable
Enable the whitelist.
/vwl disable
Disable the whitelist.
/vwl reload
Reload config.properties.
/vwl debug <on/off>
Turn debug messages on or off.

Permissions

velocitywhitelist
Required to use the basic whitelist commands.
velocitywhitelist.admin
Required to use the admin commands.

Getting started

  1. Set the MySQL or MariaDB connection details in config.properties.
  2. Start the proxy.
  3. Use the /vwl command to manage the whitelist.
  4. Run /vwl enable (or set enabled: true and /vwl reload) when you are ready to enforce it.

License

Velocity Whitelist is licensed under the GPL-3.0 License. See the LICENSE file for details. It is based on MySQLWhitelistVelocity by moesnow version 1.2.0.