Update README_zh-CN.md

This commit is contained in:
Jaida Wu 2022-08-26 00:58:47 +08:00 committed by Melledy
parent 6d65b71512
commit 1b31a0190c

View File

@ -5,18 +5,18 @@
[EN](README.md) | 简中 | [繁中](README_zh-TW.md) | [FR](README_fr-FR.md) | [ES](README_es-ES.md) | [HE](README_HE.md) | [RU](README_ru-RU.md) | [PL](README_pl-PL.md) | [ID](README_id-ID.md) | [KR](README_ko-KR.md) | [FIL/PH](README_fil-PH.md) [EN](README.md) | 简中 | [繁中](README_zh-TW.md) | [FR](README_fr-FR.md) | [ES](README_es-ES.md) | [HE](README_HE.md) | [RU](README_ru-RU.md) | [PL](README_pl-PL.md) | [ID](README_id-ID.md) | [KR](README_ko-KR.md) | [FIL/PH](README_fil-PH.md)
**请注意:** 欢迎成为本项目的贡献者。在提交 PR 之前, 请仔细阅读[代码规范](https://github.com/Grasscutters/Grasscutter/blob/stable/CONTRIBUTING.md)。 **请注意:** 欢迎成为本项目的贡献者。在提交 PR 之前, 请仔细阅读 [代码规范](https://github.com/Grasscutters/Grasscutter/blob/stable/CONTRIBUTING.md)。
## 当前功能 ## 当前功能
* 登录 * 登录
* 战斗 * 战斗
* 好友列表 * 好友
* 传送系统 * 传送
* 祈愿系统 * 祈愿
* 从控制台生成魔物
* 多人游戏 *部分* 可用 * 多人游戏 *部分* 可用
* 物品栏相关 (接收物品/角色, 升级角色/武器等) * 从控制台生成魔物
* 物品 (接收或升级角色、武器等)
## 快速设置指南 ## 快速设置指南
@ -24,23 +24,22 @@
### 环境需求 ### 环境需求
* Java SE - 17 ([链接](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)) * [Java SE - 17](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)
**注意:** 如果仅想**运行服务端**, 使用 **jre** 即可 **注意:** 如果想仅**运行服务端**, 只下载 **jre** 即可
* [MongoDB](https://www.mongodb.com/try/download/community) (推荐 4.0+) * [MongoDB](https://www.mongodb.com/try/download/community) (推荐 4.0+)
* 代理程序: mitmproxy (推荐 mitmdump), Fiddler Classic * 代理程序: [mitmproxy](https://mitmproxy.org/) (仅需 mitmdump推荐使用), [Fiddler Classic](https://telerik-fiddler.s3.amazonaws.com/fiddler/FiddlerSetup.exe)
### 运行 ### 运行服务端
**注意:** 从旧版本升级到新版本, 需要删除 `config.json` **注意:** 从旧版本升级到新版本, 需要删除 `config.json` 使其重新生成
1. 获取 `grasscutter.jar` 1. 获取 `grasscutter.jar`
- 从 [actions](https://github.com/Grasscutters/Grasscutter/suites/6895963598/artifacts/267483297) 下载 - 从 [actions](https://github.com/Grasscutters/Grasscutter/actions) 下载,或 [自行编译](#编译)
- [自行编译](#编译) 2. 在 JAR 文件根目录中创建 `resources` 文件夹并复制 `BinOutput``ExcelBinOutput` *(查看 [Wiki](https://github.com/Grasscutters/Grasscutter/wiki) 了解更多)*
2. 在 JAR 文件根目录中创建 `resources` 文件夹并复制 `BinOutput``ExcelBinOutput` *(查看 [wiki](https://github.com/Grasscutters/Grasscutter/wiki) 了解更多)* 3. **确认 MongoDB 服务运行正常后**,使用命令行 `java -jar grasscutter.jar` 运行 Grasscutter。
3. 命令行 `java -jar grasscutter.jar` 运行 Grasscutter。**在此之前请确认 MongoDB 服务运行正常**
### 客户端连接 ### 客户端连接
@ -51,7 +50,7 @@
信任 CA 证书: 信任 CA 证书:
**注意:** mitmproxy 的 CA 证书通常存放在 `%USERPROFILE%\ .mitmproxy`, 或者 `http://mitm.it` 下载证书 **注意:** mitmproxy 的 CA 证书通常存放在 `%USERPROFILE%\ .mitmproxy`, 或者 `http://mitm.it` 下载证书
双击 [安装根证书](https://docs.microsoft.com/en-us/skype-sdk/sdn/articles/installing-the-trusted-root-certificate#installing-a-trusted-root-certificate)或者... 双击 [安装根证书](https://docs.microsoft.com/en-us/skype-sdk/sdn/articles/installing-the-trusted-root-certificate#installing-a-trusted-root-certificate)或者...
@ -67,32 +66,28 @@
2. 设置代理为 `127.0.0.1:8080` 或你设置的端口 2. 设置代理为 `127.0.0.1:8080` 或你设置的端口
**也可直接运行 `start.cmd` 一键启动服务端并设置代理, 但必须设置 `JAVA_HOME` 环境变量** **也可直接运行 `start.cmd` 一键启动服务端并设置代理, 但设置 `JAVA_HOME` 环境变量并配置 `start_config.cmd`**
### 编译 ### 构建
Grasscutter 使用 Gradle 来处理依赖及编译。 Grasscutter 使用 Gradle 来处理依赖及编译。
**依赖:** **前置依赖:**
- [Java SE Development Kits - 17](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) - [Java SE Development Kits - 17](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)
- [Git](https://git-scm.com/downloads) - [Git](https://git-scm.com/downloads)
##### Windows(在线克隆代码) ##### Windows
```shell ```shell
git clone https://github.com/Grasscutters/Grasscutter.git # 或使用自己的fork地址 git clone https://github.com/Grasscutters/Grasscutter.git
cd Grasscutter cd Grasscutter
.\gradlew.bat # 建立开发环境 :: 建立开发环境
.\gradlew jar # 编译 gradlew
:: 编译
gradlew jar
``` ```
##### Windows本地编译
```shell
cd <本地地址>/Grasscutter
.\gradlew.bat # 建立开发环境
.\gradlew jar # 编译
```
##### Linux ##### Linux
```bash ```bash
@ -102,14 +97,13 @@ chmod +x gradlew
./gradlew jar # 编译 ./gradlew jar # 编译
``` ```
* 编译后的 JAR 文件存放在根目录 * 编译后的 JAR 文件会在源码根目录生成
* Windows如创建为.bat文件请删除注释
### 命令列表请到 [wiki](https://github.com/Grasscutters/Grasscutter/wiki/Commands) 查看 ### 命令列表请到 [wiki](https://github.com/Grasscutters/Grasscutter/wiki/Commands) 查看
# 快速排除问题 # 快速问题排除
* 如果编译失败, 请检查 JDK 安装是否正确 (要 JDK 17 并确认 JDK 处于环境变量 `PATH` 中) * 如果编译失败, 请检查 JDK 安装是否正确 (要 JDK 17 并确认 JDK 的 bin 文件夹处于环境变量 `PATH` 中)
* 客户端无法登录/连接, 4206, 其他问题... - 大部分情况是因为代理设置本身就是*问题*。 * 客户端无法登录、连接、错误 420 等其他问题... - 大部分情况是因为代理设置出现了*问题*。
如果使用 Fiddler 请确认 Fiddler 监听端口不是 `8888` 如果使用 Fiddler请确认 Fiddler 监听端口不是 `8888`
* 启动顺序: MongoDB > Grasscutter > 代理程序 (mitmdump, fiddler 等) > 客户端 * 启动顺序: MongoDB > Grasscutter > 代理程序 (mitmdump, Fiddler 等) > 客户端