koishi-plugin-chatluna-toolbox 0.0.17 → 0.0.18

package/README.md

@@ -3,7 +3,7 @@
 为 ChatLuna 提供可组合的工具能力，当前包含三类功能：
 
 - 原生工具（Native Tools）
-- XML 工具（XML Actions）
+- Character XML 工具（XML Actions）
 - 变量扩展（Variables）
 
 插件目标是把常用的群聊动作能力（如戳一戳、消息表情、撤回消息）和上下文变量能力拆分为可配置模块，便于在 Koishi + ChatLuna 场景中按需启用。
@@ -21,7 +21,7 @@
 
 QQ 头像工具会把 HTTP/HTTPS 图片先转为 OneBot `base64://` 文件再提交，避免 OneBot 端无法访问 Koishi 临时图片地址。
 
-### 2) XML 工具
+### 2) Character XML 工具
 支持从模型输出中解析 XML 动作标签并执行：
 
 - `<poke id="..."/>`
@@ -49,11 +49,11 @@ QQ 头像工具会把 HTTP/HTTPS 图片先转为 OneBot `base64://` 文件再提
 
 - 开启一个 OneBot 协议（NapCat 或 LLBot）
 - 按需开启原生工具
-- 按需开启 XML 工具
+- 按需开启 Character XML 工具
 - 按需配置变量项
 
 ### 3. 配置 XML 参考提示词
-在 `XML 工具` 分组中找到 `参考提示词`，可直接使用默认模板，或根据你的 Bot 规则进行调整。
+在 `Character XML 工具` 分组中找到 `参考提示词`，可直接使用默认模板，或根据你的 Bot 规则进行调整。
 
 ### 4. 构建
 

package/client/constants.ts

@@ -8,8 +8,8 @@ import type { SharedNavSection } from "shared-nav";
 export const NAV_SECTIONS: SharedNavSection[] = [
   { title: "基础设置", key: "basic" },
   { title: "原生工具", key: "nativeTools" },
-  { title: "XML 工具", key: "xmlTools" },
-  { title: "其他变量", key: "variables" },
+  { title: "Character XML 工具", key: "xmlTools" },
+  { title: "变量", key: "variables" },
   { title: "其他设置", key: "other" },
 ];
 

package/dist/index.js

