Plugin Configuration

Plugin Configuration Guide

Learn how to configure the Statsly plugin for optimal performance and data collection.

Configuration File

The plugin creates a config.yml file in your server’s plugins/Statsly directory on first run.

Basic Configuration

config.yml

api:
  # Your setup code from the dashboard
  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 to the API (in seconds)
  interval: 60

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

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

Configuration Options

API Settings

• code (required): Your unique setup code from the dashboard. Format: XXXX-XXXX-XXXX
• url (optional): API endpoint URL. Default: https://api.statsly.org

Statistics Settings

• interval (optional): How often statistics are sent to the API in seconds. Default: 60 (1 minute)

  • Minimum: 30 seconds
  • Maximum: 300 seconds (5 minutes)
  • Lower intervals provide more detailed data but increase API calls

• track-peak (optional): Enable peak player count tracking. Default: true

  • When enabled, tracks the highest player count during each interval

• track-average (optional): Enable average player count tracking. Default: true

  • When enabled, calculates average player count over each interval

Advanced Configuration

Performance Optimization

For servers with many players or limited resources:

config.yml

statistics:
  # Increase interval to reduce API calls
  interval: 120  # 2 minutes

  # Disable average tracking if not needed
  track-average: false

High-Detail Tracking

For detailed analytics:

config.yml

statistics:
  # Shorter interval for more data points
  interval: 30  # 30 seconds

  # Enable both tracking types
  track-peak: true
  track-average: true

Connection Process

1. Plugin Startup: The plugin validates your setup code on startup
2. Code Validation: The plugin sends a validation request to the API
3. Pending Connection: A pending connection is created in your dashboard
4. Confirmation: You must confirm the connection in your dashboard
5. Active Connection: Once confirmed, statistics start being collected

Tip

Check your server console for connection status messages. The plugin will log connection attempts and any errors.

Troubleshooting

Plugin Not Connecting

1. Verify your setup code is correct
2. Check that your server has internet access
3. Ensure no firewall is blocking outbound connections
4. Check server logs for error messages

Statistics Not Sending

1. Verify the plugin is loaded (use /plugins command)
2. Check the interval setting is not too high
3. Review plugin logs for errors
4. Ensure the server is running and has players

Configuration Errors

If the plugin fails to load:

1. Check YAML syntax in config.yml
2. Ensure all required fields are present
3. Verify the setup code format is correct
4. Check server logs for specific error messages

Best Practices

• Keep your setup code private: Don’t share it publicly
• Use appropriate intervals: Balance between detail and performance
• Monitor plugin performance: Check logs regularly
• Update regularly: Keep the plugin updated for best performance

Support

If you’re experiencing issues:

• Check the Quick Start Guide for setup instructions
• Review Server Management for dashboard features
• Open a support ticket for assistance