Install the plugin

Getting Analyse running on your server takes about five minutes. You download a plugin, paste in an API key, and start the server. That's it.

Before you start, make sure you have access to:

• Your server files (or your host's control panel)
• An Analyse account (sign up free)

Which plugin do I need

Analyse has one plugin that runs on each backend game server. It works on the software most servers already use.

Step 1: Create a Server in Analyse

The dashboard has a guided creation page that walks you through it end to end — you don't have to juggle tabs or hunt for an API key.

1. 1

   Open your dashboard

   Log in at analyse.net/dashboard. If this is your first time and you have no Servers yet, you'll see a "Start with a Network" / "Or skip to a Server" choice.

2. 2

   Click "New Server" (or "Create a Server")

   This opens the guided /dashboard/projects/new page. First-time users also see a short intro explaining Servers vs Networks.

3. 3

   Pick game + gamemode

   Choose Minecraft or Hytale, then the gamemode. The 2026 picker covers the common ones (Survival, LifeSteal, Skyblock, Prison, Bedwars, Minigames, KitPvP, Factions, Creative). If you run something else, pick Other and type a label like Towny, UHC, or Roleplay.

4. 4

   Name your Server and set typical player count

   Name it after the gamemode (for example LifeSteal), not the brand — the brand belongs on the Network. Pick the size bucket that matches your usual concurrent player count.

5. 5

   Click "Create Server"

   Analyse creates the Server AND a default API key in one shot. The API key is shown on the very next step — no tab switching required.

Step 2: Download and install the plugin

The same guided page walks you through this. You can also do it manually by following the steps below.

1. 1

   Download the plugin

   The guided page has download buttons for Paper/Spigot, Velocity, BungeeCord, and Hytale. Alternatively, grab the jar from analyse.net/downloads.

2. 2

   Drop the jar into your plugins folder

   Same way you install any other plugin.

3. 3

   Start the server once

   This makes the plugin create its config file. Once you see the server finish starting up, stop it again.

4. 4

   Open the generated config

   The file is at plugins/Analyse/config.yml on Spigot, or the equivalent path on Hytale.

5. 5

   Paste your API key

   The guided page shows your key with a one-click Copy config line button — paste that line into config.yml and save.

6. 6

   Start the server again

   If everything's right, you'll see a green "Analyse enabled" line in the console.

Step 3: Confirm it's working

If you're on the guided page, just wait — it polls for your first heartbeat and flips to a Connected! screen as soon as the plugin talks to us.

Otherwise, join your server. Inside a few seconds, the new session should show up in your Analyse dashboard under Players and Sessions.

If nothing shows up:

• Double check the API key in the config (no trailing spaces).
• Check the server console for any red lines mentioning Analyse.
• Make sure the server can reach https://api.analyse.net (firewalls sometimes block outgoing traffic).

You're done

That's the whole install. The next step is making sure your Servers are structured the right way so you get the cleanest data. Head to the recommended setup guide.