dsh-gandi
让 DSH 的 agent 在你正在用的 Gandi(共创世界 Gandi IDE 桌面版)里做 Scratch 项目:
写脚本、画造型、加声音、跑起来、看截图,然后接着改。
它不修改 Gandi 本身,也不往你的项目里塞看不见的东西——只是在旁边操作它,
就像另一个坐在电脑前的人。
它不碰你的云端作品。 Gandi 的编辑器开的是你账号里的在线作品;这个插件只把项目
导出成本地 .sb3,不会替你保存或发布云端版本。要接着改就 gandi_save,
下次 gandi_open 读回来。
它能做什么
对 agent 说一句「用 gandi 工具做个接苹果的小游戏」,它就会自己开工:
开一个编辑器页签 → 新建项目 → 画苹果和篮子 → 写脚本 → 按键测试 → 看舞台截图 → 发现问题再改。
具体一点,它能:
- 写脚本:用 Scratch 自己的积木方言(可读的 XML),支持自定义积木和脚本注释。
- 画美术:造型和背景直接写 SVG;也可以给位图。
- 加声音:给个音高和时长就合成一个(上滑=跳跃/得分,下滑=失败,游戏音效基本就这两种)。
- 建变量、列表、角色,改名字、摆位置、调大小。
- 真的跑起来:点绿旗、推进 N 秒、返回坐标和变量值,还能截图给模型"看"。
- 模拟键盘和鼠标:这是测游戏唯一靠谱的办法——按住空格键,看小人有没有动。
按键可以安排在跑到第几秒按下,所以"按住会走、松开就停"一次就能测完。
- 不打开 Gandi 也能改文件:手上有个
.sb3,可以直接读它、改它、存回去。
快速开始
# 1. 装进你要用的 profile(两个都装也可以)
dsh plugin --profile dsh-tui add E:/dsh-gandi
dsh plugin --profile web add E:/dsh-gandi
# 2. 告诉插件 Gandi 装在哪(也可以写进配置文件,如下)
$env:GANDI_APP_PATH = 'E:\Gandi\Gandi.exe'
# 3. 重启 DSH
装完可以用 dsh --profile <profile> --dump-config 确认配置里真的出现了
gandi 这一行。第一次安装如果中途断网,可能会静默回滚(配置文件不变),
重跑一次即可。
改完代码要重启 DSH 才生效。 宿主面插件不支持热重载。
前置条件
| 项 | 要求 |
|---|
| Node | ^22.19 或 >=24 |
| Gandi Desktop | 1.0.5 已验证(Windows,E:\Gandi\Gandi.exe) |
| 网络 | 需要联网:编辑器本体是 www.ccw.site 上的网页 |
| 账号 | 桌面版要登录过(编辑器要用它载入默认项目) |
| 模型 | 需要能看图片,否则截图会降级成"把 PNG 写到某个路径,你自己去读" |
插件通过 Chrome DevTools 协议连进编辑器,所以 Gandi 必须带调试端口启动。
gandi_launch 会替你加这个参数,也会替你开一个编辑器页签。
两个必须知道的坑
1. Gandi 启动后停在"我的作品"列表页,没有编辑器。 编辑器是单独一个页面,
只有开了作品才存在。所以 gandi_status 里会看到 editor tab: none——这不是错误,
任何别的 gandi_* 调用都会先要一个页签。
和 TurboWarp 不同,Gandi 没有单实例锁:如果它已经在跑但没带调试端口,
关掉再让 agent gandi_launch 就行,不用折腾。
2. 编辑器要联网、要登录。 断网或没登录时页签开出来是空的,
gandi_launch 会等到超时并告诉你原因。
想自己启动的话:
Gandi.exe --remote-debugging-port=9222
配置
写进 profile 的 cordis.patch.yml($DSH_HOME/profiles/<profile>/cordis.patch.yml):
- id: gandi
config:
appPath: 'E:\Gandi\Gandi.exe'
port: 9222
autoLaunch: true
每个键都有默认值,都可以省略。因为"Gandi 装在哪"是机器级事实、在两个 profile 里
写两遍很烦,所以也支持环境变量覆盖:
| 配置键 | 环境变量 | 默认 | 说明 |
|---|
appPath | GANDI_APP_PATH | 自动探测常见安装位置 | Gandi.exe 的绝对路径 |
port | GANDI_PORT | 9222 | 调试端口 |
autoLaunch | GANDI_AUTO_LAUNCH | false | 连不上时是否自动拉起 Gandi |
leaseIdleMs | — | 300000 | 编辑权空闲多久后自动让出 |
launchTimeoutMs | — | 45000 | 等待编辑器就绪的上限 |
maxTextChars | — | 20000 | 单个工具输出的文本上限 |
screenshotOnRun | — | true | 跑完是否附一张舞台截图 |
allowOutsideWorkspace | — | false | 是否允许读写会话工作目录之外的路径 |
enableSystemPrompt | — | false | 是否注入一段简短的提示词 |
registerSkill | — | true | 是否注册 gandi-scratch-authoring 技能 |
debug | DSH_TUI_DEBUG | false | 把诊断写到 stderr |
工具一览
| 工具 | 作用 |
|---|
gandi_status | 端口、编辑器页签、连接、打开的项目、谁在编辑。出问题先看它 |
gandi_launch | 带调试端口拉起 Gandi,开一个编辑器页签,等它就绪 |
gandi_open | 把磁盘上的项目载入编辑器 |
gandi_new | 新建项目(舞台 + 一个起始角色);empty:true 只要舞台 |
gandi_sprite | 新建空角色(只留你给的造型)、复制角色、重命名、删除、选中 |
gandi_costume | 加造型,或给舞台加背景。写 SVG 或给位图 |
gandi_sound | 加声音:合成一个,或上传字节 |
gandi_variable | 建、改、重命名、删 变量与列表(全局或角色私有) |
gandi_place | 直接摆位置、朝向、大小、显隐,不写脚本 |
gandi_inspect | 读项目:角色、造型、变量、脚本。给 path 就读磁盘上的文件,不需要编辑器 |
gandi_apply | 写脚本。给 path 就改磁盘上的文件,不需要编辑器 |
gandi_run | 点绿旗,推进 N 秒,返回运行状态 + 舞台图。input 可以在跑的过程中按键/点鼠标 |
gandi_input | 模拟键盘鼠标(设置"跑之前就该在的状态";要测"按住"用 gandi_run 的 input) |
gandi_stop | 停止所有脚本(红色停止牌) |
gandi_observe | 读运行状态:坐标、造型、变量值、线程数 |
gandi_screenshot | 只截一张舞台图 |
gandi_save | 导出成 .sb3 |
写脚本前可以先 gandi_apply 加 dryRun: true:只检查不落地。有问题的脚本会被拒绝应用,
免得留下半个坏项目。
测交互的正确姿势
按键要按在项目跑起来之后。先按键再点绿旗是不行的——绿旗会停掉所有脚本并清空按键状态。
所以用 gandi_run 的 input:
gandi_run {seconds: 1, input: [{atSeconds: 0, key: 'space', isDown: true}]}
想测"按住会走、松开就停",把两条都写进同一次运行:
gandi_run {seconds: 1, input: [
{atSeconds: 0, key: 'space', isDown: true},
{atSeconds: 0.5, key: 'space', isDown: false}
]}
两种用法
| 对着 Gandi 用 | 直接改文件 |
|---|
| 前提 | 编辑器页签开着 | 只要一个 .sb3 |
| 读 | gandi_inspect | gandi_inspect {path} |
| 写 | gandi_apply | gandi_apply {path}(可 outPath 另存) |
| 跑 / 看 | gandi_run / gandi_screenshot / gandi_input | 做不到——没有编辑器就没有运行时 |
| 画造型、加声音、建变量、建角色 | 都可以 | 做不到(这些要用到运行时) |
两种方式用同一套脚本格式,所以「读出来 → 改 → 写回去 → 打开看」是一条完整通路。
路径默认限制在会话工作目录内;要写到外面得显式开 allowOutsideWorkspace。
排错
| 现象 | 原因与做法 |
|---|
editor tab: none | 正常:Gandi 停在项目浏览器。任何 gandi_* 调用都会开一个页签 |
Gandi is running, but it was not started with a debug port | 关掉 Gandi,再让 agent 调 gandi_launch |
no Gandi executable found | 设 appPath 或 GANDI_APP_PATH |
| 工具没出现在模型目录里 | 确认 dsh --profile <p> --dump-config 里有 gandi 行,然后重启 DSH |
| 页签一直停在「载入作品 / 下载作品数据中…」 | 桌面版"导入本地 .sb3"这条官方路径有启动竞态(见 docs/gandi-spike.md 第 9 条)。插件不走它:关掉那个页签,用 gandi_open |
| 编辑器开不出来 / 一片空白 | 检查网络和登录状态;编辑器是 www.ccw.site 上的网页 |
| 脚本跑了但画面没变 | 不是 bug:截图前会主动重绘。若用了 screenshot: false,画面可能还是旧的 |
| 截图变成了一个文件路径 | 这个部署没有图片附件服务,插件按设计写成 PNG 文件,读那个文件即可 |
session ... is driving Gandi | 另一个会话持有编辑权。等它空闲,或传 force: true 抢占 |
| 写文件被拒 | 默认只允许会话工作目录内。改到工作目录里,或设 allowOutsideWorkspace: true |
| 按住按键小人不动 | 按键必须按在跑的过程中(见上)。gandi_input 是在两次运行之间设置状态的 |
当前限制
- 云变量没做,Gandi 自己的插件/扩展积木也没做。
- 它不是 Gandi 的插件。 不会出现在 Gandi 的插件设置里,也不改 Gandi 的界面或代码——
它是从外面通过调试端口驱动编辑器,所以 Gandi 得开着、并且带调试端口。
- 不发布到 npm,所以不能按包名安装,要指定路径:
dsh plugin --profile <p> add E:/dsh-gandi。
(顺带说明:dsh plugin 本身就是把参数转发给 profile 目录里的 pnpm,没有额外的插件市场。)
- 只在
dsh-tui 和 web 上验证过,没在 desktop surface 上验证。
- 「新建角色」的实现是"复制一个已有角色,再把脚本、私有变量和造型清空换成你给的",
所以项目里至少要有一个角色可复制——这就是新建项目会自带一个起始角色的原因。
- 每次连上编辑器要等约 10 秒:Gandi 启动时总要载入一个默认项目,插件得等它载完
才能安全地换成你的项目。这不是可以省掉的等待。
卸载
dsh plugin --profile dsh-tui remove dsh-gandi
dsh plugin --profile web remove dsh-gandi
删掉即可完全还原:它不写应用数据目录,不改 Gandi,也不打包任何 Scratch 美术资源
(起始造型和背景都是插件自己画的几行 SVG)。
想改这个插件
开发相关的约定、上游陷阱、怎么跑测试、怎么加新工具,都写在
AGENTS.md 里;Gandi 侧的实测结论(含出处)在
docs/gandi-spike.md。这两份是给改代码的 agent 看的,
这份 README 是给人看的。
一句话版本:
node --test # 单元测试
node tools/e2e.mjs # 验收测试(会驱动真的编辑器)
改代码时请守住两条:不碰 Gandi 的任何代码(不反编译、不注入),零第三方依赖。