diff --git a/README.md b/README.md index 2ae9e0a3e..b0aa1db4f 100644 --- a/README.md +++ b/README.md @@ -1,108 +1,108 @@ -![Grasscutter](https://socialify.git.ci/Grasscutters/Grasscutter/image?description=1&forks=1&issues=1&language=1&logo=https%3A%2F%2Fs2.loli.net%2F2022%2F04%2F25%2FxOiJn7lCdcT5Mw1.png&name=1&owner=1&pulls=1&stargazers=1&theme=Light) -
Documention GitHub release (latest by date) GitHub GitHub last commit GitHub Workflow Status
- -
Discord - Grasscutter
- -EN | [中文](README_zh-CN.md) | [FR](README_fr-FR.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 (recieving items/characters, upgrading items/characters, etc) - -## Quick setup guide - -**Note:** For support please join our [Discord](https://discord.gg/T5vZU6UyeG). - -### Requirements - -* Java SE - 17 ([link](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)) - - **Note:** If you just want to **run it**, then **jre** only is fine. - -* [MongoDB](https://www.mongodb.com/try/download/community) (recommended 4.0+) - -* Proxy daemon: mitmproxy (mitmdump, recommended), Fiddler Classic, etc. - -### Running - -**Note:** If you updated from an older version, delete `config.json` to regenerate it. - -1. Get `grasscutter.jar` - - Download from [actions](https://github.com/Grasscutters/Grasscutter/suites/6895963598/artifacts/267483297) - - [Build by yourself](#Building) -2. Create a `resources` folder in the directory where grasscutter.jar is located and move your `BinOutput` and `ExcelBinOutput` folders there *(Check the [wiki](https://github.com/Grasscutters/Grasscutter/wiki) for more details how to get those.)* -3. Run Grasscutter with `java -jar grasscutter.jar`. **Make sure mongodb service is running as well.** - -### Connecting with the client - -½. Create an account using [server console command](#Commands). - -1. Redirect traffic: (choose one) - - mitmdump: `mitmdump -s proxy.py -k` - - Trust CA certificate: - - ​ **Note:**The CA certificate is usually stored in `% USERPROFILE%\ .mitmproxy`, or you can download it from `http://mitm.it` - - ​ Double click for [install](https://docs.microsoft.com/en-us/skype-sdk/sdn/articles/installing-the-trusted-root-certificate#installing-a-trusted-root-certificate) or ... - - - Via command line - - ```shell - certutil -addstore root %USERPROFILE%\.mitmproxy\mitmproxy-ca-cert.cer - ``` - - - Fiddler Classic: Run Fiddler Classic, turn on `Decrypt https traffic` in setting and change the default port there (Tools -> Options -> Connections) to anything other than `8888`, and load [this script](https://github.lunatic.moe/fiddlerscript). - - - [Hosts file](https://github.com/Melledy/Grasscutter/wiki/Running#traffic-route-map) - -2. Set network proxy to `127.0.0.1:8080` or the proxy port you specified. - -**you can also use `start.cmd` to start servers and proxy daemons automatically, but you have to set up JAVA_HOME enviroment** - -### Building - -Grasscutter uses Gradle to handle dependencies & building. - -**Requirements:** - -- Java SE Development Kits - 17 -- Git - -##### Windows - -```shell -git clone https://github.com/Grasscutters/Grasscutter.git -cd Grasscutter -.\gradlew.bat # Setting up environments -.\gradlew jar # Compile -``` - -##### Linux - -```bash -git clone https://github.com/Grasscutters/Grasscutter.git -cd Grasscutter -chmod +x gradlew -./gradlew jar # Compile -``` - -You can find the output jar in the root of the project folder. - -### Commands have moved to the [wiki](https://github.com/Grasscutters/Grasscutter/wiki/Commands)! - -# Quick Troubleshooting - -* If compiling wasn't successful, please check your JDK installation (JDK 17 and validated JDK's bin PATH variable) -* My client doesn't connect, doesn't login, 4206, etc... - Mostly your proxy daemon setup is *the issue*, if using - Fiddler make sure it running on another port except 8888 -* Startup sequence: MongoDB > Grasscutter > Proxy daemon (mitmdump, fiddler, etc.) > Game +![Grasscutter](https://socialify.git.ci/Grasscutters/Grasscutter/image?description=1&forks=1&issues=1&language=1&logo=https%3A%2F%2Fs2.loli.net%2F2022%2F04%2F25%2FxOiJn7lCdcT5Mw1.png&name=1&owner=1&pulls=1&stargazers=1&theme=Light) +
Documention GitHub release (latest by date) GitHub GitHub last commit GitHub Workflow Status
+ +
Discord - Grasscutter
+ +EN | [简中](README_zh-CN.md) | [繁中](README_zh-TW.md) | [FR](README_fr-FR.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 (recieving items/characters, upgrading items/characters, etc) + +## Quick setup guide + +**Note:** For support please join our [Discord](https://discord.gg/T5vZU6UyeG). + +### Requirements + +* Java SE - 17 ([link](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)) + + **Note:** If you just want to **run it**, then **jre** only is fine. + +* [MongoDB](https://www.mongodb.com/try/download/community) (recommended 4.0+) + +* Proxy daemon: mitmproxy (mitmdump, recommended), Fiddler Classic, etc. + +### Running + +**Note:** If you updated from an older version, delete `config.json` to regenerate it. + +1. Get `grasscutter.jar` + - Download from [actions](https://github.com/Grasscutters/Grasscutter/suites/6895963598/artifacts/267483297) + - [Build by yourself](#Building) +2. Create a `resources` folder in the directory where grasscutter.jar is located and move your `BinOutput` and `ExcelBinOutput` folders there *(Check the [wiki](https://github.com/Grasscutters/Grasscutter/wiki) for more details how to get those.)* +3. Run Grasscutter with `java -jar grasscutter.jar`. **Make sure mongodb service is running as well.** + +### Connecting with the client + +½. Create an account using [server console command](https://github.com/Grasscutters/Grasscutter/wiki/Commands#targeting). + +1. Redirect traffic: (choose one) + - mitmdump: `mitmdump -s proxy.py -k` + + Trust CA certificate: + + ​ **Note:**The CA certificate is usually stored in `%USERPROFILE%\ .mitmproxy`, or you can download it from `http://mitm.it` + + ​ Double click for [install](https://docs.microsoft.com/en-us/skype-sdk/sdn/articles/installing-the-trusted-root-certificate#installing-a-trusted-root-certificate) or ... + + - Via command line + + ```shell + certutil -addstore root %USERPROFILE%\.mitmproxy\mitmproxy-ca-cert.cer + ``` + + - Fiddler Classic: Run Fiddler Classic, turn on `Decrypt https traffic` in setting and change the default port there (Tools -> Options -> Connections) to anything other than `8888`, and load [this script](https://github.lunatic.moe/fiddlerscript). + + - [Hosts file](https://github.com/Melledy/Grasscutter/wiki/Running#traffic-route-map) + +2. Set network proxy to `127.0.0.1:8080` or the proxy port you specified. + +**you can also use `start.cmd` to start servers and proxy daemons automatically, but you have to set up JAVA_HOME enviroment** + +### Building + +Grasscutter uses Gradle to handle dependencies & building. + +**Requirements:** + +- Java SE Development Kits - 17 +- Git + +##### Windows + +```shell +git clone https://github.com/Grasscutters/Grasscutter.git +cd Grasscutter +.\gradlew.bat # Setting up environments +.\gradlew jar # Compile +``` + +##### Linux + +```bash +git clone https://github.com/Grasscutters/Grasscutter.git +cd Grasscutter +chmod +x gradlew +./gradlew jar # Compile +``` + +You can find the output jar in the root of the project folder. + +### Commands have moved to the [wiki](https://github.com/Grasscutters/Grasscutter/wiki/Commands)! + +# Quick Troubleshooting + +* If compiling wasn't successful, please check your JDK installation (JDK 17 and validated JDK's bin PATH variable) +* My client doesn't connect, doesn't login, 4206, etc... - Mostly your proxy daemon setup is *the issue*, if using + Fiddler make sure it running on another port except 8888 +* Startup sequence: MongoDB > Grasscutter > Proxy daemon (mitmdump, fiddler, etc.) > Game diff --git a/README_fr-FR.md b/README_fr-FR.md index ecf47b36c..1d49c1b8b 100644 --- a/README_fr-FR.md +++ b/README_fr-FR.md @@ -3,7 +3,7 @@
Discord - Grasscutter
-[EN](README.md) | [中文](README_zh-CN.md) | FR +[EN](README.md) | [简中](README_zh-CN.md) | [繁中](README_zh-TW.md) | FR **Attention:** De nouveaux contributeurs sont toujours les bienvenus. Avant d'ajouter votre contribution, veuillez lire le [code de conduite](https://github.com/Grasscutters/Grasscutter/blob/stable/CONTRIBUTING.md). @@ -44,14 +44,14 @@ ### Connection avec le client -½. Créez un compte avec la [console de commande du serveur](#Commands). +½. Créez un compte avec la [console de commande du serveur](https://github.com/Grasscutters/Grasscutter/wiki/Commands#targeting). 1. Redirection du traffic: (Choisissez-en un) - mitmdump: `mitmdump -s proxy.py -k` Approuvez le certificat CA: - ​ **Note:**Le certificat CA est généralement stocké sous `% USERPROFILE%\ .mitmproxy`, ou vous pouvez le télécharger depuis `http://mitm.it` + ​ **Note:**Le certificat CA est généralement stocké sous `%USERPROFILE%\ .mitmproxy`, ou vous pouvez le télécharger depuis `http://mitm.it` ​ Double-cliquez pour [installer](https://docs.microsoft.com/en-us/skype-sdk/sdn/articles/installing-the-trusted-root-certificate#installing-a-trusted-root-certificate) oo ... diff --git a/README_zh-CN.md b/README_zh-CN.md index cefb0f9f5..9ae17ca56 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -3,11 +3,11 @@
Discord - Grasscutter
-[EN](README.md) | 中文 | [FR](README_fr-FR.md) +[EN](README.md) | 简中 | [繁中](README_zh-TW.md) | [FR](README_fr-FR.md) -**注意:** 我们一直欢迎您成为该项目的贡献者。在添加您的代码之前，请仔细阅读我们的 [代码规范](https://github.com/Grasscutters/Grasscutter/blob/stable/CONTRIBUTING.md). +**请注意:** 欢迎成为本项目的贡献者。在提交 PR 之前, 请仔细阅读[代码规范](https://github.com/Grasscutters/Grasscutter/blob/stable/CONTRIBUTING.md)。 -## 当前特性 +## 当前功能 * 登录 * 战斗 @@ -20,40 +20,40 @@ ## 快速设置指南 -**附:** 加入我们的 [Discord](https://discord.gg/T5vZU6UyeG) 获取更多帮助！ +**注意:** 如需帮助请加入 [Discord](https://discord.gg/T5vZU6UyeG) ### 环境需求 -* Java SE - 17 (当您没有Oracle账户，可以使用[镜像](https://mirrors.tuna.tsinghua.edu.cn/Adoptium/17/jdk/)) +* Java SE - 17 ([链接](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)) - **注:** 如果您仅仅想要简单地**运行服务端**, 那么使用 **jre** 便足够了 + **注意:** 如果仅想**运行服务端**, 使用 **jre** 即可 -* [MongoDB](https://fastdl.mongodb.org/windows/mongodb-windows-x86_64-5.0.9-signed.msi) (推荐 4.0+) +* [MongoDB](https://www.mongodb.com/try/download/community) (推荐 4.0+) -* Proxy daemon: mitmproxy (推荐使用mitmdump), Fiddler Classic, 等 +* 代理: mitmproxy (推荐 mitmdump), Fiddler Classic 等 ### 运行 -**注:** 如果您从旧版本升级到新版本，最好删除 `config.json` 并启动服务端jar来重新生成它 +**注意:** 从旧版本升级到新版本, 需要删除 `config.json` 文件 1. 获取 `grasscutter.jar` - - 从 [actions](https://github.com/Grasscutters/Grasscutter/suites/6895963598/artifacts/267483297) 中下载 - - [自行构建](#构建) -2. 在**grasscutter.jar** 所在目录中创建 `resources` 文件夹并将 `BinOutput` 和 `ExcelBinOutput` 放入其中 *(查看 [wiki](https://github.com/Grasscutters/Grasscutter/wiki) 了解更多)* -3. 通过命令 `java -jar grasscutter.jar` 来运行Grasscutter. **在此之前请确认MongoDB服务运行正常** + - 从 [actions](https://github.com/Grasscutters/Grasscutter/suites/6895963598/artifacts/267483297) 下载 + - [自行编译](#编译) +2. 在 JAR 文件根目录中创建 `resources` 文件夹并复制 `BinOutput` 和 `ExcelBinOutput` *(查看 [wiki](https://github.com/Grasscutters/Grasscutter/wiki) 了解更多)* +3. 命令行 `java -jar grasscutter.jar` 运行 Grasscutter。**在此之前请确认 MongoDB 服务运行正常** -### 连接 +### 客户端连接 -½. 在服务器控制台中 [创建账户](#命令列表). +½. 在服务器控制台[创建账户](https://github.com/Grasscutters/Grasscutter/wiki/Commands#targeting) -1. 重定向流量: (选其一) - - mitmdump: `mitmdump -s proxy.py -k` +1. 重定向流量: (选择其中一个) + - mitmdump: `mitmdump -s proxy.py -k` 信任 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)或者... - 使用命令行 @@ -61,17 +61,17 @@ certutil -addstore root %USERPROFILE%\.mitmproxy\mitmproxy-ca-cert.cer ``` - - Fiddler Classic: 运行Fiddler Classic, 在设置中开启 `解密https通信` 并将端口切换到除`8888` 以外的任意端口 (工具 -> 选项 -> 连接) 并加载 [此脚本](https://github.lunatic.moe/fiddlerscript). + - Fiddler Classic: 运行 Fiddler Classic, 在设置中开启 `解密 https 通信` 并将端口设为除 `8888` 以外的任意端口 (工具 -> 选项 -> 连接) 并加载[此脚本](https://github.lunatic.moe/fiddlerscript) - - [Hosts文件](https://github.com/Grasscutters/Grasscutter/wiki/Running#traffic-route-map) + - [Hosts 文件](https://github.com/Grasscutters/Grasscutter/wiki/Running#traffic-route-map) -2. 设置代理为 `127.0.0.1:8080` 或其它你所设定的端口 +2. 设置代理为 `127.0.0.1:8080` 或你设置的端口 -**你也可以简单地运行 `start.cmd` 来全自动启动服务端并设置代理** +**也可直接运行 `start.cmd` 一键启动服务端并设置代理, 但必须设置 `JAVA_HOME` 环境变量** -### 构建 +### 编译 -Grasscutter 使用 Gradle 来处理依赖及构建. +Grasscutter 使用 Gradle 来处理依赖及编译。 **依赖:** @@ -83,8 +83,8 @@ Grasscutter 使用 Gradle 来处理依赖及构建. ```shell git clone https://github.com/Grasscutters/Grasscutter.git cd Grasscutter -.\gradlew.bat # Setting up environments -.\gradlew jar # Compile +.\gradlew.bat # 建立开发环境 +.\gradlew jar # 编译 ``` ##### Linux @@ -93,70 +93,16 @@ cd Grasscutter git clone https://github.com/Grasscutters/Grasscutter.git cd Grasscutter chmod +x gradlew -./gradlew jar # Compile +./gradlew jar # 编译 ``` -你可以在项目根目录中找到`grasscutter.jar` +编译后的 JAR 文件存放在根目录 -## 命令列表 - -你可能需要在终端中运行 `java -jar grasscutter.jar -handbook` 它将会创建一个 `GM Handbook.txt` 以方便您查阅物品ID等 - -你可能需要在终端中运行 `java -jar grasscutter.jar -gachamap` 来使得祈愿历史记录系统正常显示物品信息。 这个命令生成一个配置文件到如下文件夹：`GRASSCUTTER_RESOURCE/gcstatic`。 不执行此命令，您的祈愿历史记录中将只会显示数字ID而非物品名称。（目前仅支持自动生成英文记录信息） - -在每个玩家的朋友列表中都有一个名为“Server”的虚拟用户，你可以通过发送消息来使用命令。命令也适用于其他聊天室，例如私人/团队聊天。 -要在游戏中使用命令，需要添加 `/` 或 `!` 前缀，如 `/pos` - -| 命令 | 用法 | 权限节点 | 可用性 | 注释 | 别名 | -| -------------- | -------------------------------------------- | ------------------------- | -------- | ------------------------------------------ | ----------------------------------------------- | -| account | account <用户名> [uid] | | 仅服务端 | 通过指定用户名和uid增删账户 | | -| broadcast | broadcast <消息内容> | server.broadcast | 均可使用 | 给所有玩家发送公告 | b | -| coop | coop \ <目标uid> | server.coop | 均可使用 | 强制某位玩家进入指定玩家的多人世界 | | -| changescene | changescene <场景ID> | player.changescene | 仅客户端 | 切换到指定场景 | scene | -| clear | clear [UID] | player.clearinv | 仅客户端 | 删除所有未装备及未解锁的圣遗物(art)或武器(wp)或材料(mat)或者所有(all),包括五星 | clear | -| drop | drop <物品ID\|物品名称> [数量] | server.drop | 仅客户端 | 在指定玩家周围掉落指定物品 | `d` `dropitem` | -| enterdungeon | enterdungeon <地牢ID> | player.enterdungeon | 仅客户端 | 进入某个地牢 | | -| give | give [uid] <物品ID\|物品名称> [数量] [等级] [精炼等级] | player.give | 均可使用 | 给予指定玩家一定数量及等级的物品 (精炼等级仅适用于武器) | `g` `item` `giveitem` | -| givechar | givechar \ <角色ID> [等级] | player.givechar | 均可使用 | 给予指定玩家对应角色 | givec | -| giveart | giveart [uid] \<圣遗物ID> \<主属性ID> [\<副属性ID>[,<次数>]]... [等级] | player.giveart | 均可使用 | 给予玩家指定属性的圣遗物 | gart | -| giveall | giveall [uid] [数量] | player.giveall | 均可使用 | 给予指定玩家全部物品 | givea | -| godmode | godmode [uid] | player.godmode | 仅客户端 | 保护你不受到任何伤害(依然会被击退) | | -| heal | heal | player.heal | 仅客户端 | 治疗队伍中所有角色 | h | -| help | help [命令] | | 均可使用 | 显示帮助或展示指定命令的帮助 | | -| join | join [多个角色id] | player.join | 仅客户端 | 强制入队角色，跟config.json中的avatarLimits有关（跟队内角色数量上限有关）。用法：`join 10000021 10000022` | | -| kick | kick \ | server.kick | 均可使用 | 从服务器中踢出指定玩家 (WIP) | k | -| killall | killall [uid] [场景ID] | server.killall | 均可使用 | 杀死指定玩家世界中所在或指定场景的全部生物 | | -| list | list | | 均可使用 | 列出在线玩家 | | -| permission | permission <权限节点> | * | 均可使用 | 添加或移除玩家的权限 | | -| position | position | | 仅客户端 | 获取当前坐标 | pos | -| remove | remove [多个角色在队伍中的序号] | player.remove | 仅客户端 | 强制将某个角色从当前队伍中移除。例如`remove 1 2`表示将1号和2号角色移除 | | -| reload | reload | server.reload | 均可使用 | 重载服务器配置 | | -| resetconst | resetconst [all] | player.resetconstellation | 仅客户端 | 重置当前角色的命座,重新登录即可生效 | resetconstellation | -| restart | restart | | 均可使用 | 重启服务端 | | -| say | say \ <消息> | server.sendmessage | 均可使用 | 作为服务器发送消息给玩家 | `sendservmsg` `sendservermessage` `sendmessage` | -| setfetterlevel | setfetterlevel <好感等级> | player.setfetterlevel | 仅客户端 | 设置当前角色的好感等级 | `setfetterlvl` `setfriendship` | -| setstats | setstats <属性> <数值> | player.setstats | 仅客户端 | 直接修改当前角色的面板 | stats | -| setworldlevel | setworldlevel <世界等级> | player.setworldlevel | 仅客户端 | 设置世界等级(重新登录即可生效) | setworldlvl | -| spawn | spawn <实体ID> [数量] [等级] | server.spawn | 仅客户端 | 在你周围生成实体 | | -| stop | stop | server.stop | 均可使用 | 停止服务器 | | -| talent | talent <天赋ID> <等级> | player.settalent | 仅客户端 | 设置当前角色的天赋等级 | | -| teleport | teleport [@playerUid] \ \ \ [sceneId] | player.teleport | 均可使用 | 传送玩家到指定坐标 | tp | -| tpall | | player.tpall | 仅客户端 | 传送多人世界中所有的玩家到自身地点 | | -| unlocktower | | player.tower | 仅客户端 | 解锁深渊全部层 | ut | -| weather | weather <天气ID> <气候ID> | player.weather | 仅客户端 | 改变天气 | w | - -### 额外功能 - -当你想传送到某个地点, 只需要在地图中创建标记, 关闭地图后即可到达目标地点上空 -- 传送 - - 当你想传送到某个地点时，可以使用游戏里的地图标记功能。 - - 用鱼钩（最后一个图标）在地图上标记一个点位。 - - （可选） 将标记名称改为数字，即可修改传送位置的Y坐标（高度，缺省值是300）。 - - 确认添加标记，并关闭地图。 - - 你会看到你的角色从你选定点位的正上方高空落下。 +### 命令列表请到 [wiki](https://github.com/Grasscutters/Grasscutter/wiki/Commands) 查看 # 快速排除问题 -* 如果编译未能成功,请检查您的jdk安装 (JDK 17并确认jdk处于环境变量`PATH`中 -* 我的客户端无法登录/连接, 4206, 其它... - 大部分情况下这是因为您的代理存在问题.如果使用Fiddler请确认Fiddler监听端口不是`8888` -* 启动顺序: MongoDB > Grasscutter > 代理程序 (mitmdump, fiddler等.) > 客户端 +* 如果编译失败, 请检查 JDK 安装是否正确 (要求 JDK 17 并确认 JDK 处于环境变量 `PATH` 中) +* 客户端无法登录/连接, 4206, 其他问题... - 大部分情况是因为代理设置本身就是*问题*。 + 如果使用 Fiddler 请确认 Fiddler 监听端口不是 `8888` +* 启动顺序: MongoDB > Grasscutter > 代理程序 (mitmdump, fiddler 等) > 客户端 diff --git a/README_zh-TW.md b/README_zh-TW.md new file mode 100644 index 000000000..4f6d1f6ae --- /dev/null +++ b/README_zh-TW.md @@ -0,0 +1,108 @@ +![Grasscutter](https://socialify.git.ci/Grasscutters/Grasscutter/image?description=1&forks=1&issues=1&language=1&logo=https%3A%2F%2Fs2.loli.net%2F2022%2F04%2F25%2FxOiJn7lCdcT5Mw1.png&name=1&owner=1&pulls=1&stargazers=1&theme=Light) +
Documention GitHub release (latest by date) GitHub GitHub last commit GitHub Workflow Status
+ +
Discord - Grasscutter
+ +[EN](README.md) | [简中](README_zh-CN.md) | 繁中 | [FR](README_fr-FR.md) + +**請注意:** 歡迎成為本專案的貢獻者。在提交 PR 之前, 請仔細閱讀[程式碼規範](https://github.com/Grasscutters/Grasscutter/blob/stable/CONTRIBUTING.md)。 + +## 當前功能 + +* 登入 +* 戰鬥 +* 好友列表 +* 傳送系統 +* 祈願系統 +* 從控制台生成魔物 +* 多人遊戲 *部分* 可用 +* 物品欄相關 (接收物品/角色, 升級角色/武器等) + +## 快速設定指南 + +**注意:** 如需幫助請加入 [Discord](https://discord.gg/T5vZU6UyeG) + +### 環境需求 + +* Java SE - 17 ([連結](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)) + + **注意:** 如果僅想**執行服務端**, 使用 **jre** 即可 + +* [MongoDB](https://www.mongodb.com/try/download/community) (推薦 4.0+) + +* 代理: mitmproxy (推薦 mitmdump), Fiddler Classic 等 + +### 執行 + +**注意:** 從舊版本升級到新版本, 需要刪除 `config.json` 檔案 + +1. 獲取 `grasscutter.jar` + - 從 [actions](https://github.com/Grasscutters/Grasscutter/suites/6895963598/artifacts/267483297) 下載 + - [自行編譯](#編譯) +2. 在 JAR 檔案根目錄中建立 `resources` 資料夾並複製 `BinOutput` 和 `ExcelBinOutput` *(查看 [wiki](https://github.com/Grasscutters/Grasscutter/wiki) 瞭解更多)* +3. 命令列 `java -jar grasscutter.jar` 執行 Grasscutter。**在此之前請確認 MongoDB 服務執行正常** + +### 客戶端連線 + +½. 在伺服器控制台[建立賬戶](https://github.com/Grasscutters/Grasscutter/wiki/Commands#targeting) + +1. 重定向流量: (選擇其中一個) + - mitmdump: `mitmdump -s proxy.py -k` + + 信任 CA 證書: + + ​ **注意:** 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)或者... + + - 使用命令列 + + ```shell + certutil -addstore root %USERPROFILE%\.mitmproxy\mitmproxy-ca-cert.cer + ``` + + - Fiddler Classic: 執行 Fiddler Classic, 在設定中開啟 `解密 https 通訊` 並將通訊埠設為除 `8888` 以外的任意通訊埠 (工具 -> 選項 -> 連線) 並載入[此指令碼](https://github.lunatic.moe/fiddlerscript) + + - [Hosts 檔案](https://github.com/Grasscutters/Grasscutter/wiki/Running#traffic-route-map) + +2. 設定代理為 `127.0.0.1:8080` 或你設定的通訊埠 + +**也可直接執行 `start.cmd` 一鍵啟動服務端並設定代理, 但必須設定 `JAVA_HOME` 環境變數** + +### 編譯 + +Grasscutter 使用 Gradle 來處理依賴及編譯。 + +**依賴:** + +- Java SE Development Kits - 17 +- Git + +##### Windows + +```shell +git clone https://github.com/Grasscutters/Grasscutter.git +cd Grasscutter +.\gradlew.bat # 建立開發環境 +.\gradlew jar # 編譯 +``` + +##### Linux + +```bash +git clone https://github.com/Grasscutters/Grasscutter.git +cd Grasscutter +chmod +x gradlew +./gradlew jar # 編譯 +``` + +編譯後的 JAR 檔案存放在根目錄 + +### 命令列表請到 [wiki](https://github.com/Grasscutters/Grasscutter/wiki/Commands) 查看 + +# 快速排除問題 + +* 如果編譯失敗, 請檢查 JDK 安裝是否正確 (要求 JDK 17 並確認 JDK 處於環境變數 `PATH` 中) +* 客戶端無法登入/連線, 4206, 其他問題... - 大部分情況是因為代理設定本身就是*問題*。 + 如果使用 Fiddler 請確認 Fiddler 監聽通訊埠不是 `8888` +* 啟動順序: MongoDB > Grasscutter > 代理程式 (mitmdump, fiddler 等) > 客戶端