Open source game launcher for Spiral Knights. Supports automatic 64-bit Java VM installation, Discord integration, easier modding & much more.
- Install and uninstall game mods in an easy and noob-friendly way without worrying about game updates.
- Jump into several editors to create custom user-generated content or simply preview game models.
- Automatically patch your game to use a 64-bit Java VM to improve the game's performance.
- Re-install and verify your game files with ease.
- Intuitive and user-friendly UI for configuring advanced Java VM settings.
- Discord integration that shows your current game activity on your Discord status. This feature is only available on Windows.
- Launch alt accounts with lesser resources assigned to them avoiding losing performance on your main instance.
- Future-proofed to support third party servers. Third party server support will not be enabled while Grey Havens' Official servers are still online, unless explicitly permitted by their respective right owners and/or law.
- And more...
- Prerequisites:
- Java installed.
- Windows: You can get the Java installer from here.
- macOS: Java is already installed by default.
- Linux: Open your terminal and run any of these to install Java, depending on your package manager:
apt install default-jre,yum install java,pacman -S jre-openjdk,apk add openjdk8.
- Java installed.
- Download the latest Knight Launcher release ZIP file here.
- Extract the downloaded
KnightLauncher-x.x.x.zipZIP file to your Spiral Knights directory (x.x.xwill vary depending on the current version).- Windows:
- Steam: Steam installations can be found by right-clicking the game on your Steam library and selecting "Manage" → "Browse Local Files," you can also look for it at
<Your Steam Folder>\steamapps\common\Spiral Knights. - Standalone: Standalone installations can be found by right-clicking the Spiral Knights shortcut on your desktop and then clicking "Open File Location," you can also look for it at
<Your User Folder>\AppData\LocalLow\spiral.
- Steam: Steam installations can be found by right-clicking the game on your Steam library and selecting "Manage" → "Browse Local Files," you can also look for it at
- macOS:
- Steam: Steam installations can be found by right-clicking the game on your Steam library, selecting "Manage" → "Browse Local Files," then right click the "Spiral Knights" application file and select "Show Package Contents". Once this is done, browse to
Contents/Resources/Java. This is where you must extract the zip file you downloaded earlier. - Standalone: Standalone installations can be found by searching "Spiral Knights" in Applications, then right click on the result and select "Show in Finder", finally right click the "Spiral Knights" Application file and select "Show Package Contents", and browse to
Contents/Resources/Java. This is where you must extract the zip file you downloaded earlier.
- Steam: Steam installations can be found by right-clicking the game on your Steam library, selecting "Manage" → "Browse Local Files," then right click the "Spiral Knights" application file and select "Show Package Contents". Once this is done, browse to
- Linux:
- Steam: Steam installations are not natively supported, but the launcher will still call Steam and launch through Proton if you place Knight Launcher's JAR file in the game's directory.
- Standalone: Standalone installations are found at your user's home folder then
.getdown/spiral.
- Windows:
Note
Bear in mind that those are the usual installation locations, your mileage may vary.
- Double-click the
KnightLauncher.jarJAR file. The launcher should now boot up.- For macOS users: If a window pops up displaying "macOS cannot verify that this app is free from malware" click on "Done", then go to your System Settings → Privacy & Security, scroll to the very bottom of this panel, and where it says "KnightLauncher.jar was blocked to protect your Mac." click on "Open Anyway", then "Open Anyway" again on the pop up message that appears afterwards, and finally verify using Touch ID or your user's password. This should prevent the first pop up from appearing again.
- If nothing happens, double-click the
KnightLauncher_windows.batfile orKnightLauncher_mac_linux.shfile depending on your operating system.
Still not working? Open a thread in Discord's tech support channel so the community can help you.
The launcher is capable of auto-updating itself given the option is enabled in the launcher's settings, which will be by default. To manually update, follow these steps:
- Download the latest Knight Launcher release ZIP file here.
- Extract the downloaded ZIP file to your Spiral Knights folder, the same way you did when installing it for the first time. Guidance on finding your game folder can be found above at "Downloading & Installing."
After following those steps, the launcher will be up to date.
To build Knight Launcher manually, follow these steps:
- Prerequisites
- Java 8 JDK installed.
- Maven installed:
- Windows: Download the ZIP from the link above, extract, then add
bin/to yourPATH. - macOS (Homebrew):
brew install maven. - Linux (APT):
apt install maven.
- Windows: Download the ZIP from the link above, extract, then add
- Git installed:
- Windows: Download the installer from git-scm.com and follow the setup.
- macOS (Homebrew):
brew install git. - Linux (APT):
apt install git.
- Clone the repository.
git clone https://github.com/lucasluqui/KnightLauncher.git
- Copy
projectx-pcode.jarfrom your Spiral Knightscodedirectory into the project'slibdirectory. - Create a copy of
deploy.properties.templatein the repository's root directory then remove the.templateextension. Fill any missing values. - Validate all Maven dependencies.
mvn validate
- Build the package using Maven. By default, it will build for a development environment, you can target prod instead by adding
-Denv=prod.mvn clean packagemvn -Denv=prod clean package
- Copy the package built by Maven to your Spiral Knights folder and run it.
java -jar KnightLauncher.jar
We've built an amazing community on Discord focused on both helping newcomers get along with the launcher and giving a hand to modders, come join us!
Unless hyperlinked names shown below represent Discord usernames. Hyperlinked names correspond to GitHub accounts.
Translators are credited in their respective language file, click here to browse.
Thank you all for helping to make Knight Launcher usable for everyone worldwide!
- Nurr, yihleego, Bidoknight, Carpvindra, Mushspore, CafuneAndChill, Xan, analarmingalarm, parma, loonadra, ultrongr, milliath, Puzovoz, Stret, 3xample, top_platinum, Criptobeta.
The following open source libraries are used by Knight Launcher:
