Skip to main content

Plan (Player Analytics)

Plan (Player Analytics)

Overview​

Plan (Player Analytics) records server activity such as player counts and playtime and displays the results in a web dashboard. This guide covers installing Plan on a Paper, Spigot, or Fabric server, connecting its web interface through Bloom's reverse proxy, and creating your first account.

Related Pages:

Install Plan​

  1. Download the correct Plan build for your platform. Use the Spigot resource page for Paper or Spigot, or download PlanFabric.jar from the Plan GitHub releases for Fabric.
  2. Place Plan.jar in your server's plugins folder for Paper or Spigot, or place PlanFabric.jar in its mods folder for Fabric. See the plugin installation guide or mod installation guide for panel-specific instructions.
  3. Restart the server. Plan should generate Plan/config.yml in its platform-specific data directory. Those being the plugins directory for Paper and config for Fabric.

Configure Plan​

Configure the Web Server​

  1. In the DuckPanel File Manager, open Plan's generated config.yml. Use port 8804 when creating Plan's allocation. If it is unavailable, choose a different port and update the configuration shown below to match.
  2. Update the following settings. Replace plan.example.com with the domain or subdomain you configured in the reverse proxy guide.
Webserver:
  Port: 8804
  Alternative_IP:
    Enabled: true
    Address: "plan.example.com"
  Security:
    SSL_certificate:
      KeyStore_path: proxy
  1. Save the file and restart the server to apply the changes.

Enable Location Tracking (optional)​

To allow Plan to download its GeoLite2 geolocation database, review and accept the GeoLite2 End User License Agreement, then update this setting in Plan's config.yml:

Data_gathering:
  Accept_GeoLite2_EULA: true

Save the file and restart the server after changing this setting.

Verify the Setup​

  1. Open https://plan.example.com in your browser, replacing the example address with your domain or subdomain.
  2. Select Create Account, complete the registration form, then run the displayed /plan register --code <code> command in-game to finalize the account.
  3. Confirm that the Plan dashboard loads and displays your server's analytics.

Resources​