Help Center
Guides and reference for getting the most out of clan.me, from connecting your server to understanding your analytics.
How clan.me works, from the plugin to your page.
Connect your Minecraft server to clan.me
Step-by-step guide to connecting your Minecraft server to clan.me with the plugin and unlocking the full analytics dashboard.
Your server's public status page
What appears on your clan.me server page, how your URL slug is generated, and how to edit your server's details.
Supported server software
Which Minecraft server software is compatible with the clan.me plugin, what versions are required, and what to do if your setup is not yet covered.
Using spark with clan.me
How clan.me auto-detects spark and uses it for trusted TPS, MSPT percentiles, and system CPU, with no configuration required.
Monitoring a BungeeCord or Velocity network
How clan.me's network support works: one dashboard and one public page for your whole BungeeCord or Velocity network, with alerts and per-backend health still broken out by node.
TPS, memory, entities, and the health score.
TPS and MSPT: what they measure and what to watch for
What TPS and MSPT tell you about your Minecraft server's performance and how to interpret the numbers in your clan.me analytics dashboard.
Heap memory and Java GC: why your server runs out of breath
What the JVM heap is, how garbage collection pauses affect TPS, and how to size your server's memory correctly.
Entity count: why mob farms and item piles kill performance
What counts as an entity, why high entity counts hurt TPS, and how clan.me's per-world tracking helps you find the culprit.
How the server health score works
What the 0 to 100 health score measures, how it's calculated from average TPS and uptime, and how to interpret it.
Loaded chunks and why they matter
What a loaded chunk is, the difference between view distance and simulation distance, and how chunk count affects memory and performance.
The eight alert types and how to deliver them.
Getting started with alerts
An overview of clan.me's 8 alert types, the 4 delivery channels, and the recommended configuration for a new server.
The TPS drop alert
What triggers the TPS drop alert, what the notification email contains, and how to set a threshold appropriate for your server.
The memory pressure alert
What triggers the memory pressure alert, what the notification contains, and what to do when it fires.
The entity spike alert
What triggers the entity spike alert, what the notification contains, and the most common causes of sudden entity count spikes.
The offline alert
What triggers the offline alert, how it differs from a single missed heartbeat, and what context the alert email includes.
The weekly retention digest
What the Monday retention email contains, how to read the new player and return rate numbers, and why it's the most important weekly signal for your server.
Setting up webhook alerts
What a webhook alert delivers, how the JSON payload is structured, and how to integrate it with Discord, Slack, or a custom monitoring tool.
In-game operator alerts
How in-game alerts work, which alert types appear in chat, and how to configure them in the plugin.
Sessions, profiles, and the just-spotted feed.
Player opt-out: what is stored and how to remove your data
What player data clan.me receives from servers running the clan.me plugin, and how players can opt out and have their data removed.
How session tracking works
How clan.me defines a player session, how the plugin records exact join and quit events, and what session data appears in the dashboard.
New vs returning players: how clan.me categorises them
How clan.me decides whether a player is new or returning, and why the split is a more useful growth signal than raw player count.
The just-spotted feed
What the just-spotted feed shows on your server's public listing page, how it refreshes, and how opted-out players appear.
Player profile pages
What a player profile page shows, how to find a player's profile, and how opt-out affects what's visible.
Retention, unique players, and your busiest hours.
Reading your retention numbers
How clan.me calculates retention, what a healthy retention rate looks like, and how to use week-over-week changes to track server health over time.
The busiest hours chart
How the busiest-hours chart is built from your player data, how to read it, and how to use it for scheduling events and maintenance.
Unique players: daily, weekly, and monthly explained
What DAU, WAU, and MAU mean for your Minecraft server, how they differ from session counts, and what the D/W/MAU ratio tells you about your community.
Plugin tracking and server config snapshots.
Plugin monitoring: tracking what's installed and what's outdated
How clan.me tracks your installed plugins, how outdated versions are detected, and how to use the plugin list in your dashboard.
Server config snapshot
What settings clan.me captures in the server config snapshot, when it updates, and how config history helps you track accidental changes.
Plugin config.yml reference
Every setting in the clan.me plugin's config.yml explained: plugin token, heartbeat interval, expose_plugins, in-game alerts, and the ingest URL override.