forked from Grasscutters/Grasscutter
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
亡灵暴龙大帝
committed
Jul 2, 2024
1 parent
24c9a5e
commit baa5da8
Showing
1 changed file
with
1 addition
and
100 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,100 +1 @@ | ||
|  | ||
| <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 *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](https://discord.gg/T5vZU6UyeG). | ||
|
|
||
| ### Quick Start (automatic) | ||
|
|
||
| - Get [Java 17](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) | ||
| - Get [MongoDB Community Server](https://www.mongodb.com/try/download/community) | ||
| - 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](https://github.com/JRSKelvin/GenshinRepository/blob/main/Version%204.0.0.md) | ||
| [4.0.x Client-cloud drive](https://www.123pan.com/s/HoqUVv-U7SBA.html) | ||
|
|
||
| - 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-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](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) or higher | ||
| - [Git](https://git-scm.com/downloads) | ||
| - [NodeJS](https://nodejs.org/en/download) (Optional, for building the handbook) | ||
|
|
||
| ##### Clone | ||
|
|
||
| ```shell | ||
| 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: | ||
|
|
||
| ```shell | ||
| .\gradlew.bat # Setting up environments | ||
| .\gradlew jar | ||
| ``` | ||
|
|
||
| Linux (GNU): | ||
|
|
||
| ```bash | ||
| chmod +x gradlew | ||
| ./gradlew jar | ||
| ``` | ||
|
|
||
| ##### Compiling the Handbook (Manually) | ||
|
|
||
| With Gradle: | ||
|
|
||
| ```shell | ||
| ./gradlew generateHandbook | ||
| ``` | ||
|
|
||
| With NPM: | ||
|
|
||
| ```shell | ||
| 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](https://discord.gg/T5vZU6UyeG) and go to the support channel. | ||
| 目前正在测试JNLUA在单个服务器承载多人时的内存占用情况(据说使用JNLUA比LUAJ性能更好 内存占用更少) 急需人力 如果您想参与请加入Q群: 154422757 只需要进入服务器到处逛逛 (服务器现在在线人数真的很低 只有同时在线30个人以上才能测出来) |