This comprehensive documentation covers everything you need to know about using Auditor to monitor, analyze, and secure your server's economy. From basic setup to advanced features, this guide will help you maximize the plugin's potential.



Installation
1. Download Auditor.jar
2. Place in your server's plugins folder
3. Ensure Vault is installed
4. Restart your server
5. Configure using /auditor settings or edit config.yml

First Launch
After installation, use /auditor to open the main dashboard. Navigate to Settings → Permissions to configure staff access levels, then verify Vault connection in Settings → Integrations. Review monitoring thresholds in Settings → Monitoring to customize detection sensitivity.

Basic Workflow
Your typical usage pattern: Dashboard for economy overview → Active Alerts for suspicious activities → Player Selection for detailed analysis → Reports for data export → Settings for configuration adjustments.


Main Dashboard Overview
The dashboard displays real-time economy health metrics including overall health score (0-100), active alert count, recent transaction feed, top players by balance, and key statistical trends. Use this as your command center for monitoring server economic activity.

Player Analysis Interface
Player profiles show comprehensive data: profile header with player skin and online status, automatically calculated risk assessment, transaction summaries with spending and earnings, activity timeline of recent transactions, assigned flags for categorization, and private admin notes for staff coordination.

Alert Management System
Alerts are categorized by risk level: LOW (normal behavior), MEDIUM (unusual patterns), HIGH (significant anomalies), and CRITICAL (immediate attention required). Each alert includes detailed information about the trigger and recommended actions.



Alert Types Explained
Spending Spike Alert - Triggers when players spend 5x their normal amount, indicating possible account compromise or duplication exploits.

Large Transaction Alert - Activates for single transactions exceeding $50,000 (configurable), useful for catching economy exploits.

Rapid Transaction Alert - Detects 20+ transactions in 5 minutes, identifying automated or bot behavior.

Possible Duplication Alert - Analyzes wealth increase patterns to detect duplication exploits, marked as highest priority.



Main Configuration
Configure monitoring options in config.yml: enable/disable transaction tracking, balance change monitoring, command usage logging, and location data collection. Set alert preferences including Discord webhook integration and notification cooldowns. Adjust database settings for auto-cleanup intervals and backup scheduling.

Alert Thresholds
Customize detection sensitivity in alerts.yml: spending spike multipliers and minimum amounts, large transaction thresholds, rapid transaction counts and timeframes, and duplication detection parameters. Each threshold includes severity level configuration.

Discord Integration
Create a Discord webhook in your channel, copy the webhook URL, add it to config.yml as discord_webhook, and test using Settings → Integrations → Test Webhook. Receive real-time alerts directly in your Discord server.

PlaceholderAPI Support
Available placeholders: %auditor_balance%, %auditor_transactions%, %auditor_risk_level%, %auditor_flags%, and %auditor_monitored%. Use these in other plugins for enhanced integration.



Performance Impact
Auditor uses asynchronous database operations and is highly optimized for minimal server impact. All heavy processing occurs off the main thread.

Data Retention
Data is stored for 90 days by default (configurable). Players with auditor.player.view permission can view their own profiles. Use Export Settings to generate CSV files for external analysis.

Economy Plugin Compatibility
Works with any Vault-compatible economy plugin including EssentialsX, CMI, and others. Players with auditor.bypass permission are excluded from monitoring.



No Players in Selection GUI
Ensure transactions have occurred, verify Vault installation, confirm economy plugin functionality, and try /auditor reload.

Alerts Not Triggering
Check alerts.enabled in config.yml, verify threshold settings in alerts.yml, ensure monitoring is enabled, and confirm players don't have bypass permission.

Database Errors
Run /auditor maintenance, check available disk space, verify file permissions, and consider database cleanup.

GUI Not Updating
Check refresh_interval_seconds in config, verify no console errors, and try closing and reopening the GUI.

Player Flag System
Use flags for player categorization: SUSPICIOUS for investigation targets, BOT_SUSPECTED for automated accounts, TRUSTED for verified players, VIP for special monitoring, and MERCHANT for shop owners.

Bulk Operations
Export 30-day transaction data: /auditor export transactions 30d
Monitor all online players: /auditor monitor * on
Clean old alerts: /auditor maintenance cleanup alerts 7d

Daily Management
Review active alerts and check dashboard health score daily. Weekly tasks include data backup export, top player review, and old alert cleanup. Monthly maintenance involves trend analysis, threshold adjustment, and full system maintenance.


Discord Support: Join our Discord
GitHub Issues: Report bugs here
Wiki: Full documentation