Once you have Java installed and a prepared server folder with an accepted EULA, adding your server to ServerPilot takes less than a minute. The Server Modal walks you through every option, and most fields are pre-filled from your global Settings defaults — so you only need to fill in the folder path and JAR name for subsequent servers.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/GKExpo/ServerPilot/llms.txt
Use this file to discover all available pages before exploring further.
Adding Your First Server
Open the Add Server modal
Click the Add Server button (or the + icon in the sidebar). The Server Modal opens with all fields pre-populated from your global Settings defaults.
Fill in the required fields
At minimum you need to provide:
- Server name — a display name for this server in the sidebar
- Folder path — the full path to your server folder on disk
- Server JAR — the filename of your server JAR inside that folder
server:detect on it — scanning for JAR files and setting Server JAR and Server type for you.Review and adjust optional settings
The remaining fields (Java path, RAM, JVM arguments, Playit settings) are pre-filled from your global defaults. Adjust any that need to differ for this particular server.
Save the server
Click Save Server. The server appears in the sidebar immediately. The Save button is disabled until Server name, Folder path, and Server JAR are all filled in.
Field Reference
Basic Identity
The display name for this server shown in the sidebar, Dashboard title, and desktop notifications. Choose something descriptive, like
My Paper Server or SMP World. This field is required — the Save button will not activate without it.The server software type. Accepted values are
Paper, Fabric, Forge, Vanilla, and Unknown. This field is informational — it does not change how the server is launched. It is set automatically when you browse to your folder via the folder picker (using server:detect), but you can also change it manually with the dropdown.Paths
The full absolute path to your server folder on Windows, for example
D:\MineCraft\MyServer. The folder must exist on disk — ServerPilot validates this before starting the server. Use the Browse button to select it with the system folder dialog, which also triggers auto-detection of the JAR and server type.The filename of the server JAR inside the folder, for example
paper.jar. This must be the bare filename only — no path prefix. The file must exist at folderPath\jarName. ServerPilot populates this automatically when you use the folder browser, but you can type it manually if needed.The Java executable to use when launching this server. Defaults to Use the browse button to select
java, which works if Java is on your system PATH. To use a specific Java installation, set this to the full path of java.exe, for example:java.exe from a file dialog. The per-server value here overrides the global Default Java Path in Settings.Memory Allocation
The
ramMin and ramMax fields map directly to the JVM -Xms (initial heap) and -Xmx (maximum heap) flags. Do not include -Xms or -Xmx in the JVM arguments field — ServerPilot adds them automatically from these two fields, and duplicates will be detected and stripped with a console warning.Minimum (initial) heap size passed as
-Xms. Use standard JVM notation: 2G, 512M, 1024M. Should be equal to or less than ramMax. Setting both to the same value (e.g., both 4G) avoids heap resizing at runtime, which is common for production servers.Maximum heap size passed as
-Xmx. The server process will never use more RAM than this value for the Java heap. Set this according to the available RAM on your host machine — for most home servers, 4G to 8G is appropriate.JVM Arguments
Extra JVM flags appended to the launch command between the RAM flags and Do not include any of the following — ServerPilot manages them automatically and will silently strip them out:
-jar. Use this for performance tuning only. Example:javaorjava.exe-jar(and the JAR filename after it)-Xms/-Xmxnogui
Playit.gg Settings
Per-server path to the
playit.exe executable. Leave blank to use the global Playit Executable Path from Settings. Set this if you want a specific server to use a different Playit installation, or if you have not configured the global path but still want Playit on this server.Controls whether this server participates in Playit auto-start. ServerPilot skips launching Playit only when both this per-server value and the global Auto-start Playit setting in Settings are
false. If either is true, Playit will be started alongside the server. The effective executable path is playitPath (this server) falling back to the global playitPath (Settings). If neither resolves to a valid file, auto-start is skipped and a warning is logged to the console.How Defaults Work
When you open the Add Server modal, ServerPilot pre-fills several fields from your global Settings:| Field | Source |
|---|---|
javaPath | Settings → Default Java Path |
ramMin | Settings → Default Min RAM |
ramMax | Settings → Default Max RAM |
autoStartPlayit | Settings → Auto-start Playit |
playitPath | Settings → Playit Executable Path |