Skip to content
Statsly Documentation

Quick Start Guide

Quick Start Guide

Section titled “Quick Start Guide”

Get your Minecraft server connected to Statsly in just a few minutes. This guide will walk you through the entire setup process.

Prerequisites

Section titled “Prerequisites”

Before you begin, make sure you have:

Step 1: Create an Account

Section titled “Step 1: Create an Account”
  1. Visit the Statsly homepage
  2. Click Sign Up or Login

Step 2: Generate a Setup Code

Section titled “Step 2: Generate a Setup Code”
  1. Log in to your dashboard
  2. Navigate to Servers in the sidebar
  3. Click Add Server or Generate Code
  4. Copy the generated setup code (it looks like: XXXX-XXXX-XXXX)

Step 3: Download the Plugin

Section titled “Step 3: Download the Plugin”
  1. Visit the Versions page
  2. Find the version compatible with your server software
  3. Click Download to get the JAR file
  4. Or use the Downloads API for automated downloads

Supported Server Software

Section titled “Supported Server Software”
  • Normal Servers: PaperMC, Spigot, Bukkit, Purpur, Quilt, LeafMC
  • Folia Servers: Folia, CanvasMC
  • Proxy Servers: BungeeCord, Waterfall, Velocity

Step 4: Install the Plugin

Section titled “Step 4: Install the Plugin”
  1. Stop your Minecraft server
  2. Place the downloaded JAR file into your server’s plugins folder
  3. Start your server
  4. The plugin will create a configuration file on first run

Configuration

Section titled “Configuration”

The plugin will automatically create a config.yml file. You’ll need to edit this file:

config.yml
api:
  # Your setup code from Step 2
  code: XXXX-XXXX-XXXX


  # API endpoint (usually doesn't need to be changed)
  url: https://api.statsly.org


# Statistics collection settings
statistics:
  # How often to send statistics (in seconds)
  interval: 60


  # Enable/disable peak player tracking
  track-peak: true


  # Enable/disable average player tracking
  track-average: true

Step 5: Connect Your Server

Section titled “Step 5: Connect Your Server”
  1. Restart your server after configuring the plugin
  2. Check the server console for connection messages
  3. Return to your dashboard - you should see your server listed
  4. Wait a few minutes for statistics to start appearing

Step 6: View Your Statistics

Section titled “Step 6: View Your Statistics”

Once connected, you can:

  • View real-time statistics in your dashboard
  • Generate charts using the Image API
  • Share your server publicly (optional)
  • Customize your server’s display settings (name, domain, description)

Next Steps

Section titled “Next Steps”

Now that your server is connected:

Troubleshooting

Section titled “Troubleshooting”

Server Not Appearing

Section titled “Server Not Appearing”

If your server doesn’t show up in the dashboard:

  1. Verify the setup code is correct
  2. Check server logs for connection errors
  3. Ensure your server has internet connectivity
  4. Try regenerating the setup code

Statistics Not Updating

Section titled “Statistics Not Updating”

If statistics aren’t updating:

  1. Verify the plugin is loaded (check /plugins command)
  2. Check plugin configuration
  3. Review server logs for errors
  4. Ensure statistics collection is enabled

Connection Errors

Section titled “Connection Errors”

Common connection issues:

  • Timeout: Check your server’s internet connection
  • 403 Forbidden: Verify your setup code is correct
  • 404 Not Found: Ensure you’re using the correct API URL

Support

Section titled “Support”

Need additional help?