Skip to main content

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.

ServerPilot ships as two ready-to-run Windows executables — a traditional installer and a portable binary — both available from the GitHub Releases page. Neither option requires Administrator privileges, and neither bundles Java, so the download is small and the install is fast. Choose the option that fits how you prefer to manage software on your machine.

​
System Requirements

Before installing, confirm your system meets these requirements:
RequirementDetails
Operating systemWindows 10 or Windows 11 (64-bit)
Java runtimeJava 17 or newer — must be installed separately
Server folderAt least one folder containing a Minecraft server JAR (e.g. paper.jar)
Disk spaceSufficient space for your server world data plus backups
Playit.ggOptional — only needed for public tunneling without port forwarding
Java is not included with ServerPilot. The app will use whatever java executable is on your system PATH, or you can provide a full path to java.exe per server. See the Quickstart guide for Java installation instructions.

​
Download Options

Both files are published on the GitHub Releases page:

ServerPilot-Setup-X.X.X.exe

Standard Windows NSIS installer. Adds ServerPilot to your Start Menu, creates an uninstall entry in Windows Settings, and places app data in %AppData%\serverpilot-v2\. Recommended for most users.

ServerPilot-Portable-X.X.X.exe

Single self-contained executable — no installation needed. Copy it to any folder, a USB drive, or a cloud-synced directory and run it directly. App data is still written to %AppData%\serverpilot-v2\.

​
Install Using the Windows Installer

1

Download the installer

Go to the GitHub Releases page and download ServerPilot-Setup-X.X.X.exe (where X.X.X is the latest version number).
2

Run the installer

Double-click the downloaded .exe file to launch the NSIS setup wizard. Windows SmartScreen may show a one-time prompt for an unrecognised publisher — click More info → Run anyway to proceed.
No Administrator privileges are required. ServerPilot’s installer is configured as asInvoker, meaning it intentionally runs at your normal user permission level and never requests elevation. Your system files are never touched.
3

Complete the setup wizard

Follow the on-screen prompts to choose an install location (the default is fine for most users) and create a Start Menu shortcut. Click Install, then Finish when the wizard completes.
4

Launch ServerPilot

Open ServerPilot from the Start Menu or the desktop shortcut that was created. On first launch the Onboarding Wizard opens automatically to guide you through adding your first server.
5

Complete the Onboarding Wizard

The wizard walks you through providing a server folder path, a JAR file name, your Java executable, and RAM settings. You can also configure a Playit.gg executable path during onboarding. Once finished, your server appears in the sidebar ready to start.

​
Run the Portable Version

1

Download the portable EXE

Go to the GitHub Releases page and download ServerPilot-Portable-X.X.X.exe.
2

Place the EXE anywhere

Copy ServerPilot-Portable-X.X.X.exe to any location you prefer — your Desktop, a project folder, or a USB drive. No extraction step is needed.
3

Run it

Double-click the file to launch the app. As with the installer version, Windows SmartScreen may prompt you once. App settings and server configurations are saved to %AppData%\serverpilot-v2\ on your user profile, not next to the EXE, so your data is preserved even if you move the binary.
4

Complete the Onboarding Wizard

On first launch the Onboarding Wizard opens automatically. Follow the prompts to add your first server, then start managing it from the dashboard.

​
Where App Data Is Stored

ServerPilot stores all application settings, server configurations, and preferences in Electron’s standard user-data path: 
%AppData%\serverpilot-v2\
On a typical Windows installation this resolves to: 
C:\Users\<YourUsername>\AppData\Roaming\serverpilot-v2\
Your actual Minecraft server files (world data, plugins, configs) remain exactly where you put them in your chosen server folder. ServerPilot never copies or moves your server files — it only reads and writes within the folder paths you explicitly provide. Server backups created by ServerPilot are written to a backups/ subfolder inside each individual server directory: 
D:\MineCraft\Server\
  backups\
    backup-2025-01-15T10-30-00.zip
    backup-2025-01-16T08-00-00.zip

​
Uninstalling ServerPilot

If you installed using ServerPilot-Setup-X.X.X.exe, remove the app through the standard Windows uninstall flow:
  1. Open Windows Settings → Apps (or Apps & features on Windows 10).
  2. Search for ServerPilot in the app list.
  3. Click Uninstall and follow the prompts.
Uninstalling removes the application binaries and Start Menu entries. Your server files and the %AppData%\serverpilot-v2\ data folder are not deleted automatically — remove that folder manually if you want a clean removal. If you used the portable version, simply delete the .exe file. Delete %AppData%\serverpilot-v2\ manually to remove saved settings.

​
Next Step

Once ServerPilot is installed and the Onboarding Wizard is open, head to the Quickstart guide to set up Java, download a server JAR, accept the Minecraft EULA, and launch your first server in under 10 minutes.

Build docs developers (and LLMs) love

Get started for freeTalk to us