mirror of
https://github.com/Grasscutters/Grasscutter.git
synced 2024-11-23 12:29:52 +00:00
Add click to run cmd
Signed-off-by: Jaida Wu <mlgmxyysd@meowcat.org>
This commit is contained in:
Jaida Wu
parent
0e95bbd165
commit
b2da4a134e
130
README.md
130
README.md
@ -1,62 +1,68 @@
|
||||
# Grasscutter
|
||||
A WIP server emulator for Genshin Impact 2.3-2.6
|
||||
|
||||
**Note**: For support please join the [Discord server](https://discord.gg/T5vZU6UyeG).
|
||||
|
||||
# Current features
|
||||
* Logging in
|
||||
* Spawning monsters via console
|
||||
* Combat
|
||||
* Inventory features (recieving items/characters, upgrading items/characters, etc)
|
||||
* Co-op does work, but movement is kind of buggy and some player ults do not spawn properly
|
||||
* Friends list
|
||||
* Gacha system
|
||||
|
||||
# Running the server and client
|
||||
|
||||
### Prerequisites
|
||||
* JDK-8u202 ([mirror link since Oracle required an account to download old builds](https://mirrors.huaweicloud.com/java/jdk/8u202-b08/))
|
||||
* Mongodb (recommended 4.0+)
|
||||
* Fiddler Classic
|
||||
|
||||
### Starting up the server (Assuming you are on Windows)
|
||||
1. Setup compile environment `gradlew.bat`
|
||||
2. Compile the server with `gradlew jar`
|
||||
3. Create a folder named `resources` in your server directory, you will need to copy `BinOutput` and `ExcelBinOutput` folders which you can get from a repo like [https://github.com/Dimbreath/GenshinData](https://github.com/Dimbreath/GenshinData) into your resources folder.
|
||||
4. Run the server with `java -jar grasscutter.jar`. Make sure mongodb is running as well.
|
||||
|
||||
### Connecting with the client
|
||||
½. Create an account using command below
|
||||
1. Run Fiddler and turn on `Decrypt https traffic` in setting
|
||||
2. Set your hosts file to redirect at least api-account-os.hoyoverse.com and dispatchosglobal.yuanshen.com to your dispatch server ip. Or use Fiddler with script from [https://github.lunatic.moe/fiddlerscript](https://github.lunatic.moe/fiddlerscript) (Recommended for beginners)
|
||||
3. If you're using Fiddler, change the default port there (Tools -> Options -> Connections) to anything other than 8888, otherwise the server won't boot.
|
||||
4. yoink
|
||||
|
||||
### Server console commands
|
||||
|
||||
`account create [username] {playerid}` - Creates an account with the specified username and the in-game uid for that account. The playerid parameter is optional and will be auto generated if not set.
|
||||
|
||||
### In-Game commands
|
||||
There is a dummy user named "Server" in every player's friends list that you can message to use commands. Commands also work in other chat rooms, such as private/team chats.
|
||||
|
||||
`!spawn [monster id] [level] [amount]`
|
||||
|
||||
`!give [item id] [amount]`
|
||||
|
||||
`!drop [item id] [amount]`
|
||||
|
||||
`!killall`
|
||||
|
||||
`!godmode` - Prevents you from taking damage
|
||||
|
||||
`!resetconst` - Resets the constellation level on your current active character, will need to relog after using the command to see any changes.
|
||||
|
||||
`!sethp [hp]`
|
||||
|
||||
`!clearartifacts` - Deletes all unequipped and unlocked level 0 artifacts, **including yellow rarity ones** from your inventory
|
||||
|
||||
### Quick Troubleshooting
|
||||
* If compiling wasnt successful, please check your JDK installation (must be JDK 8 and JDK's bin PATH variable is correct)
|
||||
* My client doesn't connect, doesn't login, 4206, etc... - Mostly your fiddler is the issue, make sure it running on another port except 8888
|
||||
* Startup sequence: Mongodb > The server > Fiddler > Client
|
||||
* If `4206` error constantly prompt up, try to use [jdk-8u202-b08](https://mirrors.huaweicloud.com/java/jdk/8u202-b08/) instead of other versions of JDK
|
||||
# Grasscutter
|
||||
A WIP server emulator for Genshin Impact 2.3-2.6
|
||||
|
||||
**Note**: For support please join the [Discord server](https://discord.gg/T5vZU6UyeG).
|
||||
|
||||
# Current features
|
||||
* Logging in
|
||||
* Spawning monsters via console
|
||||
* Combat
|
||||
* Inventory features (recieving items/characters, upgrading items/characters, etc)
|
||||
* Co-op does work, but movement is kind of buggy and some player ults do not spawn properly
|
||||
* Friends list
|
||||
* Gacha system
|
||||
|
||||
# Running the server and client
|
||||
|
||||
### Prerequisites
|
||||
* JDK-8u202 ([mirror link since Oracle required an account to download old builds](https://mirrors.huaweicloud.com/java/jdk/8u202-b08/))
|
||||
* Mongodb (recommended 4.0+)
|
||||
* Proxy daemon: mitmproxy (mitmdump, recommended), Fiddler Classic, etc.
|
||||
|
||||
### Starting up the server (Assuming you are on Windows)
|
||||
1. Setup compile environment `gradlew.bat`
|
||||
2. Compile the server with `gradlew jar`
|
||||
3. Create a folder named `resources` in your server directory, you will need to copy `BinOutput`, `ExcelBinOutput` folders and `TextMap*.json` which you can get from a repo like [https://github.com/Dimbreath/GenshinData](https://github.com/Dimbreath/GenshinData) into your resources folder.
|
||||
4. Run the server with `java -jar grasscutter.jar`. Make sure mongodb is running as well.
|
||||
|
||||
### Connecting with the client
|
||||
½. Create an account using command below
|
||||
1. Run a proxy daemon:
|
||||
- mitmdump: `mitmdump -s proxy.py --ssl-insecure`
|
||||
- Fiddler Classic: Run Fiddler Classic, turn on `Decrypt https traffic` in setting and change the default port there (Tools -> Options -> Connections) to anything other than `8888`, load [this script](https://github.lunatic.moe/fiddlerscript).
|
||||
- hosts: Redirect at least `api-account-os.hoyoverse.com` and `dispatchosglobal.yuanshen.com` to your dispatch server ip.
|
||||
2. Trust CA certificate:
|
||||
- mitmdump: `certutil -addstore root %USERPROFILE%\.mitmproxy\mitmproxy-ca-cert.cer`
|
||||
2. Set network proxy to `127.0.0.1:8080` or the proxy port you specified.
|
||||
4. yoink
|
||||
|
||||
* or you can use `run.cmd` to start Server & Proxy daemon with one click
|
||||
|
||||
### Server console commands
|
||||
|
||||
`account create [username] {playerid}` - Creates an account with the specified username and the in-game uid for that account. The playerid parameter is optional and will be auto generated if not set.
|
||||
|
||||
### In-Game commands
|
||||
There is a dummy user named "Server" in every player's friends list that you can message to use commands. Commands also work in other chat rooms, such as private/team chats.
|
||||
|
||||
`!spawn [monster id] [level] [amount]`
|
||||
|
||||
`!give [item id] [amount]`
|
||||
|
||||
`!drop [item id] [amount]`
|
||||
|
||||
`!killall`
|
||||
|
||||
`!godmode` - Prevents you from taking damage
|
||||
|
||||
`!resetconst` - Resets the constellation level on your current active character, will need to relog after using the command to see any changes.
|
||||
|
||||
`!sethp [hp]`
|
||||
|
||||
`!clearartifacts` - Deletes all unequipped and unlocked level 0 artifacts, **including yellow rarity ones** from your inventory
|
||||
|
||||
### Quick Troubleshooting
|
||||
* If compiling wasnt successful, please check your JDK installation (must be JDK 8 and JDK's bin PATH variable is correct)
|
||||
* My client doesn't connect, doesn't login, 4206, etc... - Mostly your fiddler is the issue, make sure it running on another port except 8888
|
||||
* Startup sequence: Mongodb > The server > Proxy daemon (mitmdump, fiddler, etc.) > Client
|
||||
* If `4206` error constantly prompt up, try to use [jdk-8u202-b08](https://mirrors.huaweicloud.com/java/jdk/8u202-b08/) instead of other versions of JDK
|
||||
|
||||
7
run.bat
7
run.bat
@ -1,7 +0,0 @@
|
||||
@echo off
|
||||
|
||||
|
||||
|
||||
::This will not work if your java is in a different location, plugin as necessary
|
||||
::this just saves you from changing your PATH
|
||||
"C:\Program Files\Java\jdk1.8.0_202\bin\java.exe" -jar ./grasscutter.jar
|
||||
115
run.cmd
Normal file
115
run.cmd
Normal file
@ -0,0 +1,115 @@
|
||||
@rem
|
||||
@rem Copyright (C) 2002-2022 MlgmXyysd All Rights Reserved.
|
||||
@rem
|
||||
|
||||
@if "%DEBUG%" == "" echo off
|
||||
pushd %~dp0
|
||||
title Grasscutter
|
||||
call :LOG [INFO] Grasscutter
|
||||
call :LOG [INFO] Initializing...
|
||||
|
||||
@rem This will not work if your java or mitmproxy is in a different location, plugin as necessary
|
||||
@rem this just saves you from changing your PATH
|
||||
set JAVA_PATH=C:\Program Files\Java\jdk1.8.0_202\
|
||||
set MITMPROXY_PATH=%~dp0
|
||||
set PROXY_SCRIPT=proxy
|
||||
@rem TODO: MongoDB integration
|
||||
set SERVER_PATH=%~dp0
|
||||
|
||||
@rem mitmproxy not found, server only
|
||||
if not exist "%MITMPROXY_PATH%mitmdump.exe" (
|
||||
call :LOG [WARN] mitmproxy not found, server only mode.
|
||||
goto :SERVER
|
||||
)
|
||||
@rem proxy script not found, server only
|
||||
if not exist "%PROXY_SCRIPT%.py" (
|
||||
if not exist "%PROXY_SCRIPT%.pyc" (
|
||||
call :LOG [WARN] Missing proxy script or compiled proxy script, server only mode.
|
||||
goto :SERVER
|
||||
) else set PROXY_SCRIPT=%PROXY_SCRIPT%.pyc
|
||||
) else set PROXY_SCRIPT=%PROXY_SCRIPT%.py
|
||||
|
||||
:PROXY
|
||||
@rem UAC Administrator privileges
|
||||
>nul 2>&1 reg query "HKU\S-1-5-19" || (
|
||||
call :LOG [WARN] Currently running with non Administrator privileges, raising...
|
||||
echo set UAC = CreateObject^("Shell.Application"^) > "%temp%\UAC.vbs"
|
||||
echo UAC.ShellExecute "%~f0", "%1", "", "runas", 1 >> "%temp%\UAC.vbs"
|
||||
"%temp%\UAC.vbs"
|
||||
del /f /q "%temp%\UAC.vbs" >nul 2>nul
|
||||
exit /b
|
||||
)
|
||||
|
||||
set PROXY=true
|
||||
@rem Store original proxy settings
|
||||
for /f "tokens=2*" %%a in ('reg query "HKCU\Software\Microsoft\Windows\CurrentVersion\Internet Settings" /v ProxyEnable 2^>nul') do set "ORIG_PROXY_ENABLE=%%b"
|
||||
for /f "tokens=2*" %%a in ('reg query "HKCU\Software\Microsoft\Windows\CurrentVersion\Internet Settings" /v ProxyServer 2^>nul') do set "ORIG_PROXY_SERVER=%%b"
|
||||
|
||||
call :LOG [INFO] Starting proxy daemon...
|
||||
@rem TODO: External proxy when ORIG_PROXY_ENABLE == 0x1
|
||||
start /min "" "%MITMPROXY_PATH%mitmdump.exe" -s %PROXY_SCRIPT% --ssl-insecure
|
||||
|
||||
@rem CA certificate for possible HTTPS scheme
|
||||
call :LOG [INFO] Waiting for CA certificate generation...
|
||||
set CA_CERT_FILE="%USERPROFILE%\.mitmproxy\mitmproxy-ca-cert.cer"
|
||||
|
||||
set /A TIMEOUT_COUNT=0
|
||||
|
||||
:CERT_CA_CHECK
|
||||
if not exist %CA_CERT_FILE% (
|
||||
timeout /T 1 >nul 2>nul
|
||||
set /A TIMEOUT_COUNT+=1
|
||||
goto CERT_CA_CHECK
|
||||
)
|
||||
:EXTRA_TIMEOUT
|
||||
if %TIMEOUT_COUNT% LEQ 2 (
|
||||
timeout /T 1 >nul 2>nul
|
||||
set /A TIMEOUT_COUNT+=1
|
||||
goto EXTRA_TIMEOUT
|
||||
)
|
||||
call :LOG [INFO] Adding CA certificate to store...
|
||||
certutil -addstore root %CA_CERT_FILE% >nul 2>nul
|
||||
|
||||
call :LOG [INFO] Setting up network proxy...
|
||||
reg add "HKCU\Software\Microsoft\Windows\CurrentVersion\Internet Settings" /v ProxyEnable /t REG_DWORD /d 1 /f >nul 2>nul
|
||||
reg add "HKCU\Software\Microsoft\Windows\CurrentVersion\Internet Settings" /v ProxyServer /d "127.0.0.1:8080" /f >nul 2>nul
|
||||
|
||||
:SERVER
|
||||
if not exist "%JAVA_PATH%bin\java.exe" (
|
||||
call :LOG [ERROR] Java not found.
|
||||
goto :EXIT
|
||||
)
|
||||
if not exist "%SERVER_PATH%grasscutter.jar" (
|
||||
call :LOG [ERROR] Server jar not found.
|
||||
goto :EXIT
|
||||
)
|
||||
call :LOG [INFO] Starting server...
|
||||
"%JAVA_PATH%bin\java.exe" -jar "%SERVER_PATH%grasscutter.jar"
|
||||
call :LOG [INFO] Server stopped
|
||||
|
||||
:EXIT
|
||||
if "%PROXY%" == "" (
|
||||
call :LOG [INFO] Proxy not started, no need to clean up.
|
||||
) else (
|
||||
call :LOG [INFO] Restoring network settings...
|
||||
|
||||
reg add "HKCU\Software\Microsoft\Windows\CurrentVersion\Internet Settings" /v ProxyEnable /t REG_DWORD /d "%ORIG_PROXY_ENABLE%" /f >nul 2>nul
|
||||
reg add "HKCU\Software\Microsoft\Windows\CurrentVersion\Internet Settings" /v ProxyServer /d "%ORIG_PROXY_SERVER%" /f >nul 2>nul
|
||||
|
||||
call :LOG [INFO] Shutting down proxy daemon...
|
||||
taskkill /t /f /im mitmdump.exe >nul 2>nul
|
||||
|
||||
call :LOG [INFO] Removing CA certificate...
|
||||
|
||||
for /F "tokens=2" %%s in ('certutil -dump %CA_CERT_FILE% ^| findstr ^"^sha1^"') do (
|
||||
set SERIAL=%%s
|
||||
)
|
||||
|
||||
certutil -delstore root %SERIAL% >nul 2>nul
|
||||
)
|
||||
|
||||
call :LOG [INFO] See you again :)
|
||||
goto :EOF
|
||||
|
||||
:LOG
|
||||
echo [%time:~0,8%] %*
|
||||
Loading…
Reference in New Issue
Block a user