Installation

Prerequisites

Before you begin, make sure you have:

• A ServersPulse account (register here)
• A server entry created in the dashboard
• The correct plugin build for your server platform
• Permission to restart the Minecraft server

Platform-specific install

Bukkit, Paper, or Folia

Download the Bukkit build from the downloads page and drop the .jar file into the plugins/ folder.

Fabric

Download the Fabric build and place the .jar file into the mods/ folder. Make sure you have Fabric Loader installed.

Forge

Download the Forge build matching your Minecraft version and place it into the mods/ folder. Available builds:

• Forge 1.16.5
• Forge 1.18.2 1.19.x 1.20.x 1.21
• Forge 1.21.1-1.21.10
• Forge 1.21.11+

NeoForge

Download the NeoForge build and place it into the mods/ folder. Available builds:

• NeoForge 1.20.6+
• NeoForge 1.21.1+

First startup

Start the server after adding the plugin. On first launch, the agent creates a default config.yml in its data folder:

# ServerPulse Agent Configuration
# https://serverspulse.com

# Your server's API key (get this from the ServerPulse dashboard)
api-key: ""

# Backend URL (do not change unless self-hosting)
backend-url: "https://api.serverspulse.com"

# Snapshot collection interval in seconds
# Free plan minimum: 30s, Paid plans: 5-10s
interval-seconds: 30

# Enable debug logging
debug: false

The plugin will not start sending data until an API key is configured.

Registration (recommended)

The recommended way to connect the plugin is through a one-time registration code:

1. Open your server entry in the dashboard
2. Click the option to generate a registration code
3. Copy the code
4. On your Minecraft server, run:

/serverspulse register <code>

The plugin redeems the code, writes the permanent API key into config.yml, and reloads itself automatically. No manual config editing or server restart needed.

The command also supports the aliases /sp and /pulse:

/sp register <code>
/pulse register <code>

Manual configuration

If you need to set the API key manually:

1. Open config.yml in the plugin's data folder
2. Set api-key to the permanent API key value from the dashboard
3. Run /serverspulse reload or restart the server

Available commands

All commands require operator permissions and work with the /sp and /pulse aliases.

Verifying the connection

After registration or reload, confirm the plugin is sending snapshots by checking:

1. Server console -- Look for successful snapshot messages (enable debug: true for verbose output)
2. Dashboard -- Open your server page and verify that these metrics appear:
   • TPS and MSPT
   • Memory usage (used / max)
   • Online player count
   • Per-world entity and chunk counts

Data should appear within one or two polling intervals (default: 30 seconds).

Updating the plugin

To update the ServersPulse plugin:

1. Download the latest build from the downloads page
2. Stop the server (or use a hot-swap method if your platform supports it)
3. Replace the old .jar file with the new one
4. Start the server

Your config.yml and API key are preserved across updates.

Troubleshooting

Contributors

Thanks to everyone who keeps this docs area accurate.

bwmp