Installation

Installation

ServerDoctor ships as one universal jar that works as both a Paper/Folia plugin and a Velocity plugin — the same file carries a plugin.yml and a velocity-plugin.json.

1. Get the jar

Download a release from the releases page, or build it yourself (see Building from Source):

gradle :serverdoctor-universal:shadowJar
# -> serverdoctor-universal/build/libs/serverdoctor-0.6.0.jar

2. Install

Paper / Folia

Drop serverdoctor-0.6.0.jar into the server's plugins/ folder and start the server. On first start it creates plugins/ServerDoctor/config.yml and messages.yml.

• api-version targets 1.20+, tested on 1.21.x.
• Folia is supported (the scheduler adapter switches automatically).
• PlaceholderAPI is an optional soft-dependency; if present, the serverdoctor expansion registers itself. See PlaceholderAPI.

Velocity

Drop the same jar into the proxy's plugins/ folder and start Velocity. On first start it copies config.yml into the plugin's data directory.

On a proxy there is no tick loop, so the Performance scanner is skipped there by design (capability gating). The proxy still records plugin, dependency, conflict and security findings.

3. Configure storage (optional)

The default backend is SQLite (a local file). To use a shared database for a whole network, edit config.yml and set storage.type to postgresql, mariadb or mongodb, then fill in the credentials. See Configuration and Storage Backends.

4. Verify

/serverdoctor scan
/serverdoctor report

/sd and /doctor are aliases. The permission is serverdoctor.admin (default: op). A background scan also runs automatically every 5 minutes.