BigBrother

From aquila
Revision as of 13:08, 22 August 2026 by Baseplate (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

BigBrother Plugin Documentation

Staff-side auditing plugin for tracking administrative commands, gamemode alterations, and sensitive actions across AquilaPRJ.

Notice: This plugin has no player-facing commands. It runs silently in the background and reports directly to Discord.

What BigBrother Does

BigBrother provides a reliable audit trail for server owners to record administrative actions, identifying who performed an action, what they executed, and where they were standing.

  • Command Tracking: Watches every command run by any player possessing the bigbrother.watched permission.
  • Gamemode Monitoring: Specifically tracks gamemode modifications, even those triggered through menus or other plugins rather than a typed /gamemode command.
  • Discord Integration: Sends structured reports to a designated Discord webhook containing the player's name, UUID, skin thumbnail, exact command, world, exact coordinates, and a timestamp.
  • Console Fallback: Logs the exact same information directly to the server console if no webhook URL is configured.

How It Decides What to Log

  • Permission Gated: Only players with the bigbrother.watched permission are tracked; everyone else is entirely ignored.
  • Smart Filtering: Direct /gamemode text commands are skipped by the command watcher because the standalone gamemode watcher already logs the resulting state change, preventing duplicate alerts and capturing GUI-based transitions.
  • Full Op Coverage: Everything else typed as a command by an operator or watched user is immediately captured and reported.

Who's Currently Watched

The bigbrother.watched permission is managed through LuckPerms groups rather than assigned to individual player accounts. Users placed into these groups are monitored automatically:

<thead> </thead> <tbody> </tbody>
LuckPerms Group Status
gamestaff Watched automatically
serverguide Watched automatically
staff Watched automatically
OP Watched automatically

To add monitoring for another group, grant it the bigbrother.watched permission node inside LuckPerms. To stop monitoring, revoke the permission or remove the players from the group.

What Shows Up in Discord

Alerts appear inside Discord formatted as a clean rich embed titled "BigBrother Alert", complete with the player's skin thumbnail and execution timestamp.

<thead> </thead> <tbody> </tbody>
Embed Field Contents
Player The operator or staff member's username
UUID Their unique player identification code
Command The exact command text enclosed in a code block
World The specific game world where the action occurred
Location Exact X, Y, and Z coordinate metrics

Server Configuration

Administrators can configure the plugin behavior directly within its configuration file:

<thead> </thead> <tbody> </tbody>
Setting Description
webhook-url The Discord webhook URL where alerts are dispatched. Required—without this, alerts will not post externally.
server-name A text label for identifying individual servers in multi-server networks. Currently unused.