Do I need spark for the plugin to work?

No. spark is optional. When spark is installed, clan.me reads TPS, MSPT percentiles, and system CPU directly from spark's API, but everything falls back gracefully. Servers without spark get the same TPS, memory, GC, entity, session, and alert data via native collection.

Does the clan.me plugin work on Vanilla Minecraft?

No. Vanilla does not have a plugin API, and clan.me's analytics are powered entirely by the plugin's heartbeats. You need Paper or Spigot (or a compatible fork such as Purpur) to use clan.me. Migrating from Vanilla to Paper is straightforward and keeps your world.

Does Purpur work with the clan.me plugin?

Yes. Purpur is a drop-in fork of Paper, so the Paper JAR runs on it without any changes. Install it the same way.

What is the difference between the Paper and Spigot versions of the plugin?

They collect the same data with one exception: MSPT (milliseconds per tick) is Paper only, because it comes from Paper's getAverageTickTime() API that Spigot does not expose. TPS, memory, GC pressure, entity counts, sessions, retention, config, and all eight alert types work identically on both. On Spigot the MSPT card reads 'Paper only' and the MSPT bars are hidden from the TPS chart. Install the build that matches your server; the two JARs are not interchangeable.

Does the plugin work on Folia?

Not yet. Folia's regionised threading model makes Bukkit-style plugins incompatible without a full rewrite. Folia support is on the roadmap.

Will the plugin work on BungeeCord or Velocity?

Install the plugin on each Paper or Spigot backend, not on the proxy. Each backend gets its own plugin token, but they roll up into one public page and one dashboard for the whole network. See Monitoring a network for the full setup.

My server runs in offline mode. Does the plugin still work?

Partially. TPS, memory, uptime, entity counts, and most alerts all work normally. Player identity features such as session tracking, retention, and the player roster rely on Mojang UUIDs, which offline mode replaces with locally generated ones. Those metrics will be unreliable in offline mode.

Concepts

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.

Updated 18 June 2026

The clan.me plugin requires a server that supports the Bukkit plugin API. Since all of clan.me's analytics, alerts, and status data come from the plugin's heartbeats, your server software determines whether clan.me works for you.

Supported software

The plugin runs on:

Paper is the primary target. All plugin features are developed and tested against Paper first. Paper 1.21 or newer is required.
Spigot is fully supported. Install the same way as Paper. Spigot 1.21 or newer is required.
Purpur is supported. Purpur is a drop-in Paper fork, so the Paper JAR installs and runs on Purpur without any changes.

If your server runs a flavour of Paper or Spigot not listed here, for example Pufferfish or other performance forks, the plugin will very likely work since they maintain API compatibility.

Paper vs Spigot: what differs

clan.me ships two plugin builds, one for Paper and one for Spigot, and you install the one that matches your server. They are not interchangeable: the Paper build uses the modern Adventure component library for in-game alerts and the player privacy notice, while the Spigot build uses legacy colour codes for the same features. Trying to run the Paper JAR on Spigot will fail to load, and vice versa. Purpur and other Paper forks use the Paper JAR.

Once installed, the two builds collect the same data with a single exception. Everything below works identically on Paper and Spigot:

TPS (1m, 5m, 15m averages) and the full server health score
Heap memory usage and JVM garbage collection pressure
Entity and chunk counts per world
Player sessions, new vs returning, retention, and the player roster
Server config snapshot, installed plugin list, and restart history
All eight alert types across every delivery channel, including in-game

The one exception is MSPT (milliseconds per tick), which is Paper only. MSPT comes from Paper's getAverageTickTime() API, which Spigot does not expose. On a Spigot server the MSPT card in your Snapshot reads "Paper only" and the MSPT bars are hidden from the TPS chart. Everything else, including the TPS line those bars sit alongside, is fully populated.

In practice this rarely matters, because TPS already tells you when the server is falling behind. MSPT is the more precise companion metric: it shows how much tick budget you are using even while TPS still reads a healthy 20. If you want that millisecond-level headroom reading, run Paper or a Paper fork such as Purpur or Pufferfish, or install spark (see below). For everything else, Spigot gives you the same picture.

Spark enrichment (optional)

clan.me soft-depends on spark. When spark is installed alongside the clan.me plugin, or bundled internally in Paper 1.21+, the plugin reads from spark's API automatically with no configuration required.

What spark adds:

Trusted TPS — reads from the same source as /spark tps, eliminating any discrepancy between the two.
MSPT percentiles — p95 and p99 tick times alongside the mean, visible in the Snapshot panel.
System CPU % — a metric clan.me cannot collect without spark, charted over time in Server Health.
MSPT on Spigot — because spark provides MSPT independently of Paper's API, Spigot servers with spark get real tick-time data instead of the “Paper only” placeholder.

Without spark, all features listed above in the Paper vs Spigot comparison continue to work exactly as described. Spark is additive. See Using spark with clan.me or the spark integration page for full details.

Not yet supported

Folia, whose regionised threading model is incompatible with the Bukkit plugin API. Support is on the roadmap but requires a ground-up rewrite.
Vanilla has no plugin API, so the plugin cannot be installed. Migrating to Paper keeps your world and unlocks the whole plugin ecosystem.
Fabric / Forge / NeoForge are mod loaders rather than Bukkit-compatible servers. A mod-loader build is not currently planned for V1.
Bedrock Edition is not supported. clan.me currently covers Java Edition servers only.

Minecraft version

The plugin requires Minecraft 1.21 or newer on both Paper and Spigot. It declares api-version: 1.21 and is compiled against the 1.21 API, so older servers are not supported.

The plugin is tested against the latest stable release of each supported version. You do not need to be on the very latest patch version, but running an outdated server is always a security and compatibility risk independent of clan.me.

When you're ready, visit clan.me/download to get the plugin, then follow Connect your server for step-by-step installation instructions.

← Back to Help Center