/kocitylauncher

A fancy launcher for the private server version of Knockout City

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

Unofficial Knockout City Launcher

aka: the "Ip Man Launcher" ;)

This is a launcher for the self hosted version of Knockout City, developed by Velan Studios. This launcher is developed by the community and is not affiliated with Velan Studios.

Find the documentation at: https://kocity.xyz/ Join the dev discord here: https://discord.gg/4kNPb4cRxN

Screenshot

Installation

  1. Download the latest installer from the releases page
  2. Run the installer
  3. If the windows defender message pops up, click "More info" and then "Run anyway"

Import an existing Private server installation

  1. Create a directory somewhere that will house everything
  2. Depending on the private server edition version you have downloaded, create a directory in the directory you just created called either highRes or lowRes
  3. Move the private server editions files into the highRes or lowRes folder
  4. Restart your launcher and click "Yes" when it asks you to create a version.txt

This should be the folder strucutre:

Knockout City/
├─ highRes/
│  ├─ KnockoutCity/
│  ├─ KnockoutCityServer/
│  ├─ eula.txt
│  ├─ readme.txt

Features

  • Improve usability by providing basic settings instead of command line arguments
  • A basic news feed and a server browser and favorites list
  • A clean and modern UI
  • Install and update the game through the launcher
  • Automatically update the launcher when a new version is released

To-Do

  • Allow hosting of private servers through the launcher
  • Discord RPC
  • Add an authentication system
  • Add a public server browser
  • Allow for users to enter secrets for private servers
  • Add support for discord game invites (Alongside the public server browser)
  • Some kind of account system with cloud sync (maybe)

Building from Source

  1. Make sure you have nodejs installed (recommend the latest LTS version)
  2. Clone the Project and cd into the directory
  3. Run npm install to install all dependencies
  4. Run npm run electron:build, this will build the react and electron project and output an installer exe into the dist directory