OpenPlug

简体中文 · English

OpenPlug 让没有 VPN 的用户也能一键安装 Obsidian 官方社区插件和主题。

1 安装

1. 官方社区商店（推荐）：Obsidian → 设置 → 第三方插件 → 关闭安全模式 → 浏览社区插件 → 搜索 OpenPlug → 安装并启用。
2. 手动安装：从 GitHub Releases 下载 main.js、manifest.json、styles.css 三个文件，放入 vault 下的 .obsidian/plugins/openplug/ 目录（移动端为对应应用文件夹内的同一路径），重启 Obsidian 后在第三方插件列表中启用。也可用 BRAT 插件添加 jiaoyingxing/openplug 跟踪预发布版本。

2 使用方式

2.1 打开安装器

任选其一：

• 工具栏图标：点击购物车图标 —— 电脑上位于左侧工具栏，手机上位于主界面底部工具栏。
• 命令面板：执行「打开插件/主题安装器」。
• 设置页：设置 → 第三方插件 → OpenPlug，点击「打开插件界面」中的「打开」。
• 官方社区跳转（推荐）：在 Obsidian 官方社区 打开插件或主题详情页，点击 Add to Obsidian，在浏览器中同意跳转后自动打开安装器。

2.2 安装插件或主题

在搜索框输入插件名、主题名或作者名，从结果中选择；安装时会先展示插件信息卡（版本 / 作者 / ID / 兼容性）与简介译文，可自选安装版本；确认后一键下载、校验、安装并启用。

2.3 更新插件

安装器主页会自动检查本库已安装的官方插件更新（仅正式版本），逐条显示可更新项；点击「更新」完成安装后需重启 Obsidian 生效。更新需手动发起、不会自动更新，也不会改变插件原有的启用状态。

3 主要功能

4 网络使用与隐私披露

运行时只发起以下 HTTPS 请求，全部用于获取公开数据：

• 官方清单：community-plugins.json 与 community-css-themes.json（用于搜索与跳转解析）。
• 国内 GitHub 加速镜像（内置并经过实测验证）：gh-proxy.com、ghfast.top、wget.la —— 用于下载清单、manifest 与插件文件。
• jsDelivr 数据接口（data.jsdelivr.com）：获取插件版本列表（历史版本下拉与更新检测）。
• 翻译接口（仅发送公开的插件描述文本，用于将侧栏简介译成中文）：uapis.cn（主源）、api.mymemory.translated.net（兜底）。

不收集任何用户数据，无遥测，无广告，无账号要求。更新检测仅在本机将已安装插件与官方清单比对，不上传任何安装信息。

5 使用须知与限制

• 本插件不是 Obsidian 官方功能，而是一个获取渠道的辅助工具；安装的插件 / 主题内容均由各自原作者提供，请自行核对来源与权限。
• 仅支持官方社区已上架的插件与主题（不在官方清单中的插件可通过 BRAT 安装）。
• 镜像节点为公益服务，可用性与速度会随网络环境波动；如遇全部节点不可用，可在设置页重新测速后重试。
• 软件著作权与许可：本插件以 MIT License 开源；安装的第三方插件 / 主题遵循其各自的许可证。

6 兼容性

• 最低 Obsidian 版本：1.11.4。
• 桌面与移动端均支持（isDesktopOnly: false）。

7 开发

npm run lint        # ESLint（obsidianmd 推荐规则）
npm run build       # 类型检查 + 生产构建（输出 dist/release）

源码使用 TypeScript，仅依赖 Obsidian API 与 Web API（crypto.subtle 做 SHA256 校验，不使用 Node API），产物由 esbuild 打包。

欢迎提交 Issue或PR。LICENSE 见 LICENSE。