mirror of
https://github.com/Melledy/Grasscutter.git
synced 2024-11-24 13:19:28 +00:00
126 lines
8.8 KiB
Markdown
126 lines
8.8 KiB
Markdown
|
|
<div align="center"><img alt="Documentation" src="https://img.shields.io/badge/Wiki-Grasscutter-blue?style=for-the-badge&link=https://github.com/Grasscutters/Grasscutter/wiki&link=https://github.com/Grasscutters/Grasscutter/wiki"> <img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/Grasscutters/Grasscutter?logo=java&style=for-the-badge"> <img alt="GitHub" src="https://img.shields.io/github/license/Grasscutters/Grasscutter?style=for-the-badge"> <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/Grasscutters/Grasscutter?style=for-the-badge"> <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/Grasscutters/Grasscutter/build.yml?branch=development&logo=github&style=for-the-badge"></div>
|
|
|
|
<div align="center"><a href="https://discord.gg/T5vZU6UyeG"><img alt="Discord - Grasscutter" src="https://img.shields.io/discord/965284035985305680?label=Discord&logo=discord&style=for-the-badge"></a></div>
|
|
|
|
[EN](README.md) | [简中](docs/README_zh-CN.md) | [繁中](docs/README_zh-TW.md) | [FR](docs/README_fr-FR.md) | [ES](docs/README_es-ES.md) | [HE](docs/README_HE.md) | [RU](docs/README_ru-RU.md) | [PL](docs/README_pl-PL.md) | [ID](docs/README_id-ID.md) | [KR](docs/README_ko-KR.md) | [FIL/PH](docs/README_fil-PH.md) | [NL](docs/README_NL.md) | [JP](docs/README_ja-JP.md) | [IT](docs/README_it-IT.md) | [VI](docs/README_vi-VN.md)
|
|
|
|
**Attention:** We always welcome contributors to the project. Before adding your contribution, please carefully read our [Code of Conduct](https://github.com/Grasscutters/Grasscutter/blob/stable/CONTRIBUTING.md).
|
|
|
|
## 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](https://discord.gg/T5vZU6UyeG).
|
|
|
|
### Quick Start (automatic)
|
|
|
|
<details>
|
|
|
|
<summary>Windows quick start using Cultivation</summary>
|
|
|
|
- Get [Java 21](https://www.oracle.com/java/technologies/javase/jdk21-archive-downloads.html)
|
|
- Get [MongoDB Community Server](https://www.mongodb.com/try/download/community)
|
|
- Get [game version REL5.0](#downloading-50)
|
|
|
|
- Download the [latest Cultivation version](https://github.com/Grasscutters/Cultivation/releases/latest). 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.
|
|
|
|
</details>
|
|
|
|
### Downloading 5.0
|
|
|
|
<details>
|
|
|
|
<summary>Download Link Table</summary>
|
|
|
|
**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](https://autopatchhk.yuanshen.com/client_app/download/pc_zip/20240816185649_LtymMnnIZVQfbLZ2/GenshinImpact_5.0.0.zip.001) | 10.0 GB | 20.0 GB | 1ebf5dbcbe43bebcda7a57a8d789092e |
|
|
| [GenshinImpact_5.0.0.zip.002](https://autopatchhk.yuanshen.com/client_app/download/pc_zip/20240816185649_LtymMnnIZVQfbLZ2/GenshinImpact_5.0.0.zip.002) | 10.0 GB | 20.0 GB | 57a67026c45d57c28e5b52e24e84cc04 |
|
|
| [GenshinImpact_5.0.0.zip.003](https://autopatchhk.yuanshen.com/client_app/download/pc_zip/20240816185649_LtymMnnIZVQfbLZ2/GenshinImpact_5.0.0.zip.003) | 10.0 GB | 20.0 GB | 5e66ff28eaf6ba89e49f153c0f077d34 |
|
|
| [GenshinImpact_5.0.0.zip.004](https://autopatchhk.yuanshen.com/client_app/download/pc_zip/20240816185649_LtymMnnIZVQfbLZ2/GenshinImpact_5.0.0.zip.004) | 10.0 GB | 20.0 GB | 39f014a760e27f77abed1989739c74c6 |
|
|
| [GenshinImpact_5.0.0.zip.005](https://autopatchhk.yuanshen.com/client_app/download/pc_zip/20240816185649_LtymMnnIZVQfbLZ2/GenshinImpact_5.0.0.zip.005) | 10.0 GB | 20.0 GB | 15f9405a199afba833f18fce288b9c7f |
|
|
| [GenshinImpact_5.0.0.zip.006](https://autopatchhk.yuanshen.com/client_app/download/pc_zip/20240816185649_LtymMnnIZVQfbLZ2/GenshinImpact_5.0.0.zip.006) | 10.0 GB | 20.0 GB | 881432ceab27987b1297c9eefb39f192 |
|
|
| [GenshinImpact_5.0.0.zip.007](https://autopatchhk.yuanshen.com/client_app/download/pc_zip/20240816185649_LtymMnnIZVQfbLZ2/GenshinImpact_5.0.0.zip.007) | 3.78 GB | 7.57 GB | 951f91992b428385294baf9b6c764d49 |
|
|
| [Audio_Chinese_5.0.0.zip](https://autopatchhk.yuanshen.com/client_app/download/pc_zip/20240816185649_LtymMnnIZVQfbLZ2/Audio_Chinese_5.0.0.zip) | 14.77 GB | 29.56 GB | 216b3e53f3c5c7e1290891696b2bbc66 |
|
|
| [Audio_English(US)_5.0.0.zip](https://autopatchhk.yuanshen.com/client_app/download/pc_zip/20240816185649_LtymMnnIZVQfbLZ2/Audio_English(US)_5.0.0.zip) | 17.23 GB | 34.47 GB | ecd59f31ec48c50f9051fdad39603d67 |
|
|
| [Audio_Korean_5.0.0.zip](https://autopatchhk.yuanshen.com/client_app/download/pc_zip/20240816185649_LtymMnnIZVQfbLZ2/Audio_Korean_5.0.0.zip) | 14.51 GB | 29.04 GB | 8bf09bd07413189b69a5a0512df97335 |
|
|
| [Audio_Japanese_5.0.0.zip](https://autopatchhk.yuanshen.com/client_app/download/pc_zip/20240816185649_LtymMnnIZVQfbLZ2/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](https://autopatchhk.yuanshen.com/client_app/update/hk4e_global/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](https://autopatchhk.yuanshen.com/client_app/update/hk4e_global/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](https://autopatchhk.yuanshen.com/client_app/update/hk4e_global/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](https://autopatchhk.yuanshen.com/client_app/update/hk4e_global/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](https://autopatchhk.yuanshen.com/client_app/update/hk4e_global/audio_en-us_4.8.0_5.0.0_hdiff_vsfAECOkroqoZSqK.zip) | 0.74 GB | 1.58 GB | b5cb77749a0e2fc0e85b6b1ee319a7e9 |
|
|
|
|
</details>
|
|
|
|
### Building
|
|
|
|
Grasscutter uses Gradle to handle dependencies & building.
|
|
|
|
**Requirements:**
|
|
|
|
- [Java Development Kit 21](https://www.oracle.com/java/technologies/javase/jdk21-archive-downloads.html) or higher
|
|
- [Git](https://git-scm.com/downloads)
|
|
|
|
##### Clone
|
|
|
|
```shell
|
|
git clone --recurse-submodules https://github.com/Grasscutters/Grasscutter.git
|
|
cd Grasscutter
|
|
```
|
|
|
|
##### Compile
|
|
|
|
Windows:
|
|
|
|
```shell
|
|
.\gradlew.bat # Setting up environments
|
|
.\gradlew jar
|
|
```
|
|
|
|
Linux (GNU):
|
|
|
|
```bash
|
|
chmod +x gradlew
|
|
./gradlew jar
|
|
```
|
|
|
|
### Troubleshooting
|
|
|
|
For a list of common issues and solutions and to ask for help, please join [our Discord server](https://discord.gg/T5vZU6UyeG) 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](https://github.com/OcenWang-GI/AyakaPS-KCP) - `grasskcper` updated with the `byte_check_code`
|