Skip to content

A server software reimplementation for a certain anime game.

License

Notifications You must be signed in to change notification settings

KIttenPixel/Grasscutter

This branch is 4 commits ahead of, 4 commits behind Grasscutters/Grasscutter:development.

Folders and files

NameName
Last commit message
Last commit date
Mar 17, 2024
Jun 1, 2023
Mar 17, 2024
Nov 5, 2022
Jun 1, 2023
Sep 23, 2023
May 6, 2024
Jun 1, 2023
Jun 1, 2023
Mar 17, 2024
Jun 1, 2023
Apr 24, 2022
Sep 11, 2022
Mar 17, 2024
May 8, 2022
Mar 17, 2024
Dec 1, 2023
Mar 17, 2024
Jun 1, 2023
Nov 5, 2022
Jun 1, 2023
Apr 23, 2022
Jun 1, 2023
Apr 17, 2022
Oct 31, 2023
May 24, 2022

Repository files navigation

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

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.

About

A server software reimplementation for a certain anime game.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 95.3%
  • TypeScript 2.5%
  • Python 0.6%
  • SCSS 0.6%
  • Shell 0.5%
  • HTML 0.3%
  • Other 0.2%