Getting started

Recommended setup

One Server per gamemode, all Servers grouped in one Network. How to map your backend to Analyse.

Before you install the plugin on every backend box, take two minutes to think about structure. Getting this right makes every chart, every campaign, and every revenue number easier to read later.

The rule is simple: one Server per gamemode, all Servers grouped in one Network.

We now walk you through it

Analyse's dashboard has a guided Create a Network page and a guided Create a Server page. Both explain the structure as you go, so you don't have to memorise this doc. If you're brand new, just click Start with a Network on the dashboard and follow the steps.

Why this matters

Analyse lets you view stats in two ways:

Per Server, so you can see how each gamemode performs on its own.
Per Network, so you can compare gamemodes or see combined numbers.

If you put everything under one Server, you lose the ability to compare gamemodes. If you create dozens of tiny Servers for every shard, the numbers get messy. The recommended setup gives you the best of both.

The pattern

Say your backend looks like this:

lifesteal-1, lifesteal-2 (Paper) running the LifeSteal gamemode
survival-1 (Paper) running Survival

In Analyse you create:

Server: LifeSteal
Server: Survival
Network: Main with both of those Servers inside it

Now the dashboard gives you LifeSteal stats on their own, Survival stats on their own, and a combined view across the whole Network.

One gamemode running on multiple boxes

This is where most people get confused. If you run the same gamemode on five boxes (e.g. five LifeSteal shards), you don't need five Servers on Analyse. One Server is enough.

1
Use the same API key on every box
Paste the same apiKey value into the config.yml of all five shards.
2
Set a unique instance ID per box
In each box's config, set instance-id to something unique like lifesteal-1, lifesteal-2, and so on.
3
Done
Analyse rolls all five shards up under the same Server for reporting, but still shows per-instance breakdowns so you can spot a misbehaving box.

Easy rule to remember

If two boxes run the exact same gamemode, give them the same API key and a unique instance-id. If they run different gamemodes, give them different API keys.

Hytale is the same pattern

If you're on Hytale, everything above still applies. Use the Hytale plugin on each Hytale gamemode server, create one Server per gamemode in Analyse, and group them in a Network. Hytale is a first-class platform, not an afterthought.

What if I only have one gamemode

Then you only need one Server. A Network is optional, but we still recommend creating one. It costs nothing and makes it painless to add more Servers later without restructuring anything.

Plan limits at a glance

Free: 2 Servers, 1 Network, and up to 250 unique players shared across all your Servers combined.
Pro: 10 Servers, unlimited Networks, unlimited players.
Enterprise: unlimited everything.

On Free, once you hit 250 unique players across your entire account we keep tracking the first 250 who joined (in order of join date) so your dashboards stay stable. Upgrade to Pro to lift the cap.

What if my backend can't run the plugin

Some custom server software and a few heavily modded setups don't support Spigot or Paper plugins. In that case, fall back to a proxy-only setup where the Analyse plugin runs on your BungeeCord or Velocity proxy instead. It still works, but it can only see what the proxy sees.

Read the proxy-only setup page for how to install it and the trade-offs you should know about.

Quick checklist

One Server in Analyse per gamemode
One Network that contains all your Servers
Same API key across shards of the same gamemode, unique instance-id per shard
Different API keys across different gamemodes

Ready to hook up your store? Continue to Connect your store.