MCMetrics Installation & Setup Guide

Welcome to MCMetrics—the best analytics dashboard for Minecraft servers. This guide will walk you through setting up MCMetrics for your server network, including advanced features like payment tracking, custom events, and more.

1. Sign Up & Create a Team

• Sign up for an account.
• Click Create Team to create a team (a "team" is your server network, e.g. "Hypixel").

2. Server & Network Configuration

• Answer a few questions about your server type, size, and gamemodes. This customizes your experience.
• Choose your setup:
  • Network Setup (BungeeCord, Velocity, etc.): Select if you use ANY proxy, even if you only have one gamemode.
  • Single Server Setup: Select only if you have a single Spigot server and no proxy.
• Gamemodes: Select all gamemodes you run (e.g. Survival, Skyblock, Minigame, etc.).
• Server Type: Choose Cracked (Offline) or Premium (Online).

⚠️ Important: If you use any proxy at all, select Network type—even for a single gamemode.

3. Register All Servers

• Add every server to MCMetrics:
  • All proxies (BungeeCord/Velocity)
  • Every gamemode server
  • Every lobby/limbo/hub server
• For each server, MCMetrics will generate a unique Server ID and Server Key.

4. Download & Install the Plugin

• Download the correct plugin for each server type:
  • Spigot Plugin
  • BungeeCord Plugin
  • Velocity Plugin
• Install the plugin on each server you registered.

5. Connect Each Server

• For each server, run the setup command provided by the dashboard:

  /mcmetrics setup <server-id> <server-key>
  

  • For proxies, use /mcmetricsbungee or /mcmetricsvelocity as appropriate.

• The dashboard will automatically check for plugin connections.

• Wait for all servers to show as Connected before proceeding.

6. Payment Tracking Integration (Tebex, CraftingStore, Custom)

Tebex

1. Go to Tebex Game Servers.
2. Add a Global Server Game Command:

   mcmetrics payment tebex {username} {transaction} {price} {currency}
   

3. Edit command options:
   • Set Game Server to Execute on to the relevant server for accurate revenue breakdowns.
   • Set Require Player To Be Online to "Execute even if the player is offline".
   • Set Execution Rule to "Execute once per payment and not per package".

CraftingStore

1. Go to CraftingStore Admin Commands.
2. For each server/gamemode, create a command:
   • Command Type: Initial
   • Server: Select the correct server
   • Require player to be online: False
   • Command:

     mcmetrics payment craftingstore {player} {transaction_id} {cost} USD
     

Custom Store

• Reach out on Discord for help integrating your custom store.

The plugin/API will automatically prevent duplicate payments from being tracked.

7. Geyser/Bedrock Support

• If you use the Geyser plugin for Bedrock support:
  • Set forward-hostname: true in your Geyser config.yml on every server with Geyser installed.
  • This allows MCMetrics to track Bedrock player domains and analytics.

8. Custom Events & Funnels

• Add custom events to your plugins to track key actions (e.g. level up, guild create, etc.).
• How to track custom events:
  • Via command:

    /mcmetrics customevent <player name/uuid> <event_type> [key1=value1 ...]
    

  • Via console message: Configure the plugin to detect specific console messages for events.
• We recommend tracking at least 10-20 custom events per server for best analytics.
• Learn more about custom events & funnels

9. FAQ & Support

• Need help?
  • Read the FAQ
  • Join our Discord for support
  • View all docs