Table of Contents
Installation Instructions
Step 1
First download the plugin from one of the below websites. You will need the most recent build of the plugin that is not pre-release. Pre-release builds are untested or lightly tested. So proceed at your own risk with those.
Download Link 1: Gitea Release Page
Download Link 2: SpigotMC Release Page
Download Link 3: BuiltByBit Release Page
Download Link 4: Polymart Release Page (Donation/Paid Download)
Step 2
Next, download the latest stable release of LuckPerms Velocity (Direct Download)
This is no longer optional as of version 0.3. Velocity Broadcast does not work without permissions, and LuckPerms is our favorite permission manager. So it is a hard dependency and required.
Step 3
Drop both velocitybroadcast-x.x.jar and LuckPerms-Velocity-x.x.x.jar into the Proxy's plugin folder, not in your hub/frontend server plugin folder.
Step 4
Restart the proxy server to generate the configuration files needed.
Step 5
Fill out the config file for Velocity Broadcast as needed for your own needs.
Our plugin supports SQLite and MySQL. Just pick which one you want to use then fill out the required info if you are using MySQL
Step 6
Restart the server again if you changed the MySQL information. If not, just do /vb reload if you changed the prefix.
Step 7
This next section is on how to give permissions to users or groups. This step is very important. You may not use the plugin while opped, due to restrictions with Velocity. So permissions are required.
Please make sure you run these commands from the Proxy's console, not in game
For individual users, run the command: lpv user {username} permission set {permission node} true {context (optional)}
For groups, run the command: lpv group {group} permission set {permission node} true {context (optional)}
If you would rather use a GUI based editor, run the command: lpv editor
Step 8
To verify everything went well, run the command /vb while in game. You should see the help info. Then to make sure your prefix worked, run the command /vb {message}. You should see your message broadcasted in game.