f871f261e1
* chore(docker): add build workflow * chore(docker): update gradle image * chore(docker): this really shouldnt be running on raspberry pi's right now. * chore(docker): not sure why we need unzip here * chore(docker): attempt to add nodejs to allow the handbook to build * chore(docker): whoops, needs to be done during build * chore(docker): i dont know if this is going to work * chore(docker): replace my username with repo org as I am no longer testing this * chore(docker): version will change in the future, so fix it now. |
||
|---|---|---|
| .github | ||
| buildSrc/src/main/java/emu/grasscutter/gen | ||
| docs | ||
| gradle/wrapper | ||
| lib | ||
| scripts | ||
| src | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| build.gradle | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| entrypoint.sh | ||
| gradle.properties | ||
| gradlew | ||
| gradlew.bat | ||
| keystore.p12 | ||
| LICENSE | ||
| plugin-schema.json | ||
| README.md | ||
| settings.gradle | ||
| start_config.cmd | ||
| start.cmd | ||
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 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
.msiinstaller. -
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:
- Java Development Kit 17 or higher
- Git
- NodeJS (Optional, for building the handbook)
Clone
git clone --recurse-submodules https://github.com/Grasscutters/Grasscutter.git
cd Grasscutter
Compile
Note: Handbook generation may fail on some systems. To disable the handbook generation, append -PskipHandbook=1 to the gradlew jar command.
Windows:
.\gradlew.bat # Setting up environments
.\gradlew jar
Linux (GNU):
chmod +x gradlew
./gradlew jar
Compiling the Handbook (Manually)
With Gradle:
./gradlew generateHandbook
With NPM:
cd src/handbook
npm install
npm run build
You can find the output jar in the root of the project folder.
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.