Set up Mectris on your Minecraft network

You install the plugin once per Minecraft server, link it to your account with a claim token, and the rest happens on its own. There is no database to run, no port to open, and nothing to configure beyond that one token.

Connection details

• The plugin only makes outgoing HTTPS requests to api.mectris.com on port 443. Nothing listens for incoming traffic, so there is no port to forward.
• Every report is sent asynchronously, off the main thread, once per 180 seconds.
• Player sessions are buffered and flushed with the next report, and also on shutdown, so a clean restart does not lose sessions.
• If no report arrives for about 3 minutes, the server is marked offline, an incident is opened and offline alerts are sent.

1. 1

   Sign in with Discord

   Open the dashboard and authenticate with Discord. No password, no extra account.

2. 2

   Create a server and copy the claim token

   Go to Servers, press Add Server, give it a name and copy the token. It is valid for 15 minutes.

3. 3

   Drop the plugin into your server

   Put the jar into plugins/ and start the server so the plugin can generate its config.

4. 4

   Claim the server

   Run this in the console or in game:

   consoleCopy

   /mectris claim hK3v9Qz2Lf7bR1sYtN0pXcE8mA4uJ6wD

5. 5

   Wait for the first report

   The server shows up as online immediately, and the first performance point lands after 3 minutes.

1. 1

   Download the plugin

   Grab the latest build from our Discord.

2. 2

   Copy it into the plugins folder

   Upload the jar to your server, into the plugins/ directory.

3. 3

   Start or restart the server

   On the first start the plugin downloads its libraries into plugins/mectris-paper/libs/ and writes its config files. This needs internet access and takes a few seconds.

What you end up with

plugins/
├── mectris-paper-1.0.0.jar
└── mectris-paper/
    ├── config.yml
    ├── messages.yml
    ├── credentials.json
    └── libs/

1. 1

   Open the Servers page

   In the dashboard sidebar, choose Servers.

2. 2

   Press Add Server

   Pick a name you will recognise later, such as Survival or Lobby-1. Up to 64 characters.

3. 3

   Copy the claim token

   The token is shown once the server is created, together with its expiry time. If you lose it or it expires, open the server and press Generate new token on the connect card.

How many servers you can create depends on your plan. If you are out of slots, the dashboard tells you when you press Add Server — see Plans & limits.

Option A — the command (no restart)

Run this from the console or in game. The claim happens asynchronously and reporting starts right away.

/mectris claim hK3v9Qz2Lf7bR1sYtN0pXcE8mA4uJ6wD

Option B — the config file

Paste the token into plugins/mectris-paper/config.yml, then start or restart the server.

claim-token: 'hK3v9Qz2Lf7bR1sYtN0pXcE8mA4uJ6wD'
 
version: 1

• After a successful claim the plugin clears claim-token from the config by itself and stores its credentials in credentials.json.
• If the claim fails at startup, reporting does not start. Fix the token (or clear it and use the command) and restart.
• Each server needs its own token. Never reuse one token, and never copy credentials.json to another server.

Console

[Mectris] Claim token detected, connecting to Mectris...
[Mectris] Connected! Server ID: 8c1f2ad4-5b3e-4c19-9f0a-7d61e2b4c8aa
[Mectris] Metrics reporting started (every 180s).
[Mectris]    The plugin successfully started.

/mectris status answers the same question at any time:

▎ Mectris ┃ Status
 
 ┃ Connection › ● Connected
 ┃ API URL › https://api.mectris.com
 ┃ Interval › 180s
 ┃ Server ID › 8c1f2ad4-5b3e-4c19-9f0a-7d61e2b4c8aa
 ┃ Installation › 1f9c77e0-3a25-4a6b-bd42-90c0f2f7a1d3

Dashboard

• The server switches from Pending to online as soon as the claim succeeds.
• Server info (software, version, Java, OS, plugin count) is sent immediately, so the Server Info card fills in first.
• The first performance point arrives after 3 minutes, so empty charts right after connecting are normal. Use /mectris metrics in the meantime for a live readout.

Running /mectris disconnect stops all of it: the plugin flushes what it has, tells the API the server is gone and deletes its credentials.

• Same server, new host: move the whole plugins/mectris-paper folder with it. The credentials stay valid and history continues uninterrupted.
• Cloning a server template: delete credentials.json from the copy, then claim it with a fresh token. Two servers cannot share one installation.
• Reconnecting: run /mectris disconnect, then open the server in the dashboard and generate a new token. Your existing metrics are kept.
• Retiring a server: disconnect the plugin, then delete the server in the dashboard to free the plan slot. Deleting removes its history.

• Total managed players, unique players today, players online right now and how many servers are active.
• Player traffic over time, with the range following the history window of your plan.
• A top players leaderboard aggregated across servers.
• A network status panel listing each server with its current state.

The page refreshes on its own while it is open, so it can stay up on a second monitor.

• Add Server creates an entry and hands you a claim token in the same step.
• Folders unlock once you own 3 servers or more. Drag a server onto a folder, or use the row menu, to group networks such as Survival, Creative and Lobbies.
• Deleting a server frees the plan slot and removes its stored metrics. Disconnect the plugin first, otherwise it keeps trying to report.

Pages your plan does not include are marked with a lock in the sidebar. Nothing is lost by staying on Free — the locked pages simply start filling in when you upgrade.

1. 1

   Create a webhook in Discord

   In your Discord server open Channel settings → Integrations → Webhooks, create one and copy its URL.

2. 2

   Paste it into the Alerts page

   Open your server, go to Alerts and paste the URL into the webhook field.

3. 3

   Choose what to be woken up for

   Toggle offline and back-online notifications, and set the TPS, CPU and memory thresholds you care about. Leave a threshold empty to disable that check.

4. 4

   Save

   The webhook is validated when you save, so a wrong URL is caught immediately.

• Open a server, find the Team Members card on the Overview page and add someone by their Discord username.
• They need to have signed in to Mectris at least once, so their account exists.
• Members see the dashboards of that server; adding, deleting and billing stay with the owner.
• Pro includes 3 members per server. Verified accounts have no limit.

Verified is granted by us, not bought — it is for partners and larger networks we work with directly. Ask on Discord if you think that is you.

• Chart ranges and comparisons follow your window, so a Free account sees hourly detail rather than months of trend.
• Player totals and leaderboards are counted from stored sessions, so they grow as history accumulates.
• Upgrading widens the window for data collected from that point on; data already outside the window is gone.

Account, billing and privacy questions: support@mectris.com.