# @gui-chat-plugin/jinglescript 中文文档

规范地址：https://npmcn.com/package/%40gui-chat-plugin/jinglescript/

版本：1\.2\.1
npm 元数据更新时间：2026-11-09T02:46:23.093Z
中文译文更新时间：2026-11-17T18:19:57.680Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gui-chat-plugin/jinglescript
原文对照：https://npmcn.com/package/%40gui-chat-plugin/jinglescript/?lang=original
项目主页：https://github.com/receptron/jinglescript/tree/main/gui-plugin#readme
源码仓库：https://github.com/receptron/jinglescript

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：54.7 kB，18 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：vue ^3\.5\.43，jinglescript ^1\.2\.1，gui-chat-protocol ^2\.3\.0
- 首次发布：2026-10-08T22:34:21.602Z
- 最新版本发布：2026-11-09T02:46:22.898Z
- 近 30 天下载量：4606（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 20 个）

## 中文简介

用于 JingleScript 的 GUI 聊天协议插件: 管理 JingleScript 工具, 包含一个玩家视图, 用于渲染出 jingles (波形, 提示, 节拍, 注释) .

## 安装

```sh
npm install @gui-chat-plugin/jinglescript
```

也可以使用：`pnpm add @gui-chat-plugin/jinglescript`、`yarn add @gui-chat-plugin/jinglescript`、`bun add @gui-chat-plugin/jinglescript`

## README

# @ gui- chat- plugin/ 缩写

