mioku-plugin-terraria 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Mioku Lab
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,37 @@
1
+ # mioku-plugin-terraria
2
+
3
+ 为 Mioku 提供 Terraria(TShock)服务器与 QQ 群消息互通能力,使用 [TianSuo](https://github.com/17TheWord/QueQiao) 协议(JSON over WebSocket)。
4
+
5
+ ## 功能特性
6
+
7
+ - **消息双向同步**:QQ 群消息广播到 Terraria 服务器,Terraria 服务器内玩家聊天、加入、退出、死亡事件推送到群聊
8
+ - **RCON 命令执行**:在群聊中以命令前缀(默认 `$`)开头的消息会被当作服务器命令执行,支持白名单
9
+ - **多服务器支持**:可同时连接多台 Terraria 服务器,每台独立配置
10
+ - **自动重连**:连接断开后按指数退避自动重连,可配置最大重试次数
11
+
12
+ ## 服务器端要求
13
+
14
+ Terraria 服务器需安装 [TianSuo](https://github.com/17TheWord/QueQiao) TShock 插件
15
+
16
+ ```bash
17
+ bun install
18
+ ```
19
+
20
+ ## 配置
21
+
22
+ 通过 WebUI 配置页面管理
23
+
24
+ ## 命令
25
+
26
+ | 命令 | 描述 | 权限 |
27
+ |--------------------------|--------------------------|-----|
28
+ | `/ts 状态` | 查看所有服务器的 WebSocket 连接状态 | 主人 |
29
+ | `/ts 开启同步 <服务器名称>` | 开启指定服务器的群聊消息同步 | 主人 |
30
+ | `/ts 关闭同步 <服务器名称>` | 关闭指定服务器的群聊消息同步 | 主人 |
31
+ | `/ts 重连` | 断开并重新建立所有服务器的 WebSocket 连接 | 主人 |
32
+
33
+ ## 鸣谢
34
+
35
+ - [TianSuo](https://github.com/17TheWord/QueQiao):Terraria WebSocket 桥
36
+ - [TShock](https://github.com/TShock/TShock) 与 [Pryaxis](https://github.com/Pryaxis):Terraria 服务端框架与插件 API
37
+ - [Re-Logic](https://www.terraria.org/):Terraria
package/config.md ADDED
@@ -0,0 +1,87 @@
1
+ ---
2
+ title: Terraria 插件配置
3
+ description: 配置 Terraria 服务器连接、消息同步与 RCON 命令白名单
4
+ fields:
5
+ - key: base.say_way
6
+ label: 聊天前缀
7
+ type: text
8
+ description: QQ 消息转发到 Terraria 时显示的前缀,默认 "说:"
9
+ placeholder: 说:
10
+
11
+ - key: base.display_server_name
12
+ label: 显示服务器名称
13
+ type: switch
14
+ description: 消息中是否显示服务器名称
15
+
16
+ - key: base.servers
17
+ label: 服务器列表
18
+ type: array
19
+ description: 配置多个 Terraria 服务器连接(TianSuo 协议)
20
+ itemFields:
21
+ - key: server_name
22
+ label: 服务器名称
23
+ type: text
24
+ description: 与 TianSuo 配置中 ServerName 一致(也是握手时 x-self-name 头的值)
25
+ placeholder: main
26
+
27
+ - key: host
28
+ label: 服务器地址
29
+ type: text
30
+ description: TianSuo 所在主机地址
31
+ placeholder: 127.0.0.1
32
+
33
+ - key: port
34
+ label: 服务器端口
35
+ type: number
36
+ description: TianSuo WebSocket 监听端口
37
+ placeholder: 8080
38
+
39
+ - key: access_token
40
+ label: 访问令牌
41
+ type: secret
42
+ description: 与 TianSuo 配置中 AccessToken 一致(若 TianSuo 启用则必填)
43
+
44
+ - key: reconnect_max_attempts
45
+ label: 最大重连次数
46
+ type: number
47
+ description: 断线后最大重连次数,0 表示无限
48
+ placeholder: 0
49
+
50
+ - key: group_list
51
+ label: 关联群聊
52
+ type: text
53
+ description: 关联的 QQ 群号
54
+
55
+ - key: bot_self_id
56
+ label: 机器人账号
57
+ type: text
58
+ description: 使用哪个机器人 QQ 号发送消息
59
+
60
+ - key: command_header
61
+ label: 命令前缀
62
+ type: text
63
+ description: RCON 命令前缀,默认 "$"
64
+ placeholder: $
65
+
66
+ - key: command_user
67
+ label: 命令用户白名单
68
+ type: textarea
69
+ description: 允许执行 RCON 命令的 QQ 号列表,每行一个
70
+
71
+ - key: rcon_command_whitelist
72
+ label: RCON 命令白名单
73
+ type: textarea
74
+ description: 允许执行的 RCON 命令列表(首词匹配),每行一条
75
+
76
+ - key: sync_enabled
77
+ label: 启用同步
78
+ type: switch
79
+ description: 是否启用消息同步
80
+ ---
81
+
82
+ ```mioku-fields
83
+ keys:
84
+ - base.say_way
85
+ - base.display_server_name
86
+ - base.servers
87
+ ```
@@ -0,0 +1,63 @@
1
+ import type { TerrariaServerConfig } from "../types";
2
+
3
+ export function parseCommand(
4
+ text: string,
5
+ serverItem: TerrariaServerConfig,
6
+ ): string | null {
7
+ const header = serverItem.command_header || "$";
8
+ const trimmed = text.trim();
9
+ if (!header || !trimmed.startsWith(header)) return null;
10
+ return trimmed.slice(header.length).trim();
11
+ }
12
+
13
+ export function isCommandAllowed(
14
+ text: string,
15
+ serverItem: TerrariaServerConfig,
16
+ isMaster: boolean,
17
+ userId: number | string | undefined,
18
+ ): boolean {
19
+ if (isMaster) return true;
20
+
21
+ const cmdName = getCommandName(text);
22
+ const whitelist = serverItem.rcon_command_whitelist || [];
23
+ if (
24
+ whitelist.some((w) => String(w).replace(/^\/+/, "") === cmdName)
25
+ ) {
26
+ return true;
27
+ }
28
+
29
+ const userList = serverItem.command_user || [];
30
+ if (userId === undefined) return false;
31
+ return userList.some((u) => String(u) === String(userId));
32
+ }
33
+
34
+ function getCommandName(text: string): string {
35
+ const trimmed = String(text).trim();
36
+ const parts = trimmed.split(/\s+/, 1);
37
+ return parts[0] || "";
38
+ }
39
+
40
+ export function formatCommandResult(raw: TerrariaCommandResult): string {
41
+ if (raw === null || raw === undefined) return "命令执行成功";
42
+
43
+ if (typeof raw === "string") {
44
+ const trimmed = raw.trim();
45
+ return trimmed || "命令执行成功";
46
+ }
47
+
48
+ if (typeof raw !== "object") return String(raw);
49
+
50
+ const success = Boolean(raw.success);
51
+ const message = String(raw.message ?? "").trim();
52
+
53
+ if (!success) {
54
+ return message || "命令执行失败";
55
+ }
56
+ return message || "命令执行成功";
57
+ }
58
+
59
+ export type TerrariaCommandResult =
60
+ | { success: boolean; message?: string }
61
+ | string
62
+ | null
63
+ | undefined;
@@ -0,0 +1,210 @@
1
+ import WebSocket from "ws";
2
+ import { PROTOCOL, type TerrariaServerConfig } from "../types";
3
+
4
+ export type ClientStatus = "connected" | "disconnected" | "connecting";
5
+
6
+ export interface TerrariaApiResponse {
7
+ success: boolean;
8
+ message?: string;
9
+ }
10
+
11
+ export interface WsClient {
12
+ serverName: string;
13
+ getStatus(): ClientStatus;
14
+ request(
15
+ name: string,
16
+ data: Record<string, unknown>,
17
+ ): Promise<TerrariaApiResponse>;
18
+ close(): void;
19
+ }
20
+
21
+ type EventHandler = (raw: {
22
+ name: string;
23
+ data: Record<string, unknown>;
24
+ }) => void;
25
+ type StatusHandler = (serverName: string, status: ClientStatus) => void;
26
+ type ErrorHandler = (serverName: string, error: Error) => void;
27
+
28
+ interface PendingRequest {
29
+ name: string;
30
+ resolve: (value: TerrariaApiResponse) => void;
31
+ reject: (err: Error) => void;
32
+ }
33
+
34
+ export function createForwardClient(
35
+ serverItem: TerrariaServerConfig,
36
+ onEvent: EventHandler,
37
+ onStatusChange: StatusHandler,
38
+ onError?: ErrorHandler,
39
+ ): WsClient {
40
+ let socket: WebSocket | null = null;
41
+ let reconnectTimer: ReturnType<typeof setTimeout> | null = null;
42
+ let reconnectAttempt = 0;
43
+ let closed = false;
44
+ let currentStatus: ClientStatus = "disconnected";
45
+ const pendingQueue: PendingRequest[] = [];
46
+
47
+ const updateStatus = (status: ClientStatus) => {
48
+ currentStatus = status;
49
+ onStatusChange(serverItem.server_name, status);
50
+ };
51
+
52
+ const flushQueueWithError = (err: Error) => {
53
+ while (pendingQueue.length > 0) {
54
+ const pending = pendingQueue.shift()!;
55
+ pending.reject(err);
56
+ }
57
+ };
58
+
59
+ const connect = () => {
60
+ if (closed) return;
61
+ if (socket) {
62
+ try {
63
+ socket.close();
64
+ } catch {}
65
+ socket = null;
66
+ }
67
+ updateStatus("connecting");
68
+
69
+ const url = buildUrl(serverItem.host, serverItem.port);
70
+ const headers: Record<string, string> = {
71
+ "x-self-name": serverItem.server_name,
72
+ };
73
+ const token = (serverItem.access_token || "").trim();
74
+ if (token) {
75
+ headers.Authorization = `Bearer ${token}`;
76
+ }
77
+
78
+ try {
79
+ socket = new WebSocket(url, { headers });
80
+ } catch (err) {
81
+ onError?.(serverItem.server_name, err as Error);
82
+ updateStatus("disconnected");
83
+ scheduleReconnect();
84
+ return;
85
+ }
86
+
87
+ socket.on("open", () => {
88
+ reconnectAttempt = 0;
89
+ updateStatus("connected");
90
+ });
91
+
92
+ socket.on("close", () => {
93
+ if (currentStatus !== "disconnected") {
94
+ updateStatus("disconnected");
95
+ }
96
+ flushQueueWithError(new Error(`服务器 ${serverItem.server_name} 连接已断开`));
97
+ scheduleReconnect();
98
+ });
99
+
100
+ socket.on("error", (err: Error) => {
101
+ onError?.(serverItem.server_name, err);
102
+ });
103
+
104
+ socket.on("message", (data: WebSocket.RawData) => {
105
+ const text = data.toString();
106
+ let parsed: { type?: string; name?: string; data?: unknown };
107
+ try {
108
+ parsed = JSON.parse(text);
109
+ } catch {
110
+ return;
111
+ }
112
+ handleEnvelope(parsed);
113
+ });
114
+ };
115
+
116
+ const handleEnvelope = (env: {
117
+ type?: string;
118
+ name?: string;
119
+ data?: unknown;
120
+ }) => {
121
+ if (!env.type || !env.name) return;
122
+
123
+ if (env.type === PROTOCOL.EVENT_TYPE) {
124
+ onEvent({
125
+ name: env.name,
126
+ data: (env.data ?? {}) as Record<string, unknown>,
127
+ });
128
+ return;
129
+ }
130
+
131
+ if (env.type === PROTOCOL.API_TYPE && env.name === PROTOCOL.API_RESPONSE) {
132
+ const pending = pendingQueue.shift();
133
+ if (!pending) return;
134
+ const result = (env.data ?? {}) as TerrariaApiResponse;
135
+ pending.resolve({
136
+ success: Boolean(result.success),
137
+ message: result.message,
138
+ });
139
+ }
140
+ };
141
+
142
+ const scheduleReconnect = () => {
143
+ if (closed) return;
144
+ if (reconnectTimer) return;
145
+ const maxAttempts = serverItem.reconnect_max_attempts ?? 0;
146
+ reconnectAttempt += 1;
147
+ if (maxAttempts > 0 && reconnectAttempt > maxAttempts) {
148
+ return;
149
+ }
150
+ const baseDelay = 10_000;
151
+ const delay = Math.min(baseDelay * reconnectAttempt, 60_000);
152
+ reconnectTimer = setTimeout(() => {
153
+ reconnectTimer = null;
154
+ connect();
155
+ }, delay);
156
+ };
157
+
158
+ const request = (
159
+ name: string,
160
+ data: Record<string, unknown>,
161
+ ): Promise<TerrariaApiResponse> => {
162
+ return new Promise<TerrariaApiResponse>((resolve, reject) => {
163
+ if (!socket || socket.readyState !== WebSocket.OPEN) {
164
+ reject(new Error(`服务器 ${serverItem.server_name} 未连接`));
165
+ return;
166
+ }
167
+ const envelope = JSON.stringify({
168
+ type: PROTOCOL.API_TYPE,
169
+ name,
170
+ data,
171
+ });
172
+ try {
173
+ socket.send(envelope);
174
+ } catch (err) {
175
+ reject(err as Error);
176
+ return;
177
+ }
178
+ pendingQueue.push({ name, resolve, reject });
179
+ });
180
+ };
181
+
182
+ const close = () => {
183
+ closed = true;
184
+ if (reconnectTimer) {
185
+ clearTimeout(reconnectTimer);
186
+ reconnectTimer = null;
187
+ }
188
+ if (socket) {
189
+ try {
190
+ socket.close();
191
+ } catch {}
192
+ socket = null;
193
+ }
194
+ flushQueueWithError(new Error(`服务器 ${serverItem.server_name} 已关闭`));
195
+ updateStatus("disconnected");
196
+ };
197
+
198
+ connect();
199
+
200
+ return {
201
+ serverName: serverItem.server_name,
202
+ getStatus: () => currentStatus,
203
+ request,
204
+ close,
205
+ };
206
+ }
207
+
208
+ function buildUrl(host: string, port: number): string {
209
+ return `ws://${host}:${port}/`;
210
+ }
@@ -0,0 +1,9 @@
1
+ import type { ServerManager } from "../utils/server-manager";
2
+
3
+ export function handleReconnect(
4
+ serverManager: ServerManager,
5
+ reply: (text: string) => Promise<void>,
6
+ ): Promise<void> {
7
+ serverManager.reconnectAll();
8
+ return reply("已发起重新连接请求");
9
+ }
@@ -0,0 +1,34 @@
1
+ import type { ServerManager } from "../utils/server-manager";
2
+ import type { TerrariaConfig } from "../types";
3
+
4
+ export async function handleStatus(
5
+ serverManager: ServerManager,
6
+ config: TerrariaConfig,
7
+ reply: (text: string) => Promise<void>,
8
+ ): Promise<void> {
9
+ if (config.servers.length === 0) {
10
+ await reply("暂无已配置的服务器");
11
+ return;
12
+ }
13
+
14
+ const statusList = serverManager.getStatusList();
15
+ const lines: string[] = [];
16
+
17
+ config.servers.forEach((server, index) => {
18
+ if (index > 0) lines.push("");
19
+
20
+ const statusObj = statusList.find((s) => s.name === server.server_name);
21
+ const wsStatus =
22
+ statusObj?.status === "connected"
23
+ ? "已连接"
24
+ : statusObj?.status === "connecting"
25
+ ? "连接中"
26
+ : "未连接";
27
+
28
+ lines.push(`服务器:${server.server_name}`);
29
+ lines.push(`WebSocket 状态:${wsStatus}`);
30
+ lines.push(`地址:${server.host}:${server.port}`);
31
+ });
32
+
33
+ await reply(lines.join("\n"));
34
+ }
@@ -0,0 +1,38 @@
1
+ import type { ConfigHandler } from "../utils/config-handler";
2
+ import type { TerrariaConfig } from "../types";
3
+
4
+ export async function handleSync(
5
+ serverName: string | undefined,
6
+ enabled: boolean,
7
+ configHandler: ConfigHandler,
8
+ config: TerrariaConfig,
9
+ reply: (text: string) => Promise<void>,
10
+ ): Promise<boolean> {
11
+ if (!serverName) {
12
+ if (config.servers.length === 0) {
13
+ await reply("暂无已配置的服务器");
14
+ return true;
15
+ }
16
+ const lines = config.servers.map((s) => {
17
+ const syncStatus = s.sync_enabled === false ? "已关闭" : "已开启";
18
+ return `${s.server_name}: ${syncStatus}`;
19
+ });
20
+ await reply(lines.join("\n"));
21
+ return true;
22
+ }
23
+
24
+ const serverItem = configHandler.findServerByName(serverName);
25
+ if (!serverItem) {
26
+ await reply(`未找到服务器「${serverName}」`);
27
+ return true;
28
+ }
29
+
30
+ const ok = await configHandler.updateServerSync(serverName, enabled);
31
+ if (!ok) {
32
+ await reply(`更新服务器 ${serverName} 同步状态失败`);
33
+ return true;
34
+ }
35
+ const action = enabled ? "开启" : "关闭";
36
+ await reply(`${action}了服务器 ${serverName} 的同步`);
37
+ return true;
38
+ }
package/index.ts ADDED
@@ -0,0 +1,221 @@
1
+ import { definePlugin, getService, Services, type MiokiContext } from "mioku";
2
+ import { handleStatus } from "./handlers/status";
3
+ import { handleSync } from "./handlers/sync";
4
+ import { handleReconnect } from "./handlers/reconnect";
5
+ import { parseTsCommand } from "./utils/command-router";
6
+ import { createConfigHandler } from "./utils/config-handler";
7
+ import {
8
+ formatQqToTerraria,
9
+ formatTerrariaEvent,
10
+ type QqMessagePart,
11
+ } from "./utils/message-formatter";
12
+ import { createServerManager } from "./utils/server-manager";
13
+ import {
14
+ formatCommandResult,
15
+ isCommandAllowed,
16
+ parseCommand,
17
+ } from "./core/command";
18
+ import { PROTOCOL, type TerrariaConfig, type TerrariaEvent } from "./types";
19
+
20
+ export default definePlugin({
21
+ name: "terraria",
22
+ version: "1.0.0",
23
+ description: "Terraria 服务器与 QQ 群消息互通插件,基于 TianSuo 协议",
24
+
25
+ async setup(ctx: MiokiContext) {
26
+ const configService = getService(ctx, Services.Config);
27
+
28
+ const configHandler = createConfigHandler(configService);
29
+ await configHandler.register();
30
+ const config = configHandler.getConfig();
31
+
32
+ const serverManager = createServerManager({
33
+ onStatusChange: (serverName, status) => {
34
+ ctx.logger.info(`[Terraria] 服务器 ${serverName} 状态: ${status}`);
35
+ },
36
+ onEvent: (raw) => {
37
+ handleTerrariaEvent(ctx, raw, config, configHandler);
38
+ },
39
+ logger: { error: (msg) => ctx.logger.error(msg) },
40
+ });
41
+
42
+ serverManager.startServers(config);
43
+ ctx.logger.info("Terraria 插件已就绪");
44
+
45
+ ctx.handle("message", async (event) => {
46
+ const text = ctx.text(event).trim();
47
+ const groupId =
48
+ "group_id" in event && typeof event.group_id === "number"
49
+ ? event.group_id
50
+ : undefined;
51
+
52
+ const parsed = parseTsCommand(text);
53
+ if (parsed) {
54
+ if (!groupId) return;
55
+
56
+ switch (parsed.action) {
57
+ case "状态": {
58
+ await handleStatus(serverManager, config, async (msg) => {
59
+ await event.reply(msg);
60
+ });
61
+ return;
62
+ }
63
+ case "开启同步": {
64
+ const serverName = parsed.args[0];
65
+ await handleSync(
66
+ serverName,
67
+ true,
68
+ configHandler,
69
+ config,
70
+ async (msg) => {
71
+ await event.reply(msg);
72
+ },
73
+ );
74
+ return;
75
+ }
76
+ case "关闭同步": {
77
+ const serverName = parsed.args[0];
78
+ await handleSync(
79
+ serverName,
80
+ false,
81
+ configHandler,
82
+ config,
83
+ async (msg) => {
84
+ await event.reply(msg);
85
+ },
86
+ );
87
+ return;
88
+ }
89
+ case "重连": {
90
+ if (ctx.isOwner?.(event)) {
91
+ await handleReconnect(serverManager, async (msg) => {
92
+ await event.reply(msg);
93
+ });
94
+ }
95
+ return;
96
+ }
97
+ case "":
98
+ return;
99
+ }
100
+ return;
101
+ }
102
+
103
+ if (!groupId) return;
104
+ await forwardToTerraria(ctx, event, config, configHandler, serverManager);
105
+ });
106
+
107
+ return async () => {
108
+ serverManager.stopServers();
109
+ ctx.logger.info("Terraria 插件已卸载");
110
+ };
111
+ },
112
+ });
113
+
114
+ async function handleTerrariaEvent(
115
+ ctx: MiokiContext,
116
+ raw: { serverName: string; name: string; data: Record<string, unknown> },
117
+ config: TerrariaConfig,
118
+ configHandler: ReturnType<typeof createConfigHandler>,
119
+ ): Promise<void> {
120
+ const eventName = raw.name as TerrariaEvent["name"];
121
+ if (
122
+ eventName !== PROTOCOL.PLAYER_JOIN &&
123
+ eventName !== PROTOCOL.PLAYER_QUIT &&
124
+ eventName !== PROTOCOL.PLAYER_CHAT &&
125
+ eventName !== PROTOCOL.PLAYER_DEATH
126
+ ) {
127
+ return;
128
+ }
129
+
130
+ const data = raw.data ?? {};
131
+ const event: TerrariaEvent = {
132
+ server_name: raw.serverName,
133
+ name: eventName,
134
+ player: (data.player as TerrariaEvent["player"]) || undefined,
135
+ message: typeof data.message === "string" ? data.message : undefined,
136
+ death_message:
137
+ typeof data.death_message === "string"
138
+ ? data.death_message
139
+ : typeof data.deathMessage === "string"
140
+ ? data.deathMessage
141
+ : undefined,
142
+ };
143
+
144
+ const messageText = formatTerrariaEvent(event, config);
145
+ if (!messageText) return;
146
+
147
+ const serverItem = configHandler.findServerByName(raw.serverName);
148
+ if (!serverItem) return;
149
+ if (serverItem.sync_enabled === false) return;
150
+
151
+ const bots = serverItem.bot_self_id ? [serverItem.bot_self_id] : [];
152
+ const groups = serverItem.group_list ? [serverItem.group_list] : [];
153
+
154
+ for (const botId of bots) {
155
+ const bot = ctx.pickBot(Number(botId));
156
+ if (!bot) continue;
157
+ for (const groupId of groups) {
158
+ try {
159
+ await bot.sendGroupMsg(Number(groupId), messageText);
160
+ } catch (err) {
161
+ ctx.logger.error(
162
+ `[Terraria] 发送消息到群 ${groupId} 失败: ${err}`,
163
+ );
164
+ }
165
+ }
166
+ }
167
+ }
168
+
169
+ async function forwardToTerraria(
170
+ ctx: MiokiContext,
171
+ event: any,
172
+ config: TerrariaConfig,
173
+ configHandler: ReturnType<typeof createConfigHandler>,
174
+ serverManager: ReturnType<typeof createServerManager>,
175
+ ): Promise<void> {
176
+ const text = ctx.text(event);
177
+ ctx.logger.debug(
178
+ `[Terraria] 收到群消息 group=${event.group_id} text=${text}`,
179
+ );
180
+
181
+ if (!event.group_id) return;
182
+
183
+ const servers = configHandler.getServersForGroup(event.group_id);
184
+ if (servers.length === 0) return;
185
+
186
+ const msgList: QqMessagePart[] = Array.isArray(event.message)
187
+ ? event.message
188
+ : [{ type: "text", text }];
189
+
190
+ for (const server of servers) {
191
+ if (server.sync_enabled === false) continue;
192
+
193
+ const commandText = parseCommand(text, server);
194
+ if (commandText !== null) {
195
+ const isAllowed = isCommandAllowed(
196
+ commandText,
197
+ server,
198
+ ctx.isOwner?.(event) ?? false,
199
+ event.user_id,
200
+ );
201
+ if (!isAllowed) continue;
202
+
203
+ try {
204
+ const result = await serverManager.rcon(server.server_name, commandText);
205
+ await event.reply(formatCommandResult(result));
206
+ } catch (err) {
207
+ await event.reply(`执行命令失败: ${err}`);
208
+ }
209
+ continue;
210
+ }
211
+
212
+ try {
213
+ const message = formatQqToTerraria(event.sender || {}, msgList);
214
+ await serverManager.broadcast(server.server_name, message);
215
+ } catch (err) {
216
+ ctx.logger.error(
217
+ `[Terraria] 发送到服务器 ${server.server_name} 失败: ${err}`,
218
+ );
219
+ }
220
+ }
221
+ }
package/package.json ADDED
@@ -0,0 +1,78 @@
1
+ {
2
+ "name": "mioku-plugin-terraria",
3
+ "version": "1.0.0",
4
+ "description": "Terraria 服务器与 QQ 群消息互通插件,基于 TianSuo 协议",
5
+ "main": "index.ts",
6
+ "type": "module",
7
+ "keywords": [
8
+ "mioku",
9
+ "terraria",
10
+ "tshock",
11
+ "tiansuo"
12
+ ],
13
+ "repository": {
14
+ "type": "git",
15
+ "url": "https://github.com/mioku-lab/mioku-plugin-terraria.git"
16
+ },
17
+ "mioku": {
18
+ "services": ["config"],
19
+ "accessHooks": [
20
+ {
21
+ "id": "/ts 状态",
22
+ "match": "/^\\/ts\\s*状态/"
23
+ },
24
+ {
25
+ "id": "/ts 开启同步",
26
+ "match": "/^\\/ts\\s*开启同步/"
27
+ },
28
+ {
29
+ "id": "/ts 关闭同步",
30
+ "match": "/^\\/ts\\s*关闭同步/"
31
+ },
32
+ {
33
+ "id": "/ts 重连",
34
+ "match": "/^\\/ts\\s*重连/"
35
+ }
36
+ ],
37
+ "help": {
38
+ "title": "Terraria",
39
+ "description": "Terraria 服务器与 QQ 群消息互通插件,基于 TianSuo 协议",
40
+ "commands": [
41
+ {
42
+ "cmd": "/ts 状态",
43
+ "desc": "查看所有已配置服务器的 WebSocket 连接状态",
44
+ "role": "master"
45
+ },
46
+ {
47
+ "cmd": "/ts 开启同步 <服务器名称>",
48
+ "desc": "开启指定服务器的群聊消息同步功能",
49
+ "usage": "/ts 开启同步 <服务器名称>",
50
+ "role": "master"
51
+ },
52
+ {
53
+ "cmd": "/ts 关闭同步 <服务器名称>",
54
+ "desc": "关闭指定服务器的群聊消息同步功能",
55
+ "usage": "/ts 关闭同步 <服务器名称>",
56
+ "role": "master"
57
+ },
58
+ {
59
+ "cmd": "/ts 重连",
60
+ "desc": "断开并重新建立所有服务器的 WebSocket 连接",
61
+ "role": "master"
62
+ }
63
+ ]
64
+ }
65
+ },
66
+ "dependencies": {
67
+ "ws": "^8.18.0"
68
+ },
69
+ "peerDependencies": {
70
+ "mioku": "^0.8.0",
71
+ "mioki": "^0.16.0"
72
+ },
73
+ "devDependencies": {
74
+ "mioku": "workspace:*",
75
+ "mioki": "^0.16.0",
76
+ "@types/ws": "^8.5.13"
77
+ }
78
+ }
package/types.ts ADDED
@@ -0,0 +1,107 @@
1
+ export const PROTOCOL = {
2
+ EVENT_TYPE: "event",
3
+ API_TYPE: "api",
4
+ API_RESPONSE: "api_response",
5
+
6
+ PLAYER_JOIN: "player_join",
7
+ PLAYER_QUIT: "player_quit",
8
+ PLAYER_CHAT: "player_chat",
9
+ PLAYER_DEATH: "player_death",
10
+
11
+ BROADCAST: "broadcast",
12
+ PRIVATE_MESSAGE: "private_message",
13
+ RCON_COMMAND: "rcon_command",
14
+ } as const;
15
+
16
+ export type ProtocolName = (typeof PROTOCOL)[keyof typeof PROTOCOL];
17
+
18
+ export type TerrariaEventName =
19
+ | typeof PROTOCOL.PLAYER_JOIN
20
+ | typeof PROTOCOL.PLAYER_QUIT
21
+ | typeof PROTOCOL.PLAYER_CHAT
22
+ | typeof PROTOCOL.PLAYER_DEATH;
23
+
24
+ export interface PlayerView {
25
+ name?: string;
26
+ index?: number;
27
+ group?: string;
28
+ account?: string;
29
+ uuid?: string;
30
+ ip?: string;
31
+ }
32
+
33
+ export interface TerrariaEvent {
34
+ server_name: string;
35
+ name: TerrariaEventName;
36
+ player?: PlayerView;
37
+ message?: string;
38
+ death_message?: string;
39
+ }
40
+
41
+ export interface TerrariaServerConfig {
42
+ server_name: string;
43
+ host: string;
44
+ port: number;
45
+ access_token?: string;
46
+ reconnect_max_attempts?: number;
47
+ group_list: string;
48
+ bot_self_id: string;
49
+ command_header?: string;
50
+ command_user?: string[];
51
+ rcon_command_whitelist?: string[];
52
+ sync_enabled?: boolean;
53
+ }
54
+
55
+ export interface TerrariaConfig {
56
+ servers: TerrariaServerConfig[];
57
+ say_way: string;
58
+ display_server_name: boolean;
59
+ }
60
+
61
+ export const DEFAULT_CONFIG: TerrariaConfig = {
62
+ servers: [],
63
+ say_way: "说:",
64
+ display_server_name: true,
65
+ };
66
+
67
+ export function normalizeConfig(raw: Partial<TerrariaConfig>): TerrariaConfig {
68
+ const servers = Array.isArray(raw.servers) ? raw.servers : [];
69
+ return {
70
+ servers: servers.map((s) => ({
71
+ ...s,
72
+ server_name: String(s.server_name ?? "").trim(),
73
+ host:
74
+ typeof s.host === "string" && s.host.trim()
75
+ ? s.host.trim()
76
+ : "127.0.0.1",
77
+ port: typeof s.port === "number" && s.port > 0 ? s.port : 8080,
78
+ access_token:
79
+ typeof s.access_token === "string" ? s.access_token.trim() : "",
80
+ reconnect_max_attempts:
81
+ typeof s.reconnect_max_attempts === "number"
82
+ ? s.reconnect_max_attempts
83
+ : 0,
84
+ group_list:
85
+ typeof s.group_list === "string" ? s.group_list.trim() : "",
86
+ bot_self_id:
87
+ typeof s.bot_self_id === "string" ? s.bot_self_id.trim() : "",
88
+ command_header:
89
+ typeof s.command_header === "string" && s.command_header
90
+ ? s.command_header
91
+ : "$",
92
+ command_user: Array.isArray(s.command_user)
93
+ ? s.command_user.map((u) => String(u))
94
+ : [],
95
+ rcon_command_whitelist: Array.isArray(s.rcon_command_whitelist)
96
+ ? s.rcon_command_whitelist.map((c) => String(c))
97
+ : [],
98
+ sync_enabled:
99
+ typeof s.sync_enabled === "boolean" ? s.sync_enabled : true,
100
+ })),
101
+ say_way: raw.say_way || DEFAULT_CONFIG.say_way,
102
+ display_server_name:
103
+ typeof raw.display_server_name === "boolean"
104
+ ? raw.display_server_name
105
+ : DEFAULT_CONFIG.display_server_name,
106
+ };
107
+ }
@@ -0,0 +1,21 @@
1
+ export interface ParsedCommand {
2
+ action: string;
3
+ args: string[];
4
+ raw: string;
5
+ }
6
+
7
+ export function parseTsCommand(text: string): ParsedCommand | null {
8
+ const trimmed = text.trim();
9
+ if (!trimmed.startsWith("/ts")) return null;
10
+
11
+ const remainder = trimmed.slice(3).trim();
12
+ if (!remainder) {
13
+ return { action: "", args: [], raw: "" };
14
+ }
15
+
16
+ const parts = remainder.split(/\s+/);
17
+ const action = parts[0] || "";
18
+ const args = parts.slice(1);
19
+
20
+ return { action, args, raw: remainder };
21
+ }
@@ -0,0 +1,64 @@
1
+ import type { ConfigService } from "mioku";
2
+ import {
3
+ DEFAULT_CONFIG,
4
+ normalizeConfig,
5
+ type TerrariaConfig,
6
+ type TerrariaServerConfig,
7
+ } from "../types";
8
+
9
+ export function createConfigHandler(configService: ConfigService | undefined) {
10
+ let currentConfig: TerrariaConfig = { ...DEFAULT_CONFIG };
11
+
12
+ const register = async () => {
13
+ if (!configService) return;
14
+ await configService.registerConfig("terraria", "base", DEFAULT_CONFIG);
15
+ const raw = await configService.getConfig("terraria", "base");
16
+ currentConfig = normalizeConfig(raw);
17
+ configService.onConfigChange("terraria", "base", (next) => {
18
+ currentConfig = normalizeConfig(next);
19
+ });
20
+ };
21
+
22
+ const getConfig = (): TerrariaConfig => currentConfig;
23
+
24
+ const updateServerSync = async (
25
+ serverName: string,
26
+ enabled: boolean,
27
+ ): Promise<boolean> => {
28
+ if (!configService) return false;
29
+ const exists = currentConfig.servers.some(
30
+ (s) => s.server_name === serverName,
31
+ );
32
+ if (!exists) return false;
33
+ const servers = currentConfig.servers.map((s) =>
34
+ s.server_name === serverName ? { ...s, sync_enabled: enabled } : s,
35
+ );
36
+ await configService.updateConfig("terraria", "base", { servers });
37
+ return true;
38
+ };
39
+
40
+ const findServerByName = (
41
+ serverName: string,
42
+ ): TerrariaServerConfig | null => {
43
+ return (
44
+ currentConfig.servers.find((s) => s.server_name === serverName) || null
45
+ );
46
+ };
47
+
48
+ const getServersForGroup = (
49
+ groupId: string | number,
50
+ ): TerrariaServerConfig[] => {
51
+ const gid = String(groupId);
52
+ return currentConfig.servers.filter((s) => s.group_list === gid);
53
+ };
54
+
55
+ return {
56
+ register,
57
+ getConfig,
58
+ updateServerSync,
59
+ findServerByName,
60
+ getServersForGroup,
61
+ };
62
+ }
63
+
64
+ export type ConfigHandler = ReturnType<typeof createConfigHandler>;
@@ -0,0 +1,75 @@
1
+ import { PROTOCOL, type TerrariaConfig, type TerrariaEvent } from "../types";
2
+
3
+ export function formatTerrariaEvent(
4
+ event: TerrariaEvent,
5
+ config: TerrariaConfig,
6
+ ): string | null {
7
+ const sayWord = config.say_way || "说:";
8
+ const playerName = event.player?.name || "未知玩家";
9
+ let body: string | null = null;
10
+
11
+ switch (event.name) {
12
+ case PROTOCOL.PLAYER_JOIN:
13
+ body = `${playerName} 加入了游戏`;
14
+ break;
15
+ case PROTOCOL.PLAYER_QUIT:
16
+ body = `${playerName} 退出了游戏`;
17
+ break;
18
+ case PROTOCOL.PLAYER_CHAT: {
19
+ const content = (event.message ?? "").trim();
20
+ if (content) body = `${playerName} ${sayWord} ${content}`;
21
+ break;
22
+ }
23
+ case PROTOCOL.PLAYER_DEATH: {
24
+ const text = (event.death_message ?? "").trim();
25
+ body = text ? `${playerName} ${text}` : `${playerName} 倒下了`;
26
+ break;
27
+ }
28
+ }
29
+
30
+ if (!body) return null;
31
+ if (!config.display_server_name) return body;
32
+ const name = event.server_name || "未知服务器";
33
+ return `[${name}] ${body}`;
34
+ }
35
+
36
+ export interface QqMessagePart {
37
+ type: string;
38
+ text?: string;
39
+ url?: string;
40
+ }
41
+
42
+ export interface QqSender {
43
+ nickname?: string;
44
+ card?: string;
45
+ user_id?: number | string;
46
+ }
47
+
48
+ export function formatQqToTerraria(
49
+ sender: QqSender,
50
+ messageArr: QqMessagePart[],
51
+ ): string {
52
+ const sayWord = "说:";
53
+ const nick =
54
+ sender.nickname || sender.card || String(sender.user_id ?? "未知用户");
55
+
56
+ const parts: string[] = [];
57
+ for (const msg of messageArr) {
58
+ if (msg.type === "text") {
59
+ parts.push(String(msg.text ?? ""));
60
+ } else if (msg.type === "image") {
61
+ parts.push("[图片]");
62
+ } else if (msg.type === "face") {
63
+ parts.push("[表情]");
64
+ } else if (msg.type === "at") {
65
+ parts.push(`@${String(msg.text ?? "").trim()}`);
66
+ } else if (msg.type === "reply") {
67
+ parts.push("");
68
+ } else {
69
+ parts.push(`[${msg.type}]`);
70
+ }
71
+ }
72
+
73
+ const content = parts.join("").trim();
74
+ return `${nick} ${sayWord} ${content}`.trim();
75
+ }
@@ -0,0 +1,124 @@
1
+ import {
2
+ createForwardClient,
3
+ type ClientStatus,
4
+ type WsClient,
5
+ } from "../core/ws-client";
6
+ import { PROTOCOL, type TerrariaConfig } from "../types";
7
+
8
+ export type StatusCallback = (serverName: string, status: ClientStatus) => void;
9
+ export type EventCallback = (raw: {
10
+ serverName: string;
11
+ name: string;
12
+ data: Record<string, unknown>;
13
+ }) => void;
14
+
15
+ export interface ServerManagerOptions {
16
+ onStatusChange: StatusCallback;
17
+ onEvent: EventCallback;
18
+ logger?: { error: (msg: string) => void };
19
+ }
20
+
21
+ export function createServerManager(options: ServerManagerOptions) {
22
+ const clients = new Map<string, WsClient>();
23
+ let currentConfig: TerrariaConfig | null = null;
24
+
25
+ const handleEvent = (serverName: string) =>
26
+ (raw: { name: string; data: Record<string, unknown> }) => {
27
+ options.onEvent({
28
+ serverName,
29
+ name: raw.name,
30
+ data: raw.data,
31
+ });
32
+ };
33
+
34
+ const handleError = (serverName: string, error: Error) => {
35
+ options.logger?.error(
36
+ `[Terraria] 服务器 ${serverName} 连接错误: ${error.message}`,
37
+ );
38
+ };
39
+
40
+ const stopClients = () => {
41
+ clients.forEach((client) => client.close());
42
+ clients.clear();
43
+ };
44
+
45
+ const startServers = (config: TerrariaConfig) => {
46
+ stopClients();
47
+ currentConfig = config;
48
+
49
+ for (const server of config.servers) {
50
+ if (!server.server_name) continue;
51
+ if (server.sync_enabled === false) continue;
52
+
53
+ const client = createForwardClient(
54
+ server,
55
+ handleEvent(server.server_name),
56
+ options.onStatusChange,
57
+ handleError,
58
+ );
59
+ clients.set(server.server_name, client);
60
+ }
61
+ };
62
+
63
+ const stopServers = () => {
64
+ stopClients();
65
+ currentConfig = null;
66
+ };
67
+
68
+ const reconnectAll = () => {
69
+ if (!currentConfig) return;
70
+ const config = currentConfig;
71
+ startServers(config);
72
+ };
73
+
74
+ const isServerConnected = (serverName: string) => {
75
+ return clients.get(serverName)?.getStatus() === "connected";
76
+ };
77
+
78
+ const sendToServer = (
79
+ serverName: string,
80
+ apiName: string,
81
+ data: Record<string, unknown>,
82
+ ) => {
83
+ const client = clients.get(serverName);
84
+ if (!client) {
85
+ throw new Error(`服务器 ${serverName} 未配置`);
86
+ }
87
+ return client.request(apiName, data);
88
+ };
89
+
90
+ const broadcast = (serverName: string, message: string) =>
91
+ sendToServer(serverName, PROTOCOL.BROADCAST, { message });
92
+
93
+ const privateMessage = (
94
+ serverName: string,
95
+ target: string,
96
+ message: string,
97
+ ) =>
98
+ sendToServer(serverName, PROTOCOL.PRIVATE_MESSAGE, { target, message });
99
+
100
+ const rcon = (serverName: string, command: string) =>
101
+ sendToServer(serverName, PROTOCOL.RCON_COMMAND, { command });
102
+
103
+ const getStatusList = () => {
104
+ const list: Array<{ name: string; status: ClientStatus }> = [];
105
+ clients.forEach((client, name) => {
106
+ list.push({ name, status: client.getStatus() });
107
+ });
108
+ return list;
109
+ };
110
+
111
+ return {
112
+ startServers,
113
+ stopServers,
114
+ reconnectAll,
115
+ isServerConnected,
116
+ sendToServer,
117
+ broadcast,
118
+ privateMessage,
119
+ rcon,
120
+ getStatusList,
121
+ };
122
+ }
123
+
124
+ export type ServerManager = ReturnType<typeof createServerManager>;