Docs/Setup/Plugin

Plugin

Install the StaffHQ plugin, configure it, and set up staff group sync with LuckPerms.

Supported platforms

StaffHQ ships separate jars for each platform family.

staffhq-plugin-bukkit.jar

PaperSpigotPurpurFolia

staffhq-plugin-bungeecord.jar

BungeeCordWaterfall

staffhq-plugin-velocity.jar

Velocity 3.x

ℹ

Note

For proxy networks (BungeeCord or Velocity), install the proxy jar on the proxy and the Bukkit jar on every backend server. The proxy plugin handles cross-server player tracking.

Download and install

Plugin downloads are available after you purchase a license. Log in to dash.staffhq.net and open the Settings page to download the jar for your platform.

ℹ

Note

Download URLs are tied to your license and are not shared publicly. Do not redistribute the jar file.

1Place the jar in your server's plugins/ directory.
2Start (or restart) the server once to generate the default config.
3Stop the server.
4Edit plugins/StaffHQ/config.yml with your API key and settings.
5Start the server again.

Full config.yml reference

yaml

api:
  endpoint: "https://dash.staffhq.net"
  key: "YOUR_PLUGIN_API_KEY"
  timeout_seconds: 10

server:
  name: "My Server"
  # Unique identifier for this server. Auto-generated on first start.
  # Do not change this after initial setup.
  id: ""

tracking:
  chat: true
  commands: true
  punishments: true
  joins_quits: true
  rank_changes: true
  # Maximum messages batched per sync request (default 50)
  batch_size: 50

command_blacklist:
  - "/login"
  - "/register"
  - "/pass"

staff-groups:
  - owner
  - admin
  - moderator
  - helper

# Optional: override the sync interval (seconds)
sync_interval: 30

debug: false

Config options explained

string

Base URL of your StaffHQ dashboard. No trailing slash.

default: https://dash.staffhq.net

string

Plugin-type API key from Settings in the dashboard. Required.

int

HTTP timeout for requests to the dashboard. Increase on slow connections.

default: 10

string

Display name shown in the dashboard. Can contain spaces.

string

Auto-generated UUID. Do not edit this manually.

bool

Log player chat messages.

default: true

bool

Log player commands. Use command_blacklist to exclude sensitive commands.

default: true

bool

Capture bans, mutes, kicks, and warnings from supported punishment plugins.

default: true

bool

Record when players join or leave the server.

default: true

bool

Record LuckPerms group changes for tracked players.

default: true

int

Number of events batched per sync request. Lower if you see API rate limit errors.

default: 50

list

Commands that will never be logged, even when tracking.commands is true. Always include authentication commands here.

list

LuckPerms group names whose members are treated as staff. Only players in these groups appear in the Staff panel.

int

How often (in seconds) the plugin syncs batched events with the dashboard.

default: 30

bool

Enable verbose logging to the console. Useful for diagnosing connection issues.

default: false

Staff group setup

StaffHQ reads group memberships from LuckPerms to determine which players are staff. List the groups you want tracked under staff-groups in config.yml.

Example LuckPerms setup:

bash

# Create a moderator group
/lp creategroup moderator

# Add a player to it
/lp user Steve parent add moderator

# StaffHQ config entry
staff-groups:
  - moderator

✦

Tip

Inherited groups are detected automatically. If moderator inherits from helper, a moderator will still appear as staff even if only helper is listed, as long as the player's highest group is in the list.

Permissions

The plugin does not use Bukkit permissions for tracking. No permissions need to be assigned to players for tracking to work. The staff-groups list in config.yml controls visibility in the dashboard.

Updating the plugin

To update, replace the jar file in plugins/ with the new version and restart the server. Do not delete plugins/StaffHQ/config.yml when updating. New config keys will be added with defaults automatically.

← PreviousGetting Started Next →Dashboard