Skip to content
ShardAnalytics

Installation

The ShardAnalytics plugin collects player sessions, gameplay events, and server telemetry. It runs on Paper servers, and it only makes outbound HTTPS connections, so you never open an inbound port.

Prerequisites

Section titled “Prerequisites”
  • A Paper server.
  • Java 21 available to the server process.
  • A ShardAnalytics organization with an existing server entry. Create one in the dashboard during onboarding if you have not already.

Install the plugin

Section titled “Install the plugin”
  1. Open your server’s Download page in the ShardAnalytics dashboard and download the latest connector build.
  2. Place the .jar in your server’s plugins/ directory.
  3. Restart the server.

Configure

Section titled “Configure”

Run the setup command from the server console and confirm it:

Terminal window
/shardanalytics setapikey <your-api-key> confirm

The command saves the key on the server, reloads the connector, and starts authentication. The confirm argument is required; the key is not accepted without it.

Verify

Section titled “Verify”

Confirm the connector is authenticated and collecting:

Terminal window
/shardanalytics stats

The output reports the authentication state, whether an API key is configured, the server name and ID, collection queue state, and transmission statistics. See Verify Data for the full check, including the dashboard side.

Next steps

Section titled “Next steps”