Grasscutters/Grasscutter
3
0
Fork 0
mirror of https://github.com/Melledy/Grasscutter.git synced 2024-11-27 21:10:54 +00:00
Code Issues Projects Releases Wiki Activity
2,339 Commits 7 Branches 22 Tags 133 MiB
Java 96.4%
TypeScript 1.9%
Python 0.5%
SCSS 0.5%
Shell 0.4%
Other 0.3%
c663b60c1d
Go to file
KingRainbow44 c663b60c1d
misc(README.md): Put quick-start guide in a collapsable block
2024-09-28 18:39:39 -04:00
.github misc: Remove the handbook from the main repository 2024-09-28 17:45:21 -04:00
buildSrc/src/main/java/emu/grasscutter/gen Merge unstable into development (#2173) 2023-05-31 23:48:16 -04:00
docs Update README_ja-JP.md (#2516) 2024-06-05 21:14:11 -04:00
gradle/wrapper misc(gradle): Allow support with Java 21 2024-07-06 19:30:13 -04:00
lib feat(5.0): Update KCP library 2024-09-28 18:14:29 -04:00
scripts use pretty_host in domain filtering (#2382) 2023-09-22 23:33:01 -04:00
src misc(InfoCommand.java): Update credits 2024-09-28 17:58:08 -04: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 misc: Remove the handbook from the main repository 2024-09-28 17:45:21 -04:00
.gitmodules misc: Remove the handbook from the main repository 2024-09-28 17:45:21 -04:00
build.gradle misc(build.gradle): Bump version & Java target compatability 2024-09-28 18:31:17 -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 misc(build.gradle): Bump version & Java target compatability 2024-09-28 18:31:17 -04:00
entrypoint.sh Add Docker Support (#2486) 2024-03-17 01:57:39 -04:00
gradle.properties misc: Update package versions 2024-07-06 22:34:10 -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
LICENSE Change LICENSE to GNU Affero 2022-05-08 13:09:22 -07:00
plugin-schema.json Merge unstable into development (#2173) 2023-05-31 23:48:16 -04:00
README.md misc(README.md): Put quick-start guide in a collapsable block 2024-09-28 18:39:39 -04: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 typo in start.cmd (#2415) 2023-10-31 19:50:31 -04: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 works(-ish)
  • 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)

Windows quick start using Cultivation

  • Get Java 21

  • Get MongoDB Community Server

  • Get game version REL5.0

  • 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-21\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.

Downloading 5.0

Download Link Table

Note: Scroll down to see patch files from 4.8 to 5.0.

Download link Package size Decompressed package size MD5 checksum
GenshinImpact_5.0.0.zip.001 10.0 GB 20.0 GB 1ebf5dbcbe43bebcda7a57a8d789092e
GenshinImpact_5.0.0.zip.002 10.0 GB 20.0 GB 57a67026c45d57c28e5b52e24e84cc04
GenshinImpact_5.0.0.zip.003 10.0 GB 20.0 GB 5e66ff28eaf6ba89e49f153c0f077d34
GenshinImpact_5.0.0.zip.004 10.0 GB 20.0 GB 39f014a760e27f77abed1989739c74c6
GenshinImpact_5.0.0.zip.005 10.0 GB 20.0 GB 15f9405a199afba833f18fce288b9c7f
GenshinImpact_5.0.0.zip.006 10.0 GB 20.0 GB 881432ceab27987b1297c9eefb39f192
GenshinImpact_5.0.0.zip.007 3.78 GB 7.57 GB 951f91992b428385294baf9b6c764d49
Audio_Chinese_5.0.0.zip 14.77 GB 29.56 GB 216b3e53f3c5c7e1290891696b2bbc66
Audio_English(US)_5.0.0.zip 17.23 GB 34.47 GB ecd59f31ec48c50f9051fdad39603d67
Audio_Korean_5.0.0.zip 14.51 GB 29.04 GB 8bf09bd07413189b69a5a0512df97335
Audio_Japanese_5.0.0.zip 19.37 GB 38.76 GB 95efbd23e1bde2eb574f8090cc118109

4.8 -> 5.0 Patch FIles

Download link Package size Decompressed package size MD5 checksum
game_4.8.0_5.0.0_hdiff_wZvKsUhQtnBEutrh.zip 19.52 GB 39.86 ec0cc740e01c374cd53d48219c1a4aff
audio_ko-kr_4.8.0_5.0.0_hdiff_gTmBNUAGPpXxrRKC.zip 0.60 GB 1.31 GB 64c52d4065a5d5983b37faeb9796a3eb
audio_ja-jp_4.8.0_5.0.0_hdiff_LumPhRraNOjGJMnG.zip 0.71 GB 1.63 GB 934899593f7234bec937fca98c0b0bed
audio_zh-cn_4.8.0_5.0.0_hdiff_ZZiDHvYQeHGKuFeP.zip 0.62 GB 1.35 GB c1073373d6c7b3680217335dc346de50
audio_en-us_4.8.0_5.0.0_hdiff_vsfAECOkroqoZSqK.zip 0.74 GB 1.58 GB b5cb77749a0e2fc0e85b6b1ee319a7e9

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