-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
1,965 additions
and
1,619 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,34 @@ | ||
# 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. | ||
|
||
![Screenshot](https://cdn.discordapp.com/attachments/1086346121472905366/1095320783976407120/image.png) | ||
|
||
## Installation | ||
1. Download the latest installer from the [releases](https://github.com/Ipmake/kocitylauncher/releases/) page | ||
2. Run the installer | ||
3. If the windows defender message pops up, click "More info" and then "Run anyway" | ||
|
||
## 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 | ||
- [x] Allow hosting of private servers through the launcher | ||
- [ ] Discord RPC | ||
- [ ] Add support for discord game invites | ||
- [ ] Add a public server browser | ||
- [ ] Allow for users to enter secrets for private servers | ||
- [ ] Add an authentication system | ||
- [ ] Some kind of account system with cloud sync (maybe) | ||
|
||
## Building from Source | ||
0. Make sure you have nodejs installed (recommend the latest LTS version) | ||
1. Clone the Project and cd into the directory | ||
2. Run `npm install` to install all dependencies | ||
3. Run `npm run electron:build`, this will build the react and electron project and output an installer exe into the `dist` directory | ||
# 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. | ||
|
||
![Screenshot](https://cdn.discordapp.com/attachments/1086346121472905366/1095320783976407120/image.png) | ||
|
||
## Installation | ||
1. Download the latest installer from the [releases](https://github.com/Ipmake/kocitylauncher/releases/) page | ||
2. Run the installer | ||
3. If the windows defender message pops up, click "More info" and then "Run anyway" | ||
|
||
## 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 | ||
- [x] Allow hosting of private servers through the launcher | ||
- [x] Discord RPC | ||
- [ ] Allow for users to enter secrets for private servers | ||
- [ ] Add an authentication system | ||
- [ ] Add a public server browser | ||
- [ ] Add support for discord game invites (Alongside the public server browser) | ||
- [ ] Some kind of account system with cloud sync (maybe) | ||
|
||
## Building from Source | ||
0. Make sure you have nodejs installed (recommend the latest LTS version) | ||
1. Clone the Project and cd into the directory | ||
2. Run `npm install` to install all dependencies | ||
3. Run `npm run electron:build`, this will build the react and electron project and output an installer exe into the `dist` directory |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.