mirror of
https://github.com/Grasscutters/GrassClipper.git
synced 2024-11-16 04:45:34 +00:00
86 lines
3.7 KiB
Markdown
86 lines
3.7 KiB
Markdown
# GrassClipper
|
|
Grasscutter launcher for easily switching between Official and Private servers
|
|
|
|
[Download Here!](https://github.com/Grasscutters/GrassClipper/releases/)
|
|
|
|
# Table of Contents
|
|
|
|
* [Setup (for users)](#setup-for-users)
|
|
* [Setup (for development)](#setup-for-development)
|
|
* [TODO](#todo)
|
|
* [Common Problems](#having-problems)
|
|
* [White Screen Fix](#white-screen-fix)
|
|
* [Broken Discord/Youtube](#my-discord-is-not-letting-me-send-messages-or-load-images-my-youtube-is-acting-strange)
|
|
* [No internet](#i-have-no-internet-after-closing-everything-restarting-my-pc)
|
|
* [Languages and Translation Credits](#available-languages-and-translation-credits)
|
|
* [Screenshots](#screenshots)
|
|
|
|
# Setup (for Users)
|
|
|
|
1. Download the zip file
|
|
2. Extract the zip file somewhere
|
|
3. Run `GrassClipper.exe`, install the proxy server, and set your `Genshin Impact Game` folder!
|
|
|
|
# Setup (for Development)
|
|
|
|
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 dependencies: `npm install` AND `neu update`
|
|
4. Compile and run:
|
|
* For testing: `npm run dev`
|
|
* For production: `npm run build`
|
|
|
|
# TODO
|
|
|
|
* Interface
|
|
* [x] UI
|
|
* [x] Official and Private options
|
|
* [x] Server IP input
|
|
* [x] 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))
|
|
* [ ] Custom images for private server sections (anyone is welcome to submit a pull request to add some!)
|
|
* [ ] Optional username/password creation for servers before entering (not implemented in GrassCutter yet)
|
|
* [x] Kill switch script (optional)
|
|
* [x] Automatically run `install.cmd` when opening for the first time
|
|
* [ ] Fix Windows scaling issues?
|
|
* Proxy service
|
|
* [x] Local proxy server
|
|
* [x] Intercept and modify GI requests like with Fiddler, allow anything else to pass through
|
|
* [ ] Fix Discord and YouTube issues when proxy is enabled (not sure what's up with them?)
|
|
|
|
# Having problems?
|
|
|
|
Below are some scenarios you may encounter and their solutions.
|
|
|
|
### White Screen Fix
|
|
|
|
Encountering a white screen? [Ensure WebView2 is installed](https://developer.microsoft.com/zh-cn/microsoft-edge/webview2/#download)
|
|
|
|
### My Discord is not letting me send messages or load images/My Youtube is acting strange!
|
|
|
|
Discord/YouTube (plus surely some others) does not seem to be a fan of the proxy server. You may need to disable it by either closing mitmdump or by disabling your proxy in the Windows proxy settings.
|
|
|
|
### I have no internet after closing everything/restarting my PC!
|
|
|
|
The launcher most likely did not close correctly, and was unable to clean your proxy settings back to what they were. Disable your proxy in the Windows proxy settings.
|
|
|
|
# Available Languages and Translation Credits
|
|
|
|
Thank you to everyone who has provided translations! <3
|
|
|
|
* ZH - nuoxianCN
|
|
* PT-BR - na.na
|
|
* Vietnamese - labalityowo
|
|
|
|
# Screenshots
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|