Custom events

Custom events let you record named actions for specific players from your Minecraft or Hytale game server (for example tutorial.completed or shop.checkout). Events are sent through the PlayerAtlas plugin, batched to the ingest API, and appear in your PlayerAtlas project for reporting and funnels.

What you need

• The PlayerAtlas plugin installed and configured with a valid API key for your game server (Configure our Plugin).

• For in-game commands: permission playeratlas.customevent (see Using Commands).

• For code: the Java API on the classpath (Using Java API).

Event keys

Each event has an eventKey string:

• Lowercase letters a–z, digits 0–9, and single dots between segments only.

• No leading, trailing, or double dots.

• Up to 128 characters.

• Examples: quest.started, island.created, shop.checkout.

Invalid keys are rejected or dropped; your game server may log a warning.

Parameters (properties)

Optional key/value properties travel with the event. In the Java API, use EventParams with typed helpers (putInt, putLong, putDouble, putString, putStringList). From the command line, pass key=value tokens; values are parsed as integer, long, double, or string (see Using Commands).

Parameter keys used in funnel filters in the dashboard must match letters, numbers, and underscores (up to 64 characters).

Dashboard

After events are ingested, you can explore them in your project’s analytics views and use them as steps in funnels (see Funnels).

Further reading

• Using Java API

• Using Commands