EZPPLauncher/README.md

36 lines
1.2 KiB
Markdown

# EZPPLauncher
Welcome to the EZPPLauncher! A new way to connect to the EZPPFarm server.
Just one click and you are ready to go!
## Preview Image
![preview](https://git.ez-pp.farm/EZPPFarm/EZPPLauncher/raw/branch/master/preview/EZPPLauncher.png)
## Installation
The Launcher is a "plug and play thing", download it, place it on the desktop and execute!
## Features
* Automatic osu! client updating before Launch
* Account saving
## Used Libraries
* [Electron](https://www.npmjs.com/package/electron)
* [custom-electron-titlebar](https://www.npmjs.com/package/custom-electron-titlebar)
* [axios](https://www.npmjs.com/package/axios)
* [jquery](https://www.npmjs.com/package/jquery)
* [discord-auto-rpc](https://www.npmjs.com/package/discord-auto-rpc)
* [get-window-by-name](https://www.npmjs.com/package/get-window-by-name)
* [sweetalert2](https://www.npmjs.com/package/sweetalert2)
* [node-downloader-helper](https://www.npmjs.com/package/node-downloader-helper)
## Build from source
- clone repo
- cd into the repo
- use `yarn install` to install all dependencies
- use the buildscript `pack-win` to build a executeable
## License
[AGPL-3.0](https://choosealicense.com/licenses/agpl-3.0/)