godot-tools-dsh-plugin

Readme

# godot-tools-dsh-plugin

Standard **bundle** package for [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness): native agent tools that drive a local **Godot 4.x** executable (headless CLI + editor launcher). No MCP server, no network, no runtime npm installs.

> 旧的手动安装版（out-of-tree DIY 形态）在 [jxb01/godot-tools-dsh](https://github.com/jxb01/godot-tools-dsh)。本仓库是标准 `dsh.bundle` 形态，可一键安装/卸载。

## Tools

| Tool | What it does |
|---|---|
| `godot_check` | Validate a Godot project headless (import + first frame) |
| `godot_import` | Re-import all assets headless |
| `godot_run_scene` | Run a scene headless for N frames |
| `godot_run_script` | Run a GDScript headless (SceneTree/MainLoop); captures print() and exit code |
| `godot_list_assets` | Recursively list `.tscn` / `.gd` / `.tres` |
| `godot_open_editor` | Launch the Godot editor GUI (detached) |
| `godot_toggle` | Live enable/disable of the `godot_*` tools in-session, no restart |

## Install (one command)

From a git host (no build script needed — pure JS, ships sources that load directly):

```sh
dsh plugin --profile web add github:jxb01/godot-tools-dsh-plugin
```

Or from a local checkout:

```sh
dsh plugin --profile web add /path/to/godot-tools-dsh-plugin
```

Then restart `dsh web`. The 7 tools appear in the agent chat.

> ⚠️ 如果你用的是源码 checkout，命令前缀为 `pnpm dsh plugin ...`。

## Configure

Override in your profile's `cordis.patch.yml` (target the row by id):

```yaml
- id: godot-tools
  config:
    godotExe: 'D:/path/to/Godot_v4.7.1-stable_win64_console.exe'   # optional
```

## Toggle / disable

- In-session: call `godot_toggle(enabled: false | true)`. Resets to enabled on restart.
- At boot: add `disabled: !!js process.env.GODOT_TOOLS === '0'` to the row in your profile's patch, then start `dsh web` with `GODOT_TOOLS=0`.

## Uninstall (one command)

```sh
dsh plugin --profile web remove godot-tools-dsh-plugin
```

---

## 中文说明

[DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) 的标准 **bundle 包**：原生驱动本地 **Godot 4.x** 可执行文件的 Agent 工具（headless CLI + 编辑器启动）。无需 MCP、无网络依赖、运行时零 npm 安装。

### 工具

`godot_check` 无头校验 / `godot_import` 重导入 / `godot_run_scene` 跑场景 / `godot_run_script` 跑 GDScript / `godot_list_assets` 列资源 / `godot_open_editor` 打开编辑器 / `godot_toggle` 会话内开关。

### 一键安装

```sh
dsh plugin --profile web add github:jxb01/godot-tools-dsh-plugin
```

或本地目录 `dsh plugin --profile web add /path/to/godot-tools-dsh-plugin`，然后重启 `dsh web` 即可。

### 配置 / 开关 / 卸载

- 配置：在 profile 的 `cordis.patch.yml` 按 id `godot-tools` 覆盖 `config.godotExe`
- 会话内开关：`godot_toggle(enabled: bool)`
- 卸载：`dsh plugin --profile web remove godot-tools-dsh-plugin`

## License

MIT — see `LICENSE`.

第三方依赖许可证见 [`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md)。
Third-party license notices: [`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md).