通用 Python DCC 开发工具,支持 Maya、3ds Max、Substance Painter、Substance Designer、Houdini、Blender 等具备 Python 脚本能力的 DCC 软件。
环境要求
| 项 |
要求 |
| VS Code |
1.106.0 或更高 |
| DCC 端 Python |
支持 Python 2.7 与 3.x(Maya 2018+ / 3ds Max 2019+ 起的版本) |
低于 VS Code 1.106.0 无法安装本插件。若你的 VS Code 版本较旧,请升级到 1.106.0 或更高版本。
依赖
本插件要求安装 dcc-bridge Python 包:
pip install dcc-bridge
插件首次激活时会检测该包是否已安装,并提示安装命令。
功能
执行代码
在 VS Code 中按 Ctrl + Enter 将选中代码发送到 DCC 执行;未选中时执行整个文件。
执行失败时,输出面板会显示错误信息与完整回溯(traceback)并弹出错误提示;执行成功时正常打印输出。
附加调试器
DCC Python ToolKit: Attach Debugger 在 DCC 中启动 debugpy 调试服务,并将 VS Code 附加到该服务。首次使用前需运行 dcc setup <dcc> 完成 debugpy 安装。
注意:debugpy 在首次 attach 时绑定端口,DCC 运行期间端口不可更改。若修改了 debug.port 配置,需重启 DCC 才能生效。
Python 版本限制:debugpy 仅支持 Python 3.x。附加调试器前会先 ping 目标 DCC 检测其 Python 版本;若运行在 Python 2.7(如 Maya ≤ 2020、3ds Max ≤ 2020),会提示“暂不支持 debugpy 调试”并中止,请改用 Ctrl + Enter 直接执行代码。
重载模块
DCC Python ToolKit: Reload Modules 无需重启 DCC 即可重载工作区中的 Python 模块。
Dashboard
侧边栏 DCC Python ToolKit 面板列出所有运行中的 DCC 实例,点击即可选择连接。
DCC Setup Manager
点击 Dashboard 标题栏的 ⚙ 图标(或通过 Ctrl+Shift+P → DCC Setup Manager)打开 DCC 工具管理面板:
- 每个 DCC(Maya / 3ds Max / Substance Painter / Substance Designer / Houdini / Blender)有独立的 Setup / Unsetup 按钮
- 状态指示灯:绿色 ● 表示该 DCC 正在运行,灰色 ○ 表示未检测到
- 支持一键 全部 Setup 和 全部 Unsetup
- 执行 setup 时输出日志会实时写入
DCC Python ToolKit Log 输出频道
配置
| 配置项 |
说明 |
默认值 |
dcc-python-toolkit.pythonPath |
指定 Python 解释器路径,用于检测 dcc-bridge 包;留空则自动检测 |
"" |
dcc-python-toolkit.server.host |
DCC 服务地址 |
127.0.0.1 |
dcc-python-toolkit.server.port |
DCC 服务端口 |
7002 |
dcc-python-toolkit.environment.addWorkspaceToPath |
是否将工作区路径添加到 Python 的 sys.path |
true |
dcc-python-toolkit.execute.name |
执行代码时 __name__ 变量的值 |
__main__ |
dcc-python-toolkit.execute.entryPoint |
入口点脚本路径 |
"" |
dcc-python-toolkit.execute.entryPointReload |
执行入口点前是否重载模块 |
true |
dcc-python-toolkit.execute.showOutput |
执行代码时是否显示输出日志 |
true |
dcc-python-toolkit.execute.clearOutput |
每次执行新内容时是否清空输出日志 |
true |
dcc-python-toolkit.debug.port |
debugpy 端口,首次 attach 后绑定,修改需重启 DCC |
7012 |
dcc-python-toolkit.debug.justMyCode |
是否只调试用户编写的代码 |
true |
dcc-python-toolkit.pip.indexUrl |
pip 镜像源地址,用于 DCC Setup 时加速 debugpy 安装 |
"" |
开发
npm install
# 类型检查 + lint + esbuild 打包到 dist/extension.js
npm run compile
# 生产构建(压缩并去掉 sourcemap)
npm run package
# 打出本地安装包 vsix(产物在 dist/)
npm run vsix
# 只做校验不实际打包
npm run vsix:dry
npm run vsix 会先执行 check-types 与 lint,任一环节不通过即中止,因此该命令同时是发布前的本地门禁。
许可证
本项目采用 PolyForm Noncommercial License 1.0.0 授权,仅供非商业用途使用。详见根目录 LICENSE 文件。