Welcome to MinecraftMetrics Server Installation

Welcome to MinecraftMetrics! the analytics dashboard for minecraft servers. This guide will walk you through setting up MinecraftMetrics for your server(s) including features such as payment tracking, custom events and more.

Installing for a Server is specific to Server Owners running a minecraft server. Each server (no matter a single server, hub or minigame) requires the plugin to be installed and added to MinecraftMetrics.

1. Signup

- Visit https://minecraftmetrics.net/auth/login to create an account.
- Login via Discord or by Magic Login (an email is sent to you).

2. Adding Servers

- Press "Add Server" and provide a "Server Name" and "Server Group".
- Click the Type of server you are using.
- Click Version of server you are using.
- Upload the Plugin into your servers plugin folder and restart the server.
- Click "Next Step" and copy/paste the command provided into your server.
- Once the command has been sent, wait a few second for your page to refresh.
- Complete these steps for each server you would like to monitor.

3. Permission

- minecraftmetrics.admin: Grants access to all MinecraftMetrics commands.

3. Commands

- /minecraftmetrics setup {server_id} {server_key}:
Configure the plugin with your Server ID and Server Key for MinecraftMetrics dashboard.

- /minecraftmetrics payment {provider} {username} {tx_id} {price} {currency} {description}:
Manually records a payment for a player. Read here for a full guide.

- /minecraftmetrics customevent {player} {key} {key1=value1...}:
Creates/Updates a custom event for a player with optional metadata. Read here for a full guide.

- /minecraftmetrics check {player/uuid}:
Returns URL to view a specific player MinecraftMetrics

- /minecraftmetrics vote {player/uuid}:
Manually adds a vote for a Player for MinecraftMetrics to process.

- /minecraftmetrics status:
Check the status of your connection to MinecraftMetrics