Grasscutters/Grasscutter
3
0
Fork 0
mirror of https://github.com/Melledy/Grasscutter.git synced 2024-12-03 18:04:28 +00:00
Code Issues Projects Releases Wiki Activity
1,179 Commits 7 Branches 22 Tags 136 MiB
Java 96.4%
TypeScript 1.9%
Python 0.5%
SCSS 0.5%
Shell 0.4%
Other 0.3%
ef20177a6b
Go to file
ImmuState ef20177a6b
Energy: Particle/Orb Drops from Monsters (#1054) 
* Generate energy drops for monsters + make sure picking up particles honors their count.

* Use drop info from excels instead.

* Remove double newline.

* Remove commented code.
2022-05-24 21:43:04 -07:00
.github Cache gradle files 2022-05-17 04:23:49 -07:00
gradle/wrapper Update gradle + Work gacha reload (gs broken atm) 2022-04-20 16:05:53 +08:00
lib Fix disconnection when udp client port changed 2022-05-22 13:38:32 -07:00
proto Refactor support for codex(aka archive) animal, weapon, reliquary 2022-05-23 02:46:50 -07:00
src/main Energy: Particle/Orb Drops from Monsters (#1054) 2022-05-24 21:43:04 -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 Update CODE_OF_CONDUCT.md 2022-04-24 19:24:23 +06:00
CONTRIBUTING.md Fix another weird line break 2022-04-24 00:06:56 +02:00
gradlew Make gradlew executable 2022-04-22 22:53:54 -04:00
gradlew.bat Initial commit 2022-04-17 05:43:07 -07:00
install.sh Added support for arch linux 2022-05-23 15:46:12 -07:00
keystore.p12 Update the keystore 2022-04-22 22:34:00 -04:00
LICENSE Change LICENSE to GNU Affero 2022-05-08 13:09:22 -07:00
plugin-schema.json Add a plugin schema 2022-05-07 23:12:19 -07:00
proxy_config.py Allow overriding config with ENV (#506) 2022-05-05 15:22:29 +02:00
proxy.py Update proxy.py 2022-04-22 22:00:13 +08: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 Update README.md 2022-05-24 05:34:04 -07:00
settings.gradle Initial commit 2022-04-17 05:43:07 -07:00
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

Grasscutter

Documention GitHub release (latest by date) GitHub GitHub last commit GitHub Workflow Status
Discord - Grasscutter

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.

  1. Get grasscutter.jar
  2. 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.)
  3. 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.

  1. 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

  2. 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