Grasscutter/README.md
KingRainbow44 261319f348
misc(README.md): Add credits block
i want to credit ppl. but:
1. i don't want to get people in trouble
2. don't know who wants credit/not
2024-09-28 18:02:13 -04:00

4.2 KiB

Grasscutter

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

EN | 简中 | 繁中 | FR | ES | HE | RU | PL | ID | KR | FIL/PH | NL | JP | IT | VI

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 (receiving items/characters, upgrading items/characters, etc)

Quick setup guide

Note: For support please join our Discord.

Quick Start (automatic)

  • Get Java 17

  • Get MongoDB Community Server

  • Get game version REL4.0.x (If you don't have a 4.0.x client, you can find it here and open any of the links to download it): 4.0.x Client-github 4.0.x Client-cloud drive

  • Download the latest Cultivation version. Use the .msi installer.

  • After opening Cultivation (as admin), press the download button in the upper right corner.

  • Click Download All-in-One

  • Click the gear in the upper right corner

  • Set the game Install path to where your game is located.

  • Set the Custom Java Path to C:\Program Files\Java\jdk-17\bin\java.exe

  • Leave all other settings on default

  • Click the small button next to launch.

  • Click the launch button.

  • Log in with whatever username you want. Password can be anything.

Building

Grasscutter uses Gradle to handle dependencies & building.

Requirements:

Clone
git clone --recurse-submodules https://github.com/Grasscutters/Grasscutter.git
cd Grasscutter
Compile

Windows:

.\gradlew.bat # Setting up environments
.\gradlew jar

Linux (GNU):

chmod +x gradlew
./gradlew jar

Troubleshooting

For a list of common issues and solutions and to ask for help, please join our Discord server and go to the support channel.

Credits

Note

Protocol definitions are dumped from many parties, but they are not stated here. Thanks for contributing!

  • KCP Library - grasskcper updated with the byte_check_code