Install the plugin

What you need

• A Paper server, or a fork of it such as Purpur. Other platforms are not supported at launch.
• The LuckPerms plugin, if you want ranks synced to permission groups.
• A Discord server with VV-Bot added, and the dashboard open as an administrator.

Pair the server

1. On the dashboard, add a Minecraft server and give it a name. The dashboard shows a one-time code.
2. Copy the plugin jar into the server's plugins folder and restart the server.
3. In the server console, or in game as an operator, run /vv pair CODE using the code from the dashboard.
4. The dashboard shows "connected" when the plugin has paired.

Codes work once and expire after ten minutes. A wrong code is refused after a few attempts. You never paste a token, a password or a panel key anywhere in Discord or on the website.

How it connects

The plugin opens one outgoing secure WebSocket connection (port 443) to VV-Bot. Nothing connects in to your server, so it works on hosts that block inbound ports. The connection key is created during pairing, stays in the plugin's folder, and is stored on our side only as a hash. If it leaks, revoke it on the dashboard and pair again.

What the plugin may do

The plugin does not run arbitrary commands. It accepts a short list of typed actions, such as creating or updating a managed LuckPerms group, adding or removing a player from allowed groups, telling a player something, and relaying chat. Your own config.yml decides which groups and actions are allowed, and Discord administrators cannot override it.

managed-groups:          # groups VV-Bot may create and delete
  - "vv_*"
allowed-groups:          # existing groups it may assign
  - "helper"
  - "mod"
allowed-actions:
  - lp.group.ensure
  - lp.user.groups.apply
  - player.tell
  - chat.relay
weight-band: { min: 100, max: 999 }

Kick, ban and whitelist actions exist but are off by default. You switch each one on yourself in this file.

Linking players

A member links by running /vv link in game and typing the code it shows with /link in Discord. Nobody on your staff has to approve it. A code only proves who a player is when your server checks accounts, so linking works on servers in online mode, and on servers behind a proxy that checks players once you set behind-proxy: true in config.yml. On a server that does not check accounts, /vv link says that accounts cannot be linked there.

Without the plugin

Every Discord-side feature still works. You also get online status from a server list ping. Account linking, rank sync and the chat bridge need the plugin.