MineAds Monitor Plugin

We at MineAds provide this plugin to help Minecraft server owners integrate their servers with our analytics platform. It automatically tracks server activity like player joins, leaves, chat, and commands, then sends this data to us for analysis.

What We Use It For

As a server analytics platform, we collect data from servers that sign up their networks with us. We use this information to provide detailed analytics to server owners, helping them understand player behavior, optimize their servers, and improve their community's experience. This data also helps us enhance our platform's insights.

Setup Instructions

1. Download the plugin JAR file that matches your server type (Bukkit/Spigot/Paper, BungeeCord, or Velocity).
2. Place the JAR in your server's plugins folder.
3. Restart your server to generate the config file.
4. Open the config.yml file in your plugins/MineAdsMonitor folder.
5. Add your unique plugin key from the MineAds dashboard (it starts with "pluginkey_").
6. Set a server ID like "survival-main" to identify this server.
7. Save the file and restart the server again.

Configuration Options

The plugin uses a simple YAML format for its settings. Here's what each option does:

• pluginKey: Your special key from MineAds that links your server to their system. You get this from their website.
• serverId: A name for your server, like "creative-hub" or "pvp-arena", using only letters, numbers, and dashes.
• enabledEvents: Choose which types of player activities to track. By default, it tracks everything: purchases, chat, commands, joins, and leaves.
• disableChatContent: Turn this on if you don't want the actual words players type in chat to be sent (only that they chatted).
• defaultMaxCommandArgs: How many parts of a command to record. For example, "/warp home" would save 1 part (just "warp") by default.
• commandArgLimits: Set different limits for specific commands, like allowing more details for "/warp" commands.
• debug: Turn this on to see extra messages in the server console for troubleshooting.

Commands

The plugin includes commands for server admins (you need the "mineadsmonitor.admin" permission):

• /mineadsmonitor help: Shows all available commands.
• /mineadsmonitor version: Tells you what version of the plugin you're running.
• /mineadsmonitor reload: Reloads the config file without restarting the server.
• /mineadsmonitor initial/expiry/renewal/chargeback/refund [details]: Manually record purchase-related events (like when someone buys or loses a rank).

Performance and Lag Prevention

To keep your server running smoothly, the plugin is designed to be very lightweight:

• It collects data in the background without slowing down gameplay.
• Instead of sending data immediately, it groups events together and sends them in batches every 10 seconds.
• All network requests happen on separate threads, so they never interrupt your server's main operations.
• Data is compressed before sending to use less bandwidth.
• If there are connection problems, it automatically retries with smart delays to avoid overwhelming your server.