• 中文
• English

MatrixSync-MCDR

一个MCDR（全称MCDReforged）插件，用于同步Matrix群组和《我的世界》服务器的线上游戏之间的消息。

关于Matrix: 一个开放的去中心化通讯协议，用于聊天软件。

开发过程中用到的项目：matrix-nio。

用法

从release下载最新版本，在MCDReforged的启动环境中安装好需要的Python依赖，然后扔到plugins文件夹里面即可。

在使用此插件之前，你必须知道什么是Matrix，然后准备一个账号作为matrix机器人用于消息同步，并认真阅读下面的内容以进行插件配置。

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

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

配置文件

config.json

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

settings.json

配置项	配置内容
plugin-enabled	插件是否启用，请确保配置文件和所需设置修改无误后再开启
allow_all_rooms_msg	是否允许来自所有房间的消息，若开启，则来自机器人账号所加入的房间的消息都会被转发到游戏中，并注明房间的显示名称，否则只转发已设置的房间的消息

接口（API）

插件提供了一个协程函数sendMsg()供其他开发者调用以实现向Matrix群组发送自定义内容，其回调参数为message，下面是代码参考：

import asyncio
import ...
from mcdreforged.api.all import *
from matrix_sync.reporter import sendMsg
from ... import ...
def main():
    pass
    asyncio.run(sendMsg(message))

将message替换成你想要发送的自定义内容即可。

注意

• bug性支持热重载，会产生大量报错，可能没有实际影响（希望有大佬能帮助修复，欢迎PR；全局重载插件也会导致此事故）
• 若热重载，必须手动执行!!msync，才能使Matrix消息继续同步到游戏中
• 首次加载插件的时候，插件将自动初始化配置并卸载自己。你需要正确修改默认的配置文件，然后重启服务器或着重载插件以正常使用。
• 不打算支持加密信息（EE2E），有需要可以二次开发修改插件。
• 多语言目前只支持中文（简体）和英语（用谷歌从中文翻译），任何人都可以联系我帮助翻译。