Skip to content

Commit

Permalink
Version 0.3.0 stuff + Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
Ipmake committed Apr 27, 2023
1 parent 80903de commit 52c5ecc
Show file tree
Hide file tree
Showing 12 changed files with 1,965 additions and 1,619 deletions.
1,348 changes: 674 additions & 674 deletions LICENSE

Large diffs are not rendered by default.

68 changes: 34 additions & 34 deletions README.md
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
87 changes: 85 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "knockoutcitylauncher",
"description": "Unofficial Knockout City Launcher",
"version": "0.2.1",
"version": "0.3.0",
"private": true,
"homepage": "./",
"main": "public/electron.js",
Expand All @@ -17,6 +17,7 @@
"@testing-library/react": "^13.4.0",
"@testing-library/user-event": "^13.5.0",
"axios": "^1.3.5",
"discord-rpc": "^4.0.1",
"moment": "^2.29.4",
"node-pty": "^0.10.1",
"react": "^18.2.0",
Expand Down Expand Up @@ -61,6 +62,9 @@
],
"win": {
"icon": "/public/icon.png"
},
"nsis": {
"installerLanguages": "en_US"
}
}
}
Loading

0 comments on commit 52c5ecc

Please sign in to comment.