Grasscutter
/
Grasscutter
mirror of https://github.com/Grasscutters/Grasscutter.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
A server software reimplementation for a certain anime game.
2,311 Commits 6 Branches 22 Tags 144 MiB
Java 96.4%
TypeScript 1.9%
Python 0.5%
SCSS 0.5%
Shell 0.4%
Other 0.3%
Go to file
Magix f1f5b54939
(fix:docker) Fix uploading to container registry 		2024-03-16 23:09:40 -07:00
.github (fix:docker) Fix uploading to container registry 2024-03-16 23:09:40 -07:00
buildSrc/src/main/java/emu/grasscutter/gen Merge `unstable` into `development` (#2173) 2023-05-31 23:48:16 -04:00
docs add some client download link and fix readme (#2475) 2024-03-17 01:14:10 -04:00
gradle/wrapper Update gradle wrapper (closes #1076) 2022-11-05 15:03:00 +10:30
lib Merge `unstable` into `development` (#2173) 2023-05-31 23:48:16 -04:00
scripts use pretty_host in domain filtering (#2382) 2023-09-22 23:33:01 -04:00
src Add documentation on 404 error page. (#2463) 2024-01-18 23:30:03 -05:00
.editorconfig Merge `unstable` into `development` (#2173) 2023-05-31 23:48:16 -04:00
.gitattributes Merge `unstable` into `development` (#2173) 2023-05-31 23:48:16 -04:00
.gitignore Add Docker Support (#2486) 2024-03-17 01:57:39 -04:00
.gitmodules Merge `unstable` into `development` (#2173) 2023-05-31 23:48:16 -04:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2022-04-24 19:24:23 +06:00
CONTRIBUTING.md Update banners (closes #1760) 2022-09-11 21:05:16 +09:30
Dockerfile Add Docker Support (#2486) 2024-03-17 01:57:39 -04:00
LICENSE Change LICENSE to GNU Affero 2022-05-08 13:09:22 -07:00
README.md add some client download link and fix readme (#2475) 2024-03-17 01:14:10 -04:00
build.gradle Bump to version `1.7.4` 2023-11-30 23:41:55 -05:00
entrypoint.sh Add Docker Support (#2486) 2024-03-17 01:57:39 -04:00
gradle.properties Merge `unstable` into `development` (#2173) 2023-05-31 23:48:16 -04:00
gradlew Update gradle wrapper (closes #1076) 2022-11-05 15:03:00 +10:30
gradlew.bat Merge `unstable` into `development` (#2173) 2023-05-31 23:48:16 -04:00
keystore.p12 Update the keystore 2022-04-22 22:34:00 -04:00
plugin-schema.json Merge `unstable` into `development` (#2173) 2023-05-31 23:48:16 -04:00
settings.gradle Initial commit 2022-04-17 05:43:07 -07:00
start.cmd Fix typo in start.cmd (#2415) 2023-10-31 19:50:31 -04:00
start_config.cmd fix java search in start.cmd 2022-05-24 05:34:04 -07:00

README.md

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.