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-based server, connecting its web interface through Bloom's reverse proxy, and creating your first account.

Related Pages:

Install Plan​

  1. Download Plan from the Spigot resource page.
  2. Follow the plugin installation guide to upload the downloaded .jar file to your server's plugins folder.
  3. Restart the server. Plan should create its configuration file at plugins/Plan/config.yml.

Configure Plan​

Configure the Web Server​

  1. In the DuckPanel File Manager, open plugins/Plan/config.yml. Make sure to open port 8804 for Plan setups, instead of just any port. If it's not available, you can use a different port but remember to change the config file shown below accordingly.
  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 plugins/Plan/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​