Grasscutters/GrassClipper
3
0
Fork 0
mirror of https://github.com/Grasscutters/GrassClipper.git synced 2024-11-16 04:45:34 +00:00
Code Issues Projects Releases Wiki Activity

readme base

Browse Source
This commit is contained in:
SpikeHD 2022-04-19 16:19:27 -07:00
parent c2cfc8afa2
commit a0e09a4d04
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,2 +1,25 @@
# GrassClipper
Grasscutter launcher for easily switching between Official and Private servers
[Download Here!](https://github.com/Grasscutters/GrassClipper/releases/)
# Setup
0. Clone the repository
1. Ensure you have [NodeJS](https://nodejs.org/en/download/) installed.
2. Install the `neu` CLI tool: `npm install -g @neutralinojs/neu`
3. Install the dependancies: `npm install`
4. Compile and run:
* For testing: `npm run dev`
* For production: `npm run build`
# TODO
* Interface
* UI
* Official and Private options
* Server IP input
* Fun fancy CSS styling n stuff (CoD: MW 2019-style vertical menu for choosing between official and private servers? [See this](https://charlieintel.com/wp-content/uploads/2020/11/MW-new-menu.png))
* Proxy service
* Local proxy server
* Intercept and modify GI requests like with Fiddler, allow anything else to pass through