Getting started

This guide walks you through the full onboarding flow from account creation to seeing live metrics in the dashboard.

1. Create your account

Go to the registration page and create an account using your email or sign up with Discord, Google, or GitHub via OAuth.

After registering with email, check your inbox for a verification email and click the link to activate your account.

2. Create a server entry

Once logged in, open the dashboard and navigate to the servers list. Click the button to create a new server. Give it a recognizable name -- this is what appears in the sidebar and on alerts.

You can optionally assign a group name to organize multiple servers (e.g., "Survival", "Minigames", "Hub").

3. Download the plugin

Go to the downloads page and pick the build that matches your server platform:

• Bukkit / Paper / Folia -- .jar file for plugins/
• Fabric -- .jar file for mods/
• Forge -- .jar file for mods/ (check your Minecraft version)
• NeoForge -- .jar file for mods/

Place the downloaded file into the correct folder on your Minecraft server.

4. Start the server

Start (or restart) your Minecraft server. The ServersPulse agent will create a default config.yml in its data folder on first launch.

5. Register the server

After creating the server entry in the dashboard, copy the one-time registration code displayed on the server page.

On your Minecraft server, run the following command from the console or as an operator:

/serverspulse register <code>

The plugin will redeem the code, write the permanent API key into config.yml, and reload itself automatically. You can also use the shorter aliases /sp register <code> or /pulse register <code>.

6. Verify incoming data

Once registered, the plugin starts sending snapshots at the configured interval (default: 30 seconds). Open your server's dashboard page and confirm you see:

• TPS -- Ticks per second (target: 20.0)
• MSPT -- Milliseconds per tick (lower is better)
• Memory -- Used vs. allocated heap memory
• Players -- Current online player count
• World metrics -- Per-world entity and chunk counts

If metrics do not appear within a minute, see the Installation troubleshooting section.

7. Recommended first steps

After data is flowing, consider these setup tasks:

Set up alert rules

Navigate to the Rules tab on your server page and create at least one notification rule. Good starting points:

• TPS below 18 sustained for 60 seconds (critical)
• Server offline detection (critical)
• Memory above 90% sustained for 120 seconds (warning)

See the Alerts documentation for details on rule types and configuration.

Connect Discord

If you are on a Starter plan or above, you can link your Discord guild to receive alert notifications in a channel. See the Discord Bot guide for setup instructions.

Invite teammates

If other admins or moderators need access, go to the Sharing tab and create an invite link with the appropriate role. See Team Access for role descriptions.

Adjust the polling interval

The default polling interval is 30 seconds. Paid plans can use lower intervals for finer-grained data:

Edit config.yml and change interval-seconds, then run /serverspulse reload. See Configuration for details.

Contributors

Thanks to everyone who keeps this docs area accurate.

bwmp