Skip to content

Commit

Permalink
Merge pull request #11 from Mooling0602/main
Browse files Browse the repository at this point in the history
Merge brunch main to dev
  • Loading branch information
Mooling0602 authored Nov 10, 2024
2 parents 6e07aa7 + a4465ec commit 95c745f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
- 中文
- [English](https://github.com/Mooling0602/MatrixSync-MCDR/blob/dev/README_en_us.md)
- [English](https://github.com/Mooling0602/MatrixSync-MCDR/blob/README_en_us.md)

# MatrixSync-MCDR
一个MCDR(全称[MCDReforged](https://mcdreforged.com/))插件,用于同步Matrix群组和《我的世界》服务器的线上游戏之间的消息。
Expand All @@ -8,7 +8,7 @@

开发过程中用到的pypi项目:[matrix-nio](https://pypi.org/project/matrix-nio/)

当前分支版本:开发中@2.4.0
当前分支版本:主分支@2.4.0

## 用法
从release下载最新版本,在MCDReforged的启动环境中安装好需要的Python依赖,然后扔到plugins文件夹里面即可。
Expand Down
8 changes: 4 additions & 4 deletions README_en_us.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- [中文](https://github.com/Mooling0602/MatrixSync-MCDR/blob/dev/README.md)
- [中文](https://github.com/Mooling0602/MatrixSync-MCDR/blob/README.md)
- English

# MatrixSync-MCDR
Expand All @@ -10,7 +10,7 @@ The following project is used in the development process: [matrix-nio](https://p

Thanks for ChatGPT and Google Translate's help to translate the content from Chinese, if anything wrong, please issue to feedback or PR to `/lang`.

Present branch version: dev@2.4.0
Present branch version: main@2.4.0

## Usage
Download the latest version from the release, install the necessary Python dependencies in the MCDReforged startup environment, and then throw it into the plugins folder.
Expand Down Expand Up @@ -43,7 +43,7 @@ Multi-config is not supported, will add API support for developers from v3.
| sync_old_msg | Whether to sync old messages, enabled on default, disable to see old messages when plugin is just loaded |

## Interface (API)
See "接口(API)" [中文](https://github.com/Mooling0602/MatrixSync-MCDR/blob/dev/README.md) README.
See "接口(API)" [中文](https://github.com/Mooling0602/MatrixSync-MCDR/blob/README.md) README.

## Hot Reload (reload) & message sync control
By default, the plugin automatically starts the room message reception process when the game server starts and automatically stops the process when the game server shuts down.
Expand All @@ -64,4 +64,4 @@ It is advisable not to use hot reload in a stable environment.
### First-time Use
When loading the plugin for the first time, the plugin will automatically initialize the configuration and then unload itself. You need to correctly modify the default configuration file and enable the plugin_enabled option in settings.json to activate the plugin. Then, restart the server or reload the plugin for proper use. If you choose the latter, after reloading the plugin, if the server has finished starting, you can use !!msync start to start the room message receiver, enabling Matrix message forwarding to the game. Furthermore, as long as the plugin is successfully loaded without issues, in-game messages will always be automatically forwarded to the Matrix room. This will be synchronized with the room message receiver in versions above 2.4.0.

- The plugin does not support encrypted messages (EE2E). If needed, you can modify the plugin for secondary development, and PRs are welcome.
- The plugin does not support encrypted messages (EE2E). If needed, you can modify the plugin for secondary development, and PRs are welcome.

0 comments on commit 95c745f

Please sign in to comment.