Skip to content

AkidHunter/staffhq-plugin

Repository files navigation

StaffHQ Plugin

The Minecraft server plugin for StaffHQ, a staff management dashboard for Minecraft networks.

This plugin connects your Minecraft server to your StaffHQ dashboard, sending staff activity, player data, and server health metrics for display and analysis.

Supported Platforms

Platform Version
Paper / Spigot / Bukkit 1.19+
Folia / Purpur 1.19+
BungeeCord / Waterfall 1.20+
Velocity 3.3.0+

Requires Java 17 or later.

What This Plugin Does

The plugin runs as a lightweight background process on your server. It collects activity data and sends it to your StaffHQ dashboard. Every piece of data the plugin transmits is documented in PRIVACY.md.

Features tracked:

  • Player joins, quits, and session duration
  • Chat messages and commands (with configurable filtering)
  • Punishments from LiteBans, AdvancedBan, BanManager, EssentialsX
  • Anticheat flags from Grim, Vulcan, Matrix, AAC, Intave, Polar, Themis
  • Server health (TPS, memory, player count)
  • Staff rank changes via LuckPerms
  • Player reports

Building

./gradlew :plugin-distribution:buildAll

Output JARs land in build/:

  • staffhq-plugin-bukkit.jar
  • staffhq-plugin-bungee.jar
  • staffhq-plugin-velocity.jar

SHA-256 checksums are generated automatically. GPG signing is available with ./gradlew :plugin-distribution:buildAll -Psign.

Configuration

After installing the JAR, edit plugins/StaffHQ/config.yml:

api:
  endpoint: "https://dash.staffhq.net"
  key: "your-api-key-here"

All tracking categories can be independently enabled or disabled under the tracking: section. Sensitive commands can be filtered via command_blacklist and strip_args_for_commands.

Network Transparency

See PRIVACY.md for a complete list of every data field the plugin transmits, including triggers, endpoints, and field descriptions.

License

Released under the MIT License. Use it, fork it, ship it.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages