Ctrlk

Plugin Installation

Install the PlayerAtlas build for your platform. Download the JAR from the dashboard (Download Plugins), then follow the section for your server software.

Hytale

  1. Copy the PlayerAtlas Hytale .jar into your Hytale server’s mods/ folder (alongside other mods).

  2. Start or restart the server. Plugin data (including config.yml) lives under mods/PlayerAtlas_Analytics/.

  3. If you used older metrics builds, existing data may be picked up automatically from legacy folders (for example HytaleMetrics or paths under GM_HytaleMetrics). When in doubt, check the server log for migration messages.

After you change config.yml, run /playeratlas reload or restart the server.

Paper / Spigot / Purpur (and other Bukkit forks)

  1. Put the PlayerAtlas .jar in the plugins/ directory.

  2. Restart the server (or load the plugin). The plugin data folder is plugins/PlayerAtlas/, and configuration lives in plugins/PlayerAtlas/config.yml.

  3. If you still have data under the old mcStats-Analytics folder and plugins/PlayerAtlas/config.yml does not exist yet, the plugin can migrate config.yml and related files into plugins/PlayerAtlas/ automatically.

Reload configuration with /playeratlas reload (permission playeratlas.reload, default: operators).

Velocity (ingress companion only)

The Velocity JAR is not a full PlayerAtlas install. It is an ingress companion: it captures how players connect to your proxy (virtual host, IP, session id) and forwards that context to backend servers over the plugin channel so the backend PlayerAtlas plugin can attribute joins correctly.

  • No config.yml on the proxy. No API key on Velocity. Nothing to edit for analytics settings there.

  • Drop the JAR into Velocity’s plugins/ folder and restart the proxy.

  • Run the full PlayerAtlas plugin on each backend Paper/Spigot (or other supported) server that should send analytics. The companion and backend plugins are meant to work together.

For API keys, chat logging, and other options, configure PlayerAtlas on the game servers (Configure our Plugin).

PreviousDownload PluginsNextConfigure our Plugin

Last updated