MinecraftQueqiao

MinecraftQueqiao 0.1.0

基于 gsuid_core 和鹊桥的 minecraft 连接插件

安装文档 (gscore)   ·   安装文档 (QueQiao)   ·   gsuid_core

丨注意

Caution

反向 Websocket 早期测试！建议优先使用正向模式。

丨安装提醒

注意：该插件为 早柚核心(gsuid_core) 的扩展，具体安装方式可参考上方安装文档

运行环境要求 Python 3.12+

🚧 项目快速迭代中 🚧

丨绑定 / 使用教程

1. 前往 Modrinth 或 CurseForge 下载并安装服务端对应的 插件/Mod。

2. 配置 config.yml 中的 websocket_server

```yaml
websocket_server:
  enable: true          # 是否启用
  host: "0.0.0.0"     # WebSocket Server 地址
  port: 8080            # WebSocket Server 端口
```

• 插件端配置文件位于 ./plugin/QueQiao/config.yml。
• 模组端配置文件位于 ./config/QueQiao/config.yml。

3. 启动服务器，等待开启 Websocket Server

4. 在 Gscore 中安装本插件

• 方法一：从 Gscore 网页控制台安装：网页控制台 -> 插件商城 -> 从 URL 安装
• 方法二：手动安装：下载此MinecraftQueqiao文件夹，并放置在gsuid_core/plugins/目录下。

5. 在网页控制台中绑定服务器

1. 访问 Gscore 网页控制台 -> 数据库管理 -> MinecraftQueqiao -> 鹊桥添加服务器 -> 新增
2. 填入服务器相关信息

数据库配置项介绍：

• 序号: 自增数字，正常情况无需改动
• 是否启用: 是否启用该服务器
• WebSocket地址: 鹊桥 WebSocket Server 地址
• 服务器内部名称: 鹊桥配置文件中的服务器内部名称
• 服务器外显名称: 用户在使用 mc查看 等指令时显示的服务器名称
• 服务器外显域名: 用户在使用 mc查看 等指令时显示的服务器地址
• access_token (选填): 鹊桥的 access_token
• 鹊桥版本 (v1/v2): 鹊桥的版本; v1: 鹊桥版本<=v0.2.7, v2: 鹊桥版本>=v0.2.11
• 支持聊天框图片显示(ChatImage) MOD: 如果服务端和客户端有ChatImage MOD 则可开启
• MC -> 群聊 是否显示服务器名称: 开启后触发事件推送会在消息前加上服务器名称如 [香草纪元] sssysy 退出了游戏
• 是否开启 RCON: 需要鹊桥开启 RCON
• RCON 地址: RCON 服务器地址
• RCON 端口: RCON 服务器端口
• RCON 密码: RCON 服务器密码
• WS模式: ws连接模式，可填入 client 或 server

3. 重启 Gscore / 执行 mc刷新ws连接 命令

6. 在网页控制台开启相关事件订阅

• 访问 Gscore 网页控制台 -> 插件配置 -> MinecraftQueqiao -> 订阅事件

丨其他

• 本项目仅供学习使用，请勿用于商业用途
• GPL-3.0 License
• QueQiao Wiki

致谢

• Wuyi 无疑
• gsuid_core
• 鹊桥