HyTari Studios · Official configuration guide

CommandSpy

Control what is monitored, by whom, and for how long.

CommandSpy separates live monitoring, personal permissions, and local auditing. This guide shows how to configure categories, the staff panel, logs, and protections for sensitive commands.

START THE GUIDE MOD PAGE

BEFORE YOU START

Getting started

STEP 01

Install the JAR

Place only one CommandSpy version in the mods folder and restart the server.

STEP 02

Assign permissions

Grant staff only the monitoring categories they actually need.

STEP 03

Configure retention

Choose which events to store and how many days to keep them.

Logs may contain commands and private conversations. Restrict access to mods/CommandSpy and use minimal staff permissions.

CHAPTER 01 · 1 EXAMPLES

Installation and files

Where configuration, staff states, and logs are created.

01STRUCTURE

Files created by the mod

CommandSpy keeps configuration, personal staff state, and one persistent audit log.

STRUCTURE
config.json
spy-state.json
console-state.json
logs/commands.log

mods/CommandSpy/

WHAT IT DOES

CommandSpy keeps configuration, personal staff state, and one persistent audit log.

IMPORTANT BEHAVIOR

  • States are saved only for staff members who currently have CommandSpy enabled.
  • commands.log is persistent and cleaned according to the configured retention.
  • The mod does not transmit monitored data outside the server.

CHAPTER 02 · 1 EXAMPLES

Permissions

Separate full access, private messages, player commands, and console.

01PERMISSIONS

Independent permissions

Monitoring categories can be assigned separately according to staff role.

PERMISSIONS
command.spy
command.spy.messages
command.spy.commands
command.spy.console

Permission plugin / server permissions

WHAT IT DOES

Monitoring categories can be assigned separately according to staff role.

IMPORTANT BEHAVIOR

  • command.spy grants full access and /cmdspy reload.
  • command.spy.messages covers recognized private-message commands.
  • command.spy.commands covers regular player commands.
  • command.spy.console allows monitoring commands executed by the console.

CHAPTER 03 · 1 EXAMPLES

Commands and panel

Each staff member controls their own monitoring categories.

01COMMANDS

Personal staff controls

The master switch and category filters are personal and can also be managed from the graphical panel.

COMMANDS
/cmdspy
/cmdspy messages
/cmdspy commands
/cmdspy console
/cmdspy gui
/cmdspy reload

In-game commands

WHAT IT DOES

The master switch and category filters are personal and can also be managed from the graphical panel.

IMPORTANT BEHAVIOR

  • Categories without permission remain visible in the panel but cannot be changed.
  • Active preferences are saved immediately.
  • When the master switch is disabled, the saved state is removed and defaults return on next activation.

CHAPTER 04 · 1 EXAMPLES

Logging and retention

Choose which categories are written to the audit file and for how many days.

01JSON

Audit log configuration

File logging is independent from live permissions and each staff member's personal filters.

JSON
{
  "default-spy-enabled": false,
  "log-player-commands": true,
  "log-private-messages": true,
  "log-console-commands": true,
  "log-retention-days": 15
}

mods/CommandSpy/config.json

WHAT IT DOES

File logging is independent from live permissions and each staff member's personal filters.

IMPORTANT BEHAVIOR

  • Each category can be logged or excluded independently.
  • log-retention-days automatically removes older lines from the persistent file.
  • The default retention is 15 days.

CHAPTER 05 · 1 EXAMPLES

Privacy and security

Credential-bearing commands are excluded before classification and logging.

01BEHAVIOR

Credential protection

Commands commonly used for login, passwords, PINs, and temporary codes are excluded before monitoring and logging.

BEHAVIOR
login / register / password / PIN / OTP
→ excluded from live monitoring
→ excluded from commands.log

Internal protection

WHAT IT DOES

Commands commonly used for login, passwords, PINs, and temporary codes are excluded before monitoring and logging.

IMPORTANT BEHAVIOR

  • Sensitive arguments are never shown to staff.
  • Audit logs can still contain private conversations and other command arguments, so restrict access to the mod folder.
  • Classification separates private messages, regular player commands, and console commands.

Before using an example

Logging options do not grant live-monitoring permissions.

The panel and personal commands do not change permissions assigned by the permission system.

Commands containing sensitive credentials are filtered before they can be displayed or written to logs.

BACK TO TOP