Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
update for v2.0.0 new architecture
  • Loading branch information
Mooling0602 authored May 21, 2024
1 parent 5f36b99 commit 40f5df5
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,34 @@
开发过程中用到的项目:[matrix-nio](https://pypi.org/project/matrix-nio/)

## 用法
从release下载最新版本,扔到plugins文件夹里面,然后按控制台输出修改配置文件并重载插件,直到测试消息成功发送到matrix群组,消息同步开始工作
从release下载最新版本,在MCDReforged的启动环境中安装好需要的Python依赖,然后扔到plugins文件夹里面即可

在使用此插件之前,你必须知道什么是[Matrix](https://matrix.org/),然后准备一个账号作为matrix机器人用于消息同步。在配置文件中,"user"(“用户”)实际上意为"bot"(“机器人”)。
在使用此插件之前,你必须知道什么是[Matrix](https://matrix.org/),然后准备一个账号作为matrix机器人用于消息同步,并认真阅读下面的内容以进行插件配置。

配置完毕并启用插件后,若有测试消息成功发送到matrix群组,则表示消息同步开始工作。

若消息同步的过程中有任意方向的消息转发出现问题,也请按下面的内容检查配置是否正确。

### 配置文件
#### config.json

| 配置项 | 配置内容 |
| - | - |
| **homeserver** | 机器人账号登录所使用的根服务器 |
| **user_id** | 机器人的账号ID,格式为@<用户名>:<根服务器>,如@mcchatbot:example.com |
| **password** | 机器人账号的密码,一般仅在初次登录使用 |
| **room_id** | 需要接收游戏消息的房间的ID,目前只能设置一个 |
| **room_name** | 需要转发消息到游戏内的房间的显示名称(必须准确无误,若发生更新也需要同步修改,否则你将可能看不到任何消息),目前只能设置一个 |

#### settings.json

| 配置项 | 配置内容 |
| - | - |
| plugin-enabled | 插件是否启用,请确保配置文件和所需设置修改无误后再开启 |
| allow_all_rooms_msg | 是否允许来自所有房间的消息,若开启,则来自机器人账号所加入的房间的消息都会被转发到游戏中,并注明房间的显示名称,否则只转发已设置的房间的消息 |
| use_token | 是否使用Token,默认启用,下次重启服务器时会加载部分之前收到的消息(发生在服务器启动完毕时,如果玩家登录过快,可能会在线上游戏内看到),并使用之前的会话继续转发来自Matrix的消息到游戏中;如果不想加载历史消息可以关闭,但每次重启服务器都会产生新的登录会话记录 |

## 注意
- 首次加载插件的时候,插件将自动初始化配置并卸载自己。你需要正确修改默认的配置文件,然后重启服务器或着重载插件以正常使用。
- 不打算支持加密信息(EE2E),有需要可以二次开发修改插件。
- 多语言目前只支持中文(简体)和英语(用谷歌从中文翻译),任何人都可以联系我帮助翻译。
- 为修复“回音消息”问题,在v1.0.1+版本使用了一个临时的解决方案,你需要在配置文件的"user_name"项中设置机器人账号的显示名称。

0 comments on commit 40f5df5

Please sign in to comment.