Skip to content

A launcher for quickly & easily switching server destinations.

License

Notifications You must be signed in to change notification settings

KiminaNatsuki/GrassClipper

 
 

Repository files navigation

GrassClipper

Grasscutter launcher for easily switching between Official and Private servers

Download Here!

*Note: some translations are outdated, so if random English text appears or an option seems misleading, this is why. If you notice an issue like this, feel free to make a pull request!

Table of Contents

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 game folder!

Setup (for Development)

  1. Clone the repository
  2. Ensure you have NodeJS installed.
  3. Install the neu CLI tool: npm install -g @neutralinojs/neu
  4. Install the dependencies: setup_win.cmd
  5. Compile and run:
    • For testing: npm run dev
    • For production: npm run build

TODO

  • Interface/internals
    • 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)
    • Kill switch script (optional)
    • Automatically run install.cmd when opening for the first time
    • Grasscutter auto-downloader
    • Detect when in a folder that is inaccessible to the program (eg. C:/Program Files) and warn
    • 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)
    • Platform detection and bash scripts
    • Integrated banner creator
  • Proxy service
    • Local proxy server
    • Intercept and modify GI requests like with Fiddler, allow anything else to pass through
    • Fix Discord and YouTube issues when proxy is enabled (maybe fixed)

Having problems?

Below are some scenarios you may encounter and their solutions.

White Screen Fix

Encountering a white screen? Ensure WebView2 is installed

You may also want to run this command as administrator: CheckNetIsolation.exe LoopbackExempt -a -n="Microsoft.Win32WebViewHost_cw5n1h2txyewy"

If all else fails, you can run GrassClipper in chrome or browser mode. To do so:

  • Create a shortcut to GrassClipper.exe
  • Right click the shortcut, click properties
  • In the Target box, at the very end, add --mode=chrome or --mode=browser
    • chrome only works if you have Chrome installed, and will create a Chrome window
    • brower will, you guessed it, open GrassClipper in your default browser
  • Click Ok
  • Run GrassClipper using this shortcut from now on!

Error 502

If you are getting an error 502 when attempting to log in, open your Grasscutter config and add the following to the DispatchServer section:

"PublicPort": YOUR_PORT

where YOUR_PORT is the same port you use as the Port value already. This will probably be 443.

Infinite CMD Windows

If you are getting infinite CMD windows for any of the scripts (such as the proxy installation, or private server start), ensure you have UAC (user access control) set to any option that requires asking. Ensure your user account can open things as Admin.

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, Scirese & MrAru
  • ZH-TW - Kimi & KormiMeiko
  • PT-BR - na.na
  • VIE - labalityowo
  • ID - Iqrar99
  • FR - linsorak & memetrollsXD
  • ES - memetrollsXD
  • ND - memetrollsXD
  • RU - fitiskin
  • TR - lilmayofuksu

Screenshots

image image image image image image image

About

A launcher for quickly & easily switching server destinations.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 50.3%
  • HTML 16.0%
  • CSS 14.4%
  • Batchfile 14.1%
  • Python 4.3%
  • Shell 0.9%