Plugin Installation

Installation varies depending on your network architecture. Choose your scenario below.

Scenario 1: Standalone Server

The most common setup for Paper, Spigot, Fabric, or NeoForge.

1. Download Artifact:
   • For Paper/Spigot: verified-plugin-bukkit.jar.
   • For Fabric/NeoForge: verified-plugin-mod.jar.
2. Install: Place the file in the plugins (or mods) folder and restart your server.
3. Connect:
   text

   /leavepulse connect <code>
   

   Copy

Scenario 2: Proxy Network (Velocity / BungeeCord)

Recommended for networks. The Agent is installed only on the proxy, and backend data is relayed.

1. Download Artifact:
   • For Velocity: verified-plugin-velocity.jar.
   • For Bungee/Waterfall: verified-plugin-bungee.jar.
2. Install: Place the file in the proxy's plugins folder and restart it.
3. Connect:
   text

   /leavepulsevelocity connect <code>  (on Velocity)
   /leavepulsebungee connect <code>    (on BungeeCord)
   

   Copy
4. Backend Setup: The Proxy Agent will attempt to auto-match backend names from your velocity.toml or config.yml to LeavePulse server records. If they differ, configure mapping in the backend_relay section.

Scenario 3: Detailed Backend Telemetry

Use this if you need whitelist enforcement or detailed telemetry (TPS, RAM) per sub-server.

1. Install the Agent on the proxy (as in Scenario 2).
2. Install the Agent on each backend server (as in Scenario 1).
3. Connect each sub-server to its own record on the website.

Post-Install Verification

Run the status command to see your environment type as detected by the Agent:

Note the Env (Environment) field:

• ingress/standalone — Regular standalone server.
• bridge/network — Proxy server.
• backend/subserver — Sub-server with its own Agent.