A 类 [GUI 聊天协议](https://github.com/receptron/gui-chat-protocol/blob/main/spec/GUI_CHAT_PROTOCOL.md) jingleScript 的插件 。 它提供 和MCP服务器相同的单一工具, **`manageJingleScript`** (行动) `getGuide`, (中文(简体) ), `getSchema`, (中文(简体) ), `listInstruments`, (中文(简体) ), `getInstrument`, (中文(简体) ), `checkScore`, (中文(简体) ), `renderScore`, (中文(简体) ), `composeScore`页:1 **玩家视图**(单位:千美元) 已经成功 `renderScore` 返回正弦为 `data`和风景播放它的波形, 击打网格, 命名提示( 单击一个跳到那里) 和每个音轨的音符道; 效果 : 长度( risers, whoshes) 显示为栏 。 当乐谱有歌词时,视图会显示 卡拉ok风格:正在播放的行和下行,每个音节填写作为其音符播放. 音频和音乐作为 MIDI(图书馆) `scoreToMidi`可从视图中下载; 数据还带有给出的分数。 所有其他动作都会在文本中回答LLM,并显示没有卡.

**作会作会.** `composeScore` 已经 [YUE2 双层](https://github.com/receptron/jinglescript#compose-with-yue2-optional) 写出旋律 和歌词的和弦,当它设置在主持人的机器上(`YUE2_PYTHON`;其重量为 (非商业性)。 主机服务器等待20-40 s,没有卡. 分数保存为 `jinglescript/<fileName>.json` 通过主机 `files.byPath`它的路径可以追溯到LLM 页:1 `renderScore`; 没有主机 `files.byPath` 得到的分数本身 在答案.

**单曲,用于教学.** `renderScore` 视图需要三个选项:

-   `view`数字 : `"waveform"` (违约)或 `"notation"`: 表单音乐由 [打开SheetMusicDisplay](https://opensheetmusicdisplay.org/) 从图书馆的MusicXML,带有 光标正在播放的音符和要查找的栏。 一个设定的分数 `meter`, (中文(简体) ), `key` 或者说 `pickup` 带有工作表音乐,视图提供Waveform/工作表音乐开关 MusicXML可以下载. 渲染器只有在显示工作表音乐时才会被装入.
-   `autoplay: true`:牌出现后开始打. 只有新鲜的渲染才有效 最后两分钟),只有一次:卡片在结果中记起它 `viewState`,所以一个 聊天重开或重放从不玩旧牌. 当浏览器要先点击时, 卡片 说"新闻播放听"。 在一个通过的声音主机 `isAudioPlaying`它等待着 模型对渲染的口头回答(在卡片出现后或声音出现后最多3.5 s) 然后直到声音安静了1.5秒 声音说话时暂停 重复;一旦用户点击播放,栏或提示,声音就不再暂停.
-   `autoplayDelay: n`:在卡片出现后n秒(0-30),然后自己演奏, 而不是等待答案;在任何东道主中.
-   `notifyWhenDone: true`: 当回放第一次到达尾声时, 视图发送一个聊天信息 (单位:千美元)`"<title>" finished playing (12.0 s): the user has heard it to the end.`通过主机 `sendTextMessage`,所以LLM可以继续——提问,演奏下一场练习. 还有 记在 `viewState`,所以它发送一次。 风景写着 `viewState` 结束 `onUpdateResult` 与整个结果,如主机预期.

**相声前相相相相相.** 制作一个长片,或者由NEUTRINO演唱,需要几秒钟 到几分钟。 在给视图一个运行时间的主机中(`dispatch`并告诉 `execute` 这样 `deferredAudio: true` 在这方面, `renderScore` 最多等待一秒钟的音频: 短 jingle像以前一样回来; 一个更长的一次回来作为一个 `pending` 纸牌 显示乐谱、乐道、提示、歌词和乐谱 渲染,并保持游戏禁用。 NEUTRINO一边唱歌,一边说它有多远 声音... 52%,然后是"混音...", 通过同一个发送一次。 视图通过主机发送收集完成的音频(请求) 达到相同的 `execute`,将其保存到结果中 `onUpdateResult` (所以聊天保持它), 然后再弹奏. `autoplay` 以同样的方式等待音频, 算作新鲜的何时 上面的语音规则仍然适用。 如果最终无法制作音频, 则卡片 说为什么,并且, 对于新的渲染, 告诉LLM一次。 保存的用于收集生命 服务器的内存完成后30分钟;在重启后重放的一纸牌表示它已经消失. 未设置主机 `deferredAudio` 和以前一样 拿到完成的卡片.

得分也可以作为文件传递( Name`path` 改为 `score`) (中文(简体) ). 插件读取 主办单位 `files.byPath` 能力——本文档使用的一种——所以由主机决定路径 和相对的路径。 不提供主机 `files.byPath` 改为 `manageJingleScript` 获取分数时出现错误.

-   **`"@gui-chat-plugin/jinglescript"`** (主条目,节点): `TOOL_DEFINITION`, (中文(简体) ), `pluginCore` (单位:千美元)`execute` 在主机的服务器上,在工人线条上,所以服务器继续回答. 这个 音频被嵌入为数据 URI——当ffmpeg在服务器上时的MP3,否则16位WAV——所以不 需要文件服务 .
-   **`"@gui-chat-plugin/jinglescript/vue"`** (浏览器): `plugin` 与 `viewComponent` 财务报告和审定财务报表 `previewComponent`它不装入库中. `opensheetmusicdisplay` 属于 主机的捆绑器解析( 它没有被捆绑), 按要求加载 .

## 添加到 Mulmo Terminal 中

库是一个对等依赖(主机的服务器运行工具),所以一个主机同时安装:

1.  `yarn add jinglescript @gui-chat-plugin/jinglescript`
2.  `plugins/plugins.json`: 添加 `"@gui-chat-plugin/jinglescript"` 改为 `packages`。 。 。 .
3.  `src/plugins-registry.ts`: 导入 `plugin` 从 `@gui-chat-plugin/jinglescript/vue` 联 合 国 `style.css?inline`,并添加一个 `PACKAGES` 输入。 为了在长篇小说录音之前展示卡片, 在运行时提供者中将视图相接 —— `wrapWithPluginRuntime("jinglescript", plugin.toolDefinition.name, viewOf(...))` 和关于 服务器添加 `manageJingleScript: { deferredAudio: true }` 改为 `EXTRA_CONTEXT_BY_TOOL` (单位:千美元)`server/infra/tools/plugins-registry.ts`) (中文(简体) ). 二者兼有或两者皆不作: `deferredAudio` 没有 运行时间会留下长的渲染卡片,没有它的音频. 既无, `viewOf(...)` 单干 和以前一样.
4.  `common/toolGroups.ts`设置 : `manageJingleScript` 输入 `media` 组合.
5.  重建前端( N)`yarn build`)并重新启动 Mulmo Terminal(服务器在启动时加载插件).

## 发展

```sh
yarn install
yarn typecheck   # vue-tsc, against the library's source
yarn test        # vitest, against the library's source
yarn build       # dist/: index.js (Node), vue.js + style.css (browser)
yarn definition  # regenerate src/definition.json from the library's zod schema
yarn demo-data && yarn demo   # a page with the player for three examples
yarn playground                # the GitHub Pages playground, rendering in the browser
yarn playground:build          # ../out/playground: what the Pages workflow deploys
```

## 常见问题

### @gui-chat-plugin/jinglescript 是什么？

用于 JingleScript 的 GUI 聊天协议插件: 管理 JingleScript 工具, 包含一个玩家视图, 用于渲染出 jingles \(波形, 提示, 节拍, 注释\) \.

### 如何安装 @gui-chat-plugin/jinglescript？

在项目目录运行 npm install @gui-chat-plugin/jinglescript，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：vue（^3\.5\.43）、jinglescript（^1\.2\.1）、gui-chat-protocol（^2\.3\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @gui-chat-plugin/jinglescript 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @gui-chat-plugin/jinglescript 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @gui-chat-plugin/jinglescript 可以商用吗？

@gui-chat-plugin/jinglescript 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @gui-chat-plugin/jinglescript 的下载量有多少？

根据 npm 官方下载统计，@gui-chat-plugin/jinglescript 在 2026/10/17 – 2026/11/15 这 30 天内被下载 4,606 次，日均约 154 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @gui-chat-plugin/jinglescript 还在维护吗？

最新版本 1\.2\.1 发布于 2026/11/09（8 天前）；至今共发布 20 个版本，其中过去 12 个月发布了 20 个；首次发布于 2026/10/09。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