@@ -234,8 +234,8 @@ const st = /* @__PURE__ */ b({
 }, gt = /* @__PURE__ */ M(st, [["__cssModules", ht]]), pt = [
   { title: "基础设置", key: "basic" },
   { title: "原生工具", key: "nativeTools" },
-  { title: "XML 工具", key: "xmlTools" },
-  { title: "其他变量", key: "variables" },
+  { title: "Character XML 工具", key: "xmlTools" },
+  { title: "变量", key: "variables" },
   { title: "其他设置", key: "other" }
 ], mt = [
   "chatluna-toolbox",

package/lib/index.js

@@ -447,7 +447,8 @@ __export(index_exports, {
   sendSetGroupCard: () => sendSetGroupCard,
   sendSetGroupSpecialTitle: () => sendSetGroupSpecialTitle,
   sendSetProfile: () => sendSetProfile,
-  sendSetQQAvatar: () => sendSetQQAvatar
+  sendSetQQAvatar: () => sendSetQQAvatar,
+  usage: () => usage
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -477,95 +478,68 @@ var DEFAULT_SET_MSG_EMOJI_TOOL_DESCRIPTION = "\u5BF9\u6307\u5B9A\u6D88\u606F\u6D
 var DEFAULT_DELETE_MESSAGE_TOOL_DESCRIPTION = "\u6839\u636E\u6D88\u606F ID \u64A4\u56DE\u6307\u5B9A\u6D88\u606F\u3002";
 
 // src/schema/native-tools.ts
-var NativeToolsSchema = import_koishi2.Schema.object({
+var EnabledNativeToolsSchema = import_koishi2.Schema.array(
+  import_koishi2.Schema.union([
+    import_koishi2.Schema.const("poke").description("\u6233\u4E00\u6233"),
+    import_koishi2.Schema.const("setSelfProfile").description("\u4FEE\u6539\u81EA\u8EAB\u8D26\u6237\u4FE1\u606F"),
+    import_koishi2.Schema.const("setQQAvatar").description("\u4FEE\u6539 QQ \u5934\u50CF"),
+    import_koishi2.Schema.const("setGroupCard").description("\u4FEE\u6539\u7FA4\u6210\u5458\u6635\u79F0"),
+    import_koishi2.Schema.const("setGroupBan").description("\u7981\u8A00\u7FA4\u6210\u5458"),
+    import_koishi2.Schema.const("setGroupSpecialTitle").description("\u4FEE\u6539\u7FA4\u6210\u5458\u4E13\u5C5E\u5934\u8854"),
+    import_koishi2.Schema.const("setMsgEmoji").description("\u6D88\u606F\u8868\u60C5"),
+    import_koishi2.Schema.const("deleteMessage").description("\u64A4\u56DE\u6D88\u606F")
+  ])
+).role("checkbox").extra("default", void 0).description(
+  "\u9009\u62E9\u8981\u6CE8\u518C\u5230 ChatLuna \u7684\u539F\u751F\u5DE5\u5177\uFF0C\u5DE5\u5177\u540D\u79F0\u548C\u63CF\u8FF0\u901A\u5E38\u65E0\u9700\u4FEE\u6539\uFF0C\u53EF\u5728\u4E0B\u65B9\u9AD8\u7EA7\u8BBE\u7F6E\u4E2D\u8C03\u6574"
+);
+var NativeToolAdvancedSettingsSchema = import_koishi2.Schema.object({
   poke: import_koishi2.Schema.object({
-    enabled: import_koishi2.Schema.boolean().default(false).description(`\u6CE8\u518C ChatLuna \u539F\u751F\u5DE5\u5177\uFF1A\u6233\u4E00\u6233\uFF0C\u4E0E**XML \u6233\u4E00\u6233\u8C03\u7528**\u4E8C\u9009\u4E00`),
+    enabled: import_koishi2.Schema.boolean().default(false).hidden(),
     toolName: import_koishi2.Schema.string().default("poke_user").description("\u5DE5\u5177\u540D\u79F0"),
     description: import_koishi2.Schema.string().default(DEFAULT_POKE_TOOL_DESCRIPTION).description("\u5DE5\u5177\u63CF\u8FF0")
   }).description("\u6233\u4E00\u6233\u5DE5\u5177").collapse(),
   setSelfProfile: import_koishi2.Schema.object({
-    enabled: import_koishi2.Schema.boolean().default(false).description(
-      `\u6CE8\u518C ChatLuna \u539F\u751F\u5DE5\u5177\uFF1A\u4FEE\u6539\u81EA\u8EAB\u8D26\u6237\u4FE1\u606F\uFF0C\u652F\u6301\u6635\u79F0 / \u7B7E\u540D / \u6027\u522B`
-    ),
+    enabled: import_koishi2.Schema.boolean().default(false).hidden(),
     toolName: import_koishi2.Schema.string().default("set_self_profile").description("\u5DE5\u5177\u540D\u79F0"),
     description: import_koishi2.Schema.string().default(DEFAULT_SET_SELF_PROFILE_TOOL_DESCRIPTION).description("\u5DE5\u5177\u63CF\u8FF0")
   }).description("\u4FEE\u6539\u81EA\u8EAB\u8D26\u6237\u4FE1\u606F\u5DE5\u5177").collapse(),
   setQQAvatar: import_koishi2.Schema.object({
-    enabled: import_koishi2.Schema.boolean().default(false).description("\u6CE8\u518C ChatLuna \u539F\u751F\u5DE5\u5177\uFF1A\u4FEE\u6539\u673A\u5668\u4EBA QQ \u5934\u50CF"),
+    enabled: import_koishi2.Schema.boolean().default(false).hidden(),
     toolName: import_koishi2.Schema.string().default("set_qq_avatar").description("\u5DE5\u5177\u540D\u79F0"),
     description: import_koishi2.Schema.string().default(DEFAULT_SET_QQ_AVATAR_TOOL_DESCRIPTION).description("\u5DE5\u5177\u63CF\u8FF0")
   }).description("\u4FEE\u6539 QQ \u5934\u50CF\u5DE5\u5177").collapse(),
   setGroupCard: import_koishi2.Schema.object({
-    enabled: import_koishi2.Schema.boolean().default(false).description("\u6CE8\u518C ChatLuna \u539F\u751F\u5DE5\u5177\uFF1A\u4FEE\u6539\u7FA4\u6210\u5458\u6635\u79F0"),
+    enabled: import_koishi2.Schema.boolean().default(false).hidden(),
     toolName: import_koishi2.Schema.string().default("set_group_card").description("\u5DE5\u5177\u540D\u79F0"),
     description: import_koishi2.Schema.string().default(DEFAULT_SET_GROUP_CARD_TOOL_DESCRIPTION).description("\u5DE5\u5177\u63CF\u8FF0")
   }).description("\u4FEE\u6539\u7FA4\u6210\u5458\u6635\u79F0\u5DE5\u5177").collapse(),
   setGroupBan: import_koishi2.Schema.object({
-    enabled: import_koishi2.Schema.boolean().default(false).description("\u6CE8\u518C ChatLuna \u539F\u751F\u5DE5\u5177\uFF1A\u7981\u8A00\u7FA4\u6210\u5458"),
+    enabled: import_koishi2.Schema.boolean().default(false).hidden(),
     toolName: import_koishi2.Schema.string().default("set_group_ban").description("\u5DE5\u5177\u540D\u79F0"),
     description: import_koishi2.Schema.string().default(DEFAULT_SET_GROUP_BAN_TOOL_DESCRIPTION).description("\u5DE5\u5177\u63CF\u8FF0")
   }).description("\u7981\u8A00\u5DE5\u5177").collapse(),
   setGroupSpecialTitle: import_koishi2.Schema.object({
-    enabled: import_koishi2.Schema.boolean().default(false).description("\u6CE8\u518C ChatLuna \u539F\u751F\u5DE5\u5177\uFF1A\u4FEE\u6539\u7FA4\u6210\u5458\u4E13\u5C5E\u5934\u8854"),
+    enabled: import_koishi2.Schema.boolean().default(false).hidden(),
     toolName: import_koishi2.Schema.string().default("set_group_special_title").description("\u5DE5\u5177\u540D\u79F0"),
     description: import_koishi2.Schema.string().default(DEFAULT_SET_GROUP_SPECIAL_TITLE_TOOL_DESCRIPTION).description("\u5DE5\u5177\u63CF\u8FF0")
   }).description("\u4FEE\u6539\u7FA4\u6210\u5458\u4E13\u5C5E\u5934\u8854\u5DE5\u5177").collapse(),
   setMsgEmoji: import_koishi2.Schema.object({
-    enabled: import_koishi2.Schema.boolean().default(false).description(
-      `\u6CE8\u518C ChatLuna \u539F\u751F\u5DE5\u5177\uFF1A\u7ED9\u6D88\u606F\u6DFB\u52A0\u8868\u60C5\uFF0C\u9700\`chatluna-character\`\u5F00\u542F\`enableMessageId\`\uFF0C\u4E0E**XML \u8868\u60C5\u56DE\u5E94\u8C03\u7528**\u4E8C\u9009\u4E00\uFF0C\u70B9\u51FB\u67E5\u770B[\u8868\u60C5\u5BF9\u7167\u8868](https://bot.q.qq.com/wiki/develop/pythonsdk/model/emoji.html)`
-    ),
+    enabled: import_koishi2.Schema.boolean().default(false).hidden(),
     toolName: import_koishi2.Schema.string().default("set_msg_emoji").description("\u5DE5\u5177\u540D\u79F0"),
     description: import_koishi2.Schema.string().default(DEFAULT_SET_MSG_EMOJI_TOOL_DESCRIPTION).description("\u5DE5\u5177\u63CF\u8FF0")
   }).description("\u6D88\u606F\u8868\u60C5\u5DE5\u5177").collapse(),
   deleteMessage: import_koishi2.Schema.object({
-    enabled: import_koishi2.Schema.boolean().default(false).description(
-      `\u6CE8\u518C ChatLuna \u539F\u751F\u5DE5\u5177\uFF1A\u64A4\u56DE\u6D88\u606F\uFF0C\u9700\`chatluna-character\`\u5F00\u542F\`enableMessageId\`\uFF0C\u4E0E**XML \u6D88\u606F\u64A4\u56DE\u8C03\u7528**\u4E8C\u9009\u4E00`
-    ),
+    enabled: import_koishi2.Schema.boolean().default(false).hidden(),
     toolName: import_koishi2.Schema.string().default("delete_msg").description("\u5DE5\u5177\u540D\u79F0"),
     description: import_koishi2.Schema.string().default(DEFAULT_DELETE_MESSAGE_TOOL_DESCRIPTION).description("\u5DE5\u5177\u63CF\u8FF0")
   }).description("\u64A4\u56DE\u6D88\u606F\u5DE5\u5177").collapse()
-}).default({
-  poke: {
-    enabled: false,
-    toolName: "poke_user",
-    description: DEFAULT_POKE_TOOL_DESCRIPTION
-  },
-  setSelfProfile: {
-    enabled: false,
-    toolName: "set_self_profile",
-    description: DEFAULT_SET_SELF_PROFILE_TOOL_DESCRIPTION
-  },
-  setQQAvatar: {
-    enabled: false,
-    toolName: "set_qq_avatar",
-    description: DEFAULT_SET_QQ_AVATAR_TOOL_DESCRIPTION
-  },
-  setGroupCard: {
-    enabled: false,
-    toolName: "set_group_card",
-    description: DEFAULT_SET_GROUP_CARD_TOOL_DESCRIPTION
-  },
-  setGroupBan: {
-    enabled: false,
-    toolName: "set_group_ban",
-    description: DEFAULT_SET_GROUP_BAN_TOOL_DESCRIPTION
-  },
-  setGroupSpecialTitle: {
-    enabled: false,
-    toolName: "set_group_special_title",
-    description: DEFAULT_SET_GROUP_SPECIAL_TITLE_TOOL_DESCRIPTION
-  },
-  setMsgEmoji: {
-    enabled: false,
-    toolName: "set_msg_emoji",
-    description: DEFAULT_SET_MSG_EMOJI_TOOL_DESCRIPTION
-  },
-  deleteMessage: {
-    enabled: false,
-    toolName: "delete_msg",
-    description: DEFAULT_DELETE_MESSAGE_TOOL_DESCRIPTION
-  }
-}).description("\u539F\u751F\u5DE5\u5177");
+}).description("\u9AD8\u7EA7\u8BBE\u7F6E").collapse();
+var NativeToolsSchema = import_koishi2.Schema.intersect([
+  import_koishi2.Schema.object({
+    enabledNativeTools: EnabledNativeToolsSchema
+  }).description(""),
+  NativeToolAdvancedSettingsSchema
+]).description("\u539F\u751F\u5DE5\u5177");
 
 // src/schema/xml-tools.ts
 var import_koishi3 = require("koishi");
@@ -620,7 +594,7 @@ var XmlToolsSchema = import_koishi3.Schema.object({
     `\u542F\u7528 XML \u7FA4\u6210\u5458\u7981\u8A00\u8C03\u7528\uFF0C\u4E0E**\u7981\u8A00\u5DE5\u5177**\u4E8C\u9009\u4E00`
   ),
   referencePrompt: import_koishi3.Schema.string().role("textarea").default(DEFAULT_XML_REFERENCE_PROMPT).description("\u6A21\u578B\u56DE\u590D XML \u53C2\u8003\u63D0\u793A\u8BCD\u3002\u81EA\u884C\u5199\u5165\u63D0\u793A\u8BCD\u4E2D\uFF0C\u4E0D\u4F1A\u81EA\u52A8\u6CE8\u5165\uFF1B\u82E5\u5F00\u542F\u201C\u5C06 XML \u5DE5\u5177\u6CE8\u5165\u5B9E\u9A8C\u6027[\u5DE5\u5177\u8C03\u7528\u56DE\u590D](https://chatluna.chat/ecosystem/other/character.html#%E9%A2%84%E8%AE%BE)\u7684\u53C2\u6570\u4E2D\u201D\uFF0C\u5219\u65E0\u9700\u589E\u52A0\u989D\u5916\u63D0\u793A\u8BCD")
-}).description("XML \u5DE5\u5177");
+}).description("Character XML \u5DE5\u5177");
 
 // src/schema/variables.ts
 var import_koishi4 = require("koishi");
@@ -716,7 +690,7 @@ var VariablesSchema = import_koishi4.Schema.object({
   },
   groupShutList: { variableName: "groupShutList" },
   random: { variableName: "random", min: 0, max: 100 }
-}).description("\u5176\u4ED6\u53D8\u91CF");
+}).description("\u53D8\u91CF");
 
 // src/schema/index.ts
 var OtherSettingsSchema = import_koishi5.Schema.object({
@@ -1325,12 +1299,18 @@ function resolveToolDescription(value, fallback) {
   const trimmedValue = value.trim();
   return trimmedValue || fallback;
 }
+function isNativeToolEnabled(config, toolKey) {
+  if (config.enabledNativeTools) {
+    return config.enabledNativeTools.includes(toolKey);
+  }
+  return config[toolKey].enabled ?? false;
+}
 function resolveOneBotProtocol(config, log) {
   return config.oneBotProtocol;
 }
 function registerNativeTools(deps) {
   const { ctx, config, plugin, protocol, log } = deps;
-  if (config.poke.enabled) {
+  if (isNativeToolEnabled(config, "poke")) {
     const toolName = resolveToolName(config.poke.toolName, "poke_user");
     const description = resolveToolDescription(
       config.poke.description,
@@ -1345,7 +1325,7 @@ function registerNativeTools(deps) {
     });
     log?.("info", `\u6233\u4E00\u6233\u5DE5\u5177\u5DF2\u6CE8\u518C: ${toolName}`);
   }
-  if (config.setSelfProfile.enabled) {
+  if (isNativeToolEnabled(config, "setSelfProfile")) {
     const toolName = resolveToolName(
       config.setSelfProfile.toolName,
       "set_self_profile"
@@ -1363,7 +1343,7 @@ function registerNativeTools(deps) {
     });
     log?.("info", `\u8BBE\u7F6E\u8D44\u6599\u5DE5\u5177\u5DF2\u6CE8\u518C: ${toolName}`);
   }
-  if (config.setQQAvatar.enabled) {
+  if (isNativeToolEnabled(config, "setQQAvatar")) {
     const toolName = resolveToolName(
       config.setQQAvatar.toolName,
       "set_qq_avatar"
@@ -1381,7 +1361,7 @@ function registerNativeTools(deps) {
     });
     log?.("info", `QQ \u5934\u50CF\u5DE5\u5177\u5DF2\u6CE8\u518C: ${toolName}`);
   }
-  if (config.setGroupCard.enabled) {
+  if (isNativeToolEnabled(config, "setGroupCard")) {
     const toolName = resolveToolName(
       config.setGroupCard.toolName,
       "set_group_card"
@@ -1399,7 +1379,7 @@ function registerNativeTools(deps) {
     });
     log?.("info", `\u7FA4\u6635\u79F0\u5DE5\u5177\u5DF2\u6CE8\u518C: ${toolName}`);
   }
-  if (config.setGroupBan.enabled) {
+  if (isNativeToolEnabled(config, "setGroupBan")) {
     const toolName = resolveToolName(
       config.setGroupBan.toolName,
       "set_group_ban"
@@ -1417,7 +1397,7 @@ function registerNativeTools(deps) {
     });
     log?.("info", `\u7FA4\u6210\u5458\u7981\u8A00\u5DE5\u5177\u5DF2\u6CE8\u518C: ${toolName}`);
   }
-  if (config.setGroupSpecialTitle.enabled) {
+  if (isNativeToolEnabled(config, "setGroupSpecialTitle")) {
     const toolName = resolveToolName(
       config.setGroupSpecialTitle.toolName,
       "set_group_special_title"
@@ -1440,7 +1420,7 @@ function registerNativeTools(deps) {
     });
     log?.("info", `\u7FA4\u4E13\u5C5E\u5934\u8854\u5DE5\u5177\u5DF2\u6CE8\u518C: ${toolName}`);
   }
-  if (config.setMsgEmoji.enabled) {
+  if (isNativeToolEnabled(config, "setMsgEmoji")) {
     const toolName = resolveToolName(
       config.setMsgEmoji.toolName,
       "set_msg_emoji"
@@ -1458,7 +1438,7 @@ function registerNativeTools(deps) {
     });
     log?.("info", `\u6D88\u606F\u8868\u60C5\u5DE5\u5177\u5DF2\u6CE8\u518C: ${toolName}`);
   }
-  if (config.deleteMessage.enabled) {
+  if (isNativeToolEnabled(config, "deleteMessage")) {
     const toolName = resolveToolName(
       config.deleteMessage.toolName,
       "delete_msg"
@@ -2824,7 +2804,7 @@ function apply(ctx, config) {
     registerNativeTools({ ctx, config, plugin, protocol, log });
     xmlRuntime = enableXmlRuntime ? registerXmlTools({ ctx, config, protocol, log }) : null;
     if (characterCtx && xmlRuntime?.start()) {
-      log("info", "XML \u5DE5\u5177\u5DF2\u542F\u7528");
+      log("info", "Character XML \u5DE5\u5177\u5DF2\u542F\u7528");
     }
     log("info", "toolbox \u521D\u59CB\u5316\u5B8C\u6210");
   };
@@ -2853,7 +2833,7 @@ function apply(ctx, config) {
       });
       if (!xmlRuntime) return;
       const started = xmlRuntime.start();
-      if (started) log("info", "XML \u5DE5\u5177\u5DF2\u542F\u7528");
+      if (started) log("info", "Character XML \u5DE5\u5177\u5DF2\u542F\u7528");
     });
   }
   ctx.on("dispose", dispose);
@@ -2865,6 +2845,15 @@ function apply(ctx, config) {
     });
   }
 }
+
+// src/index.ts
+var usage = `
+## \u4F7F\u7528\u8BF4\u660E
+
+Character XML \u5DE5\u5177\u4EC5\u4F9B [koishi-plugin-chatluna-character](https://github.com/ChatLunaLab/chatluna-character) \u4F7F\u7528\uFF1B\u5982\u679C\u4F60\u53EA\u5B89\u88C5\u4E86 ChatLuna \u4E3B\u63D2\u4EF6\uFF0C\u8BF7\u4E0D\u8981\u5F00\u542F\u8FD9\u4E00\u9879\u3002
+
+\u5982\u679C\u4F60\u4E0D\u786E\u5B9A\u5F53\u524D\u73AF\u5883\u662F\u5426\u9700\u8981\u8FD9\u7EC4\u80FD\u529B\uFF0C\u4F18\u5148\u4FDD\u6301\u5173\u95ED\uFF0C\u6309 README \u7684\u8BF4\u660E\u9010\u9879\u542F\u7528\u5373\u53EF\u3002
+`;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   BasicSettingsSchema,
@@ -2912,5 +2901,6 @@ function apply(ctx, config) {
   sendSetGroupCard,
   sendSetGroupSpecialTitle,
   sendSetProfile,
-  sendSetQQAvatar
+  sendSetQQAvatar,
+  usage
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "koishi-plugin-chatluna-toolbox",
-  "description": "为 ChatLuna 提供更多原生工具、XML 工具与变量，仅支持 onebot 平台。",
-  "version": "0.0.17",
+  "description": "为 ChatLuna 提供更多原生工具、Character XML 工具与变量，仅支持 onebot 平台。",
+  "version": "0.0.18",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [