Configuration

Every option in config.yml, plus messages.yml and the menu files.

Updated September 15, 20262 min read

The plugin keeps its files in plugins/Analyse/. Change them and run /analyse reload; no restart needed.

config.yml

YAML
# Get the API key from the game's integration page on the dashboard.
api-key: ""
endpoint: "https://gateway.analyse.net"

deployment:
  name: ""
  group: ""

delivery: batched
flush-interval-seconds: 5
payment-currency: "USD"

collect:
  tps:
    enabled: true
    every-seconds: 60
  commands:
    enabled: true
  chat:
    enabled: false

Options

KeyDefaultWhat it does
api-key""Your game's API key. Set by /analyse connect, or paste it from Settings, Integration
endpointhttps://gateway.analyse.netWhere events go. Leave it as is
deployment.name""This server's name in the dashboard. Empty uses the server folder name, or proxy on a proxy
deployment.group""The network this server belongs to. Leave empty for a single server
deliverybatchedbatched sends every flush interval. instant sends each event right away (a burst still shares one request)
flush-interval-seconds5Seconds between batches. Minimum 1. Ignored with delivery: instant
payment-currencyUSDCurrency for /analyse payment when none is given
collect.tps.enabledtrueReport tick rate and MSPT
collect.tps.every-seconds60How often, between 10 and 3600
collect.commands.enabledtrueRecord which commands players run (name only)
collect.chat.enabledfalseRecord chat messages (first 256 characters)

Sending always happens off the server thread, whichever delivery mode you choose.

What reload does

/analyse reload re-reads config.yml, messages.yml and the menu files. If the key or endpoint changed, the plugin reconnects with the new values; otherwise it re-checks the key.

messages.yml

Every message the plugin shows, written in MiniMessage. Use <prefix> for the shared prefix and %placeholder% tokens where a message has values. Delete a key to fall back to the default.

On Paper and Folia 1.21+ with Java 25, the plugin adds inventory menus, configured in menus/:

  • menus/dashboard.yml
  • menus/sources.yml
  • menus/items.yml
  • menus/players.yml
  • menus/player.yml