安装与发布
本页汇总 0.3.2 的安装目标、官方驱动安装方式和源码运行方式。
0.3.2 发布状态
0.3.2 是 0.3.2 的 release candidate:
- 正式公开发布渠道仍以 PyPI 为准
TestPyPI只用于发布链路演练,不作为日常安装源- 当前仓库版本已切到
0.3.2
0.3.2 升级说明
0.3.2 是 0.3.1 之后的 release candidate:
- replay 时间轴支持任意位置 seek,并修复长录制下纳秒 seek 值溢出的问题
recording.json在录制停止或失败时持久化状态、持续时间和各 stream 帧数- 回放界面支持按 stream / 格式导出单录制、多录制和时间切片 bundle
- 导出输出目录可在 UI 中选择,PNG / MP4 / CSV / NPZ 等内建格式随主包可用
- SDK / driver API 仍处于早期阶段,
0.3.2不保证兼容0.2.xdriver 实现;外部插件建议明确依赖兼容的modlink-studio版本
0.3.2 沿用 0.3.0 的 Qt 版本约束 >=6.10.2,<6.11。
安装命令
0.3.2 可从 PyPI 安装:
python -m pip install modlink-studio==0.3.2安装完成后,正式入口是:
modlink-studio调试入口保留为:
modlink-studio-debug安装插件
插件不通过 PyPI extras 安装。主包安装完成后使用独立插件管理命令;命令会先从 ModLink-Studio-Plugins 的 GitHub Pages 插件索引读取可用版本,再从该插件仓库的 GitHub Release 安装对应插件 wheel。
当前第一阶段,这个命令集主要覆盖官方驱动;后续会继续扩展成更通用的插件管理工具:
modlink-plugin listmodlink-plugin install host-cameramodlink-plugin install host-microphonemodlink-plugin install openbci-ganglionmodlink-plugin install palm-sensor如果不再需要某个插件:
modlink-plugin uninstall host-camera如果想看当前环境里已经安装了哪些 ModLink 插件:
modlink-plugin list --installed从源码运行
如果目标是开发、联调或跟进仓库当前实现,可以直接从源码运行,而不是等待正式发布包。
前置要求:
- Python 3.13
- Git
uv
获取源码并同步环境:
git clone https://github.com/modlink-studio/ModLink-Studio.git
cd ModLink-Studio
uv sync从仓库直接启动主宿主:
uv run modlink-studio如果要带控制台和调试日志启动:
uv run modlink-studio-debug外部插件开发
0.3.2 不提供独立 npm driver 脚手架。外部插件项目建议使用 tools/modlink-plugin-author/SKILL.md 作为 Claude Code / Codex 的可分发 skill,在插件自己的仓库里生成和维护 driver 代码。
推荐使用方式是在外部插件项目目录启动 coding agent,把这个 SKILL.md 作为 skill 或上下文加载,然后直接描述设备、连接方式、数据流类型和采样率。生成后仍应在插件项目内运行 python -m pip install -e . 和测试命令验证。
更完整的 driver 开发说明见 SDK 开发者指南。
发布前验证
0.3.2 发布前仍建议先跑 TestPyPI rehearsal。这一步只用于验证发布链路和安装命令,不作为普通用户安装入口。
正式发布前的检查重点包括:
- TestPyPI rehearsal 已完整跑通
- PyPI 目标安装命令在干净环境中可用
- 插件安装 CLI 可从 GitHub Pages 插件索引解析兼容版本,并从 GitHub Release 获取 wheel
modlink-studio命令入口正常
常见问题
为什么文档已经写 PyPI,但有时还搜不到最新版本
PyPI 项目页、镜像或本地索引有时会有短暂同步延迟。遇到这种情况时,以 PyPI 项目页和 pip / uv pip 的实际解析结果为准,稍后重试通常即可恢复正常。
TestPyPI 是不是以后长期使用的安装源
不是。TestPyPI 只用于发布前 rehearsal;公开安装入口以 PyPI 为准。
已安装主应用但看不到某个插件
主应用不会默认安装所有插件。当前第一阶段主要是官方驱动,需要显式运行 modlink-plugin install <plugin_id>;官方驱动源码与 wheel 资产已经迁移到独立仓库 ModLink-Studio-Plugins。
系统里找不到 modlink-studio 命令
先确认安装发生在当前 Python 环境中;如果需要带控制台和调试日志启动,使用 modlink-studio-debug。