Docs
Sign In

Installation Guide

Get Analyse running on your Minecraft server in under 5 minutes.

Prerequisites

Before you start, you'll need:

  1. An Analyse account — Sign up here
  2. A Minecraft server running Paper, Spigot, Velocity, or BungeeCord
  3. Java 17+ on your server

Step 1: Create a Project

  1. Log in to your Analyse Dashboard
  2. Click "New Project"
  3. Enter your server name and type

Step 2: Get Your API Key

  1. Go to Project Settings → API Keys
  2. Click "Create API Key"
  3. Copy the key — it starts with anl_

⚠️ Important: Save your API key somewhere safe. You won't be able to see it again!

Step 3: Choose Your Setup

📦 Paper Plugin

Best for: Custom integrations, A/B testing, custom events

Use this if you want to hook into the SDK from your own plugins, run A/B tests, or track custom events.

🚀 Proxy Plugin

Best for: Simple setup, basic analytics

Use this if you just want player retention, campaign attribution, Tebex revenue tracking, and online player counts.

Step 4: Install & Configure

📦 Paper

  1. Stop your server
  2. Download the plugin from GitHub Releases
  3. Place analyse-paper.jar in your plugins/ folder
  4. Start your server (creates the config)
  5. Stop the server and edit the config below
  6. Start your server
debug: false
api-key: "anl_your_api_key_here"
bedrock-prefix: "."
instance-id: "default"

🚀 Proxy

  1. Stop your proxy
  2. Download the plugin from GitHub Releases
  3. Place the plugin jar in your plugins/ folder
  4. Start your proxy (creates the config)
  5. Stop the proxy and edit the config below
  6. Start your proxy
{
  "debug": false,
  "bedrockPrefix": ".",
  "instanceId": "default",
  "apiKey": "anl_your_api_key_here"
}

Step 5: Verify

  1. Start your server/proxy
  2. Join your server
  3. Check the console for [Analyse] Analyse enabled successfully!
  4. Visit your dashboard — you should see your first player!

Troubleshooting

"Invalid configuration! Please set your API key"

  • The key must start with anl_
  • No extra spaces or quotes
  • Copy it exactly from the dashboard

No data appearing

  1. Set debug: true in your config
  2. Restart and join the server
  3. Look for [DEBUG] messages in console

"Failed to send join event"

  • Check your server can reach api.analyse.net
  • Make sure port 443 (HTTPS) isn't blocked

Next Steps

Next

Domain Verification