Install the plugin

Which jar to use for Paper, Folia, Spigot, Velocity and BungeeCord, how to connect it and how to run it on a network.

Updated September 15, 20263 min read

Pick the right jar

Download the plugin from Downloads. Every jar is self-contained: nothing is downloaded when the server starts.

Your serverJarNotes
Paper or Foliaanalyse-paper-<version>.jarThe safe default. Menus and commands with tab completion on Paper 1.21+ with Java 25; chat commands on older Paper.
Spigot or another Bukkit serveranalyse-spigot-<version>.jarJava 8 to 24. Chat commands only.
Velocityanalyse-velocity-<version>.jarJava 17 or newer.
BungeeCordanalyse-bungee-<version>.jarJava 8 or newer.
Not sure, or several of the aboveanalyse-all-<version>.jarWorks on every platform listed here.

What runs where

ServerJavaCommandsMenus
Spigot or Paper 1.8 to 1.208+ChatNo
Paper or Folia 1.21+25With completionsDashboard, sources, items, players and profiles
Velocity17+ChatNo
BungeeCord8+ChatNo

If the modern commands cannot load, the plugin logs Could not load the modern commands and menus; using chat commands and carries on.

Install

  1. Put the jar in your server's plugins folder.
  2. Start the server once. The plugin creates plugins/Analyse/config.yml.
  3. Connect it to your game, either by pairing or by pasting the key (below).

Without a key the plugin loads but sends nothing, and logs: No api-key in config.yml; analytics are off until one is set and /analyse reload is run.

Pair with /analyse connect

The quickest way. No copying keys.

  1. Run /analyse connect in the console (or in game with the analyse.admin permission).
  2. The plugin prints a link and a short code, like WXYZ-2K47.
  3. Open the link, sign in, check the code matches and pick the game.
  4. The key is written into config.yml (your comments are kept) and the plugin starts sending straight away. No restart.

To point a server that already has a key at a different game, run /analyse connect force=true.

Or paste the key

  1. Copy the API key from your game's Settings, Integration in the dashboard.

  2. Paste it into config.yml:

    YAML
    api-key: "ag_live_..."

  3. Run /analyse reload or restart the server.

Run /analyse status to confirm. It shows the connection, the game, the deployment and delivery counters, then checks the key.

Networks

On a network, install the plugin on the proxy and on every backend, all with the same game's key.

  • The proxy sees the player's real address and the hostname they connected with, which powers tracked domains.
  • The backends see which server a player is on, plus tick rate, commands and chat.
  • Analyse merges a player moving between backends into one session.

Pairing works on networks too: each server you pair reuses the game's existing key.

Name each server so you can tell them apart in the dashboard:

YAML
deployment:
  name: "lobby-1"   # empty uses the server folder name, or "proxy" on a proxy
  group: "network"  # leave empty for a single server

Updating

When a newer version exists, the console says so at startup. Replace the jar with the new one and restart. Your config.yml, messages.yml and menu files are kept.