Skip to content

Installation

Jump to bottom
Ashutosh Das edited this page May 20, 2026 · 1 revision

Installation

This page covers everything you need to get Statfyr running on your server.

Requirements

Requirement Version
Java 16+
Paper or Spigot 1.16.5+

Note: Statfyr has been tested on Paper 1.16.5 and Paper 1.21.10. Other versions in this range should work but are not officially verified. If you encounter issues, please report them in our Discord.

Step-by-Step Installation

1. Download

Download the latest .jar from the Modrinth Versions page.

Always prefer the latest stable release. Beta versions are labelled accordingly.

2. Install the Jar

Copy the downloaded .jar file into your server's plugins/ directory:

your-server/
└── plugins/
    └── statfyr-1.0.0-BETA.jar   ← place it here

3. Start the Server

Start or restart your server. On first run, Statfyr will:

  • Generate plugins/statfyr/config.yml
  • Bind the HTTP server to port 8080 by default
  • Log its startup status to the console You should see something like:
[Statfyr] Starting HTTP server on 0.0.0.0:8080
[Statfyr] Statfyr 1.0.0-BETA enabled successfully.

4. Verify the API is Running

Make a request to the health endpoint:

GET http://your-server-ip:8080/api/health

A successful response looks like:

{
  "status": "ok",
  "plugin_version": "1.0.0-BETA",
  "server_version": "git-Paper-790",
  "bukkit_version": "1.21.10-R0.1-SNAPSHOT",
  "online_players": 0,
  "minecraft_version": "1.21.10",
  "uptime_seconds": 14
}

5. Configure

Open plugins/statfyr/config.yml and adjust settings to your needs. See the Configuration page for a full reference.

After making changes, run /statfyr reload in-game or from the console — no restart required.

Port Forwarding

By default, Statfyr listens on port 8080. If you want the API to be accessible from the internet, you need to open this port in your firewall or server panel.

If you only need local access (e.g., a dashboard running on the same machine), set bind-address: "127.0.0.1" in the config to prevent external exposure.

Updating

  1. Stop your server
  2. Replace the old .jar in plugins/ with the new one
  3. Start the server Statfyr will migrate the config automatically if needed. Always check the Changelog before updating to be aware of breaking changes.

Uninstalling

  1. Stop your server
  2. Remove statfyr-x.x.x.jar from plugins/
  3. Optionally delete plugins/statfyr/ to remove all config and data

Next: Configuration

Clone this wiki locally