mirror of https://github.com/Melledy/Grasscutter.git synced 2025-02-05 05:45:40 +00:00

Go to file

zhaodice 052e70e488 Fix inconformity of Player Object at TowerManager (#1226 ) * Fix inconformity of Player Object at TowerManager Fix inconformity of Player Object at TowerManager class from GameSession * fix with a reasonable resolution * Make sure towerManager'player is online player * Make sure towerManager'player is online player * Obsolete storage * Fix build * fix build * fix build * add @Entity * set record map * replace tab with space * add Entity to TowerData * make infomater more accurate * move player register to onLogin		2022-06-09 13:38:53 -07:00
.github	Merge branch 'development' into stable	2022-06-07 03:35:32 -07:00
gradle/wrapper
lib	Fix disconnection when udp client port changed	2022-05-22 13:38:32 -07:00
src/main	Fix inconformity of Player Object at TowerManager (#1226 )	2022-06-09 13:38:53 -07:00
.gitignore	Fix this does not look like a tar archive error when extract log file	2022-05-18 15:38:26 -07:00
build.gradle	Merge `development` into `plugin-auth`	2022-05-14 12:08:33 -04:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md
gradlew
gradlew.bat
install.sh	Added support for arch linux	2022-05-23 15:46:12 -07:00
keystore.p12
LICENSE	Change LICENSE to GNU Affero	2022-05-08 13:09:22 -07:00
plugin-schema.json
proxy_config.py
proxy.py	Proxy Update	2022-06-08 05:44:01 -07:00
README_zh-CN.md	fix join command and remove command bug and update docs (#904 )	2022-05-14 23:27:23 -07:00
README.md	Merge branch 'development' into stable	2022-06-07 03:35:32 -07:00
settings.gradle
start_config.cmd	fix java search in start.cmd	2022-05-24 05:34:04 -07:00
start.cmd	fix java search in start.cmd	2022-05-24 05:34:04 -07:00

README.md

EN | 中文

Attention: We always welcome contributors to the project. Before adding your contribution, please carefully read our Code of Conduct.

Current features

Logging in
Combat
Friends list
Teleportation
Gacha system
Co-op partially works
Spawning monsters via console
Inventory features (recieving items/characters, upgrading items/characters, etc)

Quick setup guide

Note: For support please join our Discord.

Requirements

Java SE - 17 (link)

Note: If you just want to run it, then jre only is fine.
MongoDB (recommended 4.0+)
Proxy daemon: mitmproxy (mitmdump, recommended), Fiddler Classic, etc.

Running

Note: If you updated from an older version, delete config.json to regenerate it.

Get grasscutter.jar
- Download from actions
- Build by yourself
Create a resources folder in the directory where grasscutter.jar is located and move your BinOutput and ExcelBinOutput folders there (Check the wiki for more details how to get those.)
Run Grasscutter with java -jar grasscutter.jar. Make sure mongodb service is running as well.

Connecting with the client

½. Create an account using server console command.

Redirect traffic: (choose one)
- mitmdump: mitmdump -s proxy.py -k
  
  Trust CA certificate:
  
  **Note:**The CA certificate is usually stored in % USERPROFILE%\ .mitmproxy, or you can download it from http://mitm.it
  
  Double click for install or ...
  - Via command line
```
certutil -addstore root %USERPROFILE%\.mitmproxy\mitmproxy-ca-cert.cer
```
- 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, and load this script.
- Hosts file
Set network proxy to 127.0.0.1:8080 or the proxy port you specified.

you can also use start.cmd to start servers and proxy daemons automatically, but you have to set up JAVA_HOME enviroment

Building

Grasscutter uses Gradle to handle dependencies & building.

Requirements:

Java SE Development Kits - 17
Git

Windows

git clone https://github.com/Grasscutters/Grasscutter.git
cd Grasscutter
.\gradlew.bat # Setting up environments
.\gradlew jar # Compile

Linux

git clone https://github.com/Grasscutters/Grasscutter.git
cd Grasscutter
chmod +x gradlew
./gradlew jar # Compile

You can find the output jar in the root of the project folder.

Commands have moved to the wiki!

Quick Troubleshooting

If compiling wasn't successful, please check your JDK installation (JDK 17 and validated JDK's bin PATH variable)
My client doesn't connect, doesn't login, 4206, etc... - Mostly your proxy daemon setup is the issue, if using Fiddler make sure it running on another port except 8888
Startup sequence: MongoDB > Grasscutter > Proxy daemon (mitmdump, fiddler, etc.) > Game

README.md Unescape Escape