脚本库

提示

请务必先阅读如何正确使用酒馆助手

脚本库是酒馆助手的核心功能之一，用于管理和执行自动化脚本，前身为全局脚本，现在具有更完整的管理和编辑功能。

全局/局部脚本库

脚本库分为全局脚本库和局部脚本库两个部分

其中:

• 全局脚本库：适用于酒馆所有聊天
• 局部脚本库：适用于当前角色卡，会随角色卡一同导出

功能按钮：

• 开关：控制脚本的运行
• 信息：查看脚本作者编写的脚本说明
• 编辑：修改脚本内容
• 移动：移动到另一作用范围的脚本库
• 导出：导出脚本配置
• 删除：移除脚本
• 批量操作：批量对脚本进行导出、删除、移动到文件夹等操作

脚本组

脚本组可用于将多个脚本集中到一个组里，方便管理和执行。

脚本组功能

• 批量导出文件夹内的脚本为zip压缩文件，导入时可直接选择zip文件导入，会保持原有的脚本组结构
• 批量开关脚本组内所有脚本
• 自定义组的图标和颜色

脚本编辑

脚本内容

• 使用 JavaScript 编写具体的脚本逻辑
• 支持完整的 JavaScript 语法
• 可以调用酒馆助手提供的 API 和功能，参考功能详情部分

提示

• 脚本可以直接使用 jQuery 的 $ 符号控制 SillyTavern 主界面的 DOM 元素
• 可以直接使用的库可在内置第三方库中查看，无需重复安装
• 如果要在脚本关闭时执行功能，请使用 $('pagehide',()=>{})

作者备注

• 可以添加脚本的说明文档
• 支持简单的 markdown 和 html 格式
• 建议包含以下信息：
  1. 脚本功能说明
  2. 使用方法
  3. 版本信息
  4. 更新记录
  5. 注意事项

变量列表

为当前脚本绑定变量，可以随着脚本一同导出，也可在导出时清空防止敏感信息泄露。

按键绑定

可以为脚本添加多个按键绑定，当按下按键时，会触发脚本内指定功能运行。

按键绑定的UI说明

• 拖动控件：对按键的顺序进行调整
• 复选框：是否显示按键
• 输入框：按键上显示的名称
• 删除按钮：删除按键

绑定方法

按键绑定功能需要配合 getButtonEvent 使用，在脚本中添加以下代码：

eventOn(getButtonEvent('按钮名称'), () => {
  // 在这里编写按键触发后的具体逻辑
  console.log('按键被点击');
});

注意

button_name 需要与设置的按键名称一致。

批量操作

点击全局/局部脚本库旁边的齿轮按钮，可以对脚本进行批量导出、删除、移动等操作。

• 批量导出：导出选中的脚本
• 批量删除：删除选中的脚本
• 批量移动：移动选中的脚本到某个文件夹

内置脚本库

扩展内置的脚本，可直接添加到脚本库中使用。