VonixGuardian — Command Reference
VonixGuardian implements a CoreProtect-shaped brigadier command tree. Complete CoreProtect v24 parity is not claimed.
Commands are registered under the primary /vg literal, with full alias redirects for /co and /guardian.
1. Command Summary Table
Section titled “1. Command Summary Table”| Command | Aliases | Permission Node | Op Fallback | Description |
|---|---|---|---|---|
/vg help |
? |
vonixguardian.command.use |
0 | Display command summary and syntax overview. |
/vg inspect |
i |
vonixguardian.command.inspect |
3 | Toggle inspection mode on/off. |
/vg lookup <filters> |
l |
vonixguardian.command.lookup |
3 | Query audit log with filter tokens. |
/vg rollback <filters> |
rb |
vonixguardian.command.rollback |
3 | Transactionally roll back actions matching filters. |
/vg restore <filters> |
rs |
vonixguardian.command.restore |
3 | Redo or forward-restore previously rolled back actions. |
/vg undo |
— | vonixguardian.command.rollback |
3 | Revert the world changes of your last rollback/restore batch. |
/vg near |
n |
vonixguardian.command.lookup |
3 | Quick lookup for events within 5 blocks during the past hour. |
/vg purge <filters> |
— | vonixguardian.command.purge |
3 | Permanently delete audit rows older than a specified duration. |
/vg status |
— | vonixguardian.command.status |
3 | Multi-section observability: queue, storage, latency, schema. |
/vg reload |
— | vonixguardian.command.reload |
3 | Re-read config.json and hot-swap safe settings. |
/vg config <get|set> <key> [val] |
— | vonixguardian.command.reload |
3 | Query or update live configuration values. |
/vg migrate-db <backend> CONFIRM |
— | Console-Only | — | Copy data between SQLite, MySQL, and PostgreSQL backends. |
/vg consumer <pause|resume|toggle> |
— | vonixguardian.command.status |
3 | Pause or resume asynchronous background writer queue. |
/vg teleport <world> <x> [y] <z> |
tp |
vonixguardian.command.teleport |
3 | CoreProtect-parity administrative teleport. |
/vg give <itemId> [amount] |
— | vonixguardian.command.give |
3 | CoreProtect-parity administrative item spawning. |
2. Command Details
Section titled “2. Command Details”/vg inspect (alias /vg i)
Section titled “/vg inspect (alias /vg i)”Toggles interactive inspection mode for the executing player.
- Left-Click a block: Query the block history at that exact coordinate (shows who placed or broke it, and when).
- Right-Click a container: Query the inventory transaction history for that container (shows items inserted or removed).
- Right-Click a block: Inspect adjacent face changes (such as attached torches, frames, or signs).
# In-game usage:/vg inspect# Left-click target block in world/vg lookup <filters> (alias /vg l)
Section titled “/vg lookup <filters> (alias /vg l)”Queries the audit database using the filter mini-language. Lookups paginate automatically (default 7 rows per page).
# Find all block modifications by Steve in the last 2 hours/vg lookup u:Steve t:2h a:block
# Find who took diamonds within 20 blocks/vg lookup a:container i:minecraft:diamond r:20
# View the next page of results/vg lookup 2/vg rollback <filters> (alias /vg rb)
Section titled “/vg rollback <filters> (alias /vg rb)”Reverses changes matching the filter criteria in reverse chronological order.
# Preview a rollback in glass without modifying actual blocks:/vg rollback u:Griefer t:24h r:100 #preview
# Commit the actual rollback:/vg rollback u:Griefer t:24h r:100If no radius filter (r:) is provided, /vg rollback defaults to a 10-block radius around the executing player.
To perform an unbounded world-wide rollback, you must explicitly pass r:#global.
/vg restore <filters> (alias /vg rs)
Section titled “/vg restore <filters> (alias /vg rs)”Applies a forward-restore, re-applying changes that were undone by a rollback.
/vg restore u:Griefer t:24h r:100/vg undo
Section titled “/vg undo”Reverts your most recent rollback or restore operation.
- Unlike early legacy versions that only manipulated in-memory history stacks,
3.0.0-m1executes a real world revert, restoring the physical blocks to their state prior to the rollback command. - Each operator can only undo their own last operation.
# Undo previous rollback:/vg undo/vg purge <time>
Section titled “/vg purge <time>”Deletes historical rows older than the specified time parameter.
- In-game Floor: Enforced at
purge.minAgeSecondsInGame(default: 30 days /2592000seconds). Players cannot purge more recent data from chat. - Console Floor: Enforced at
purge.minAgeSecondsConsole(default: 1 day /86400seconds).
# Purge actions older than 90 days from console:/vg purge t:90d/vg status
Section titled “/vg status”Emits an observability snapshot detailing:
- Active database engine (SQLite, MySQL, PostgreSQL) and HikariCP connection pool metrics.
- Async queue size, maximum queue capacity, and dropped event count.
- Recent write latency percentiles (p50 and p99).
- Current schema version (Schema v8).
- Loader and Minecraft version identity.
/vg status/vg reload
Section titled “/vg reload”Re-reads config/vonixguardian/config.json from disk.
- Whitelisted keys (such as blacklists, theme, and lookup page sizes) are hot-swapped immediately.
- Infrastructure keys (such as
database.typeandqueue.maxSize) are reported asrequires restartand left at their initial values.
/vg reload/vg migrate-db <sqlite | mysql | postgresql> CONFIRM
Section titled “/vg migrate-db <sqlite | mysql | postgresql> CONFIRM”Copies the complete dataset from the currently active database backend to a specified target backend.
- Console-Only: Cannot be executed from chat by player operators.
- Maintenance Write-Block: Freezes incoming queue admissions and waits for in-flight ring buffer batches and sink transactions to commit before starting the copy.
- Safety Requirement: Requires explicit uppercase
CONFIRMliteral.
# Migrate current SQLite database to PostgreSQL:/vg migrate-db postgresql CONFIRM/vg consumer <pause | resume | toggle>
Section titled “/vg consumer <pause | resume | toggle>”Administrative control over the background database writer thread. Useful during heavy server profiling or emergency storage maintenance.
# Temporarily pause background database writes:/vg consumer pause
# Resume queue writes:/vg consumer resume3. When This Does Not Apply
Section titled “3. When This Does Not Apply”- Client Singleplayer: Commands are registered on the dedicated server or integrated server thread only; client-side GUIs do not intercept
/vg. - Ender-Chest Transactions: Replay of ender-chest transactions is an open CoreProtect v24 gap and is not supported in
3.0.0-m1. - Unverified Third-Party Extensions: Do not use unverified third-party Bukkit plugins with
/vg; commands communicate strictly through the modded Minecraft brigadier tree.