diff --git a/README.md b/README.md index 7b13788c..7b09f1df 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,50 @@ MCDiscordChat - Java MCDiscordChat(简称为 MCDC),一个基于 Java 和 Fabric 的 Minecraft <-> Discord 跨服聊天工具。 +MCDiscordChat (abbreviated as MCDC) is a Java and Fabric-based Minecraft <-> Discord chat bridge. It is a functional supplement and enhancement of the [BRForgers/DisFabric](https://github.com/BRForgers/DisFabric) chat bridge. -查看更多介绍 + 使用文档:[博客一周年啦!MCDiscordChat 发布 | Xujiayao's Blog](https://blog.xujiayao.top/posts/4ba0a17a/) +查看更多介绍 + 使用文档:https://blog.xujiayao.top/posts/4ba0a17a/ +Visit for more information and user documentation (the website is only in Chinese, please translate it by yourself): -A big thanks to [BRForgers/DisFabric](https://github.com/BRForgers/DisFabric) for the original source code, which was -licensed under the Mozilla Public License 2.0 (MPL-2.0). \ No newline at end of file +非常感谢 [BRForgers/DisFabric](https://github.com/BRForgers/DisFabric) 的原始源代码,该项目使用 Mozilla Public License 2.0 (MPL-2.0) 开源协议许可开源。 +A big thanks to [BRForgers/DisFabric](https://github.com/BRForgers/DisFabric) for the original source code, which was licensed under the Mozilla Public License 2.0 (MPL-2.0). + +## Features 功能特色 + +- Minecraft <-> Discord cross server chat +- Support Discord Webhook function +- Support in-game Markdown parsing +- Support using Discord default and server emoji in the game +- Support in-game mentions (@) Discord users +- Support multiple languages (Chinese / English) +- Support multi-server operation on the same Discord channel +- Remotely execute server console commands through Discord +- Can query player leaderboards of a certain statistic information through Discord +- Can Query server operating status through Discord +- Notify when a player dies +- Notify when a player join / leave the server +- Notify when a player has reached a progress / achieved a goal / completed a challenge +- Customizable in-game message display format +- The blacklist can be used to prohibit the processing of a player or user's message +- The admin list can be used to configure the user's authority to use certain commands +- Support Hot Reloading of the configuration file +- Check for updates + +- Minecraft <-> Discord 跨服聊天 +- 支持 Discord Webhook 功能 +- 支持游戏内 Markdown 解析 +- 支持在游戏内使用 Discord 默认和服务器表情符号 +- 支持游戏内提及 (@) Discord 用户 +- 支持多语言(中文 / 英文) +- 支持同 Discord 频道多服务器运行 +- 可通过 Discord 远程执行服务器控制台指令 +- 可通过 Discord 查询某项统计信息的玩家排行榜 +- 可通过 Discord 查询服务器运行状态 +- 在玩家死亡时发出通知 +- 在玩家加入 / 离开服务器时发出通知 +- 在玩家达成进度 / 达成目标 / 完成挑战时发出通知 +- 可自定义游戏内消息显示格式 +- 可使用黑名单禁止处理某位玩家或用户的消息 +- 可使用管理员名单配置用户使用某些命令的权限 +- 支持配置文件热重载 +- 检查更新 \ No newline at end of file