Getting Started

LeavePulse is a public platform for Minecraft server communities. It can show server status, track richer telemetry through the LeavePulse Agent, support player profiles, and run whitelist application workflows across the website, Discord, and Minecraft.

Core concepts

Workspace is where your team manages ownership, members, billing, and operational settings.

Project is the public community or network page. A project can contain one server or many related servers.

Server is the actual Minecraft address or backend that players join. A server can be listed publicly before the owner connects the plugin, but management features require verification.

The Agent can be installed before it is connected. That first unconnected start is useful: it generates config, proves the jar loads on the selected runtime, and gives you local status and diagnostics commands before gateway features are enabled.

Recommended first setup

1. Sign in to LeavePulse.
2. Create or open a workspace.
3. Add your Minecraft server or project.
4. Download the Agent from Modrinth, using the website download card to confirm the correct platform build for your server or proxy.
5. Install the LeavePulse Agent for your server platform.
6. Copy the connect code from the website.
7. Run the platform connect command from the server console or an account with administrative permission.
8. Run the platform status command and a diagnostics export.
9. Open the server page and confirm that the plugin shows as connected.
10. Configure whitelist and Discord features only after the base connection is stable.

Use the connect command for the runtime where you installed the Agent:

What connecting the plugin unlocks

After the plugin is connected, LeavePulse can receive live server metadata, player counts, whitelist state, maintenance state, and selected moderation events. The exact signals depend on platform support and the settings enabled in your generated config.

connect is the normal setup path. It exchanges the website code, writes the linked server_id, configures the gateway token and WebSocket URL, and then tries to enroll the verification environment. Edit config only when diagnostics or support points to a specific field.

First diagnostics check

After connecting, run:

The export writes a JSON report to diagnostics/latest.json inside the plugin config directory. Keep that file available when asking for support; it contains the runtime state needed to understand gateway, token, whitelist, enrollment, and network issues.

Where to go next

Download the agent from Agent downloads, install it with Plugin install, then review Plugin configuration before changing advanced settings.