开发者文档
了解如何创建和发布 MioIsland 插件
前置要求
你需要安装 Xcode 15 或更高版本、macOS 13.0 或更高版本,以及 Swift 5.9 或更高版本。确保你已经安装了 Xcode Command Line Tools,运行 xcode-select --install 即可完成安装。建议使用 Xcode 作为主要开发工具,它提供了完整的 Swift 编译和调试支持。
从模板创建
前往 github.com/nicepkg/mio-plugin-template 克隆或使用该模板仓库。模板包含完整的项目结构、构建脚本和示例代码,帮助你快速上手。点击 GitHub 页面上的 "Use this template" 按钮,为你的插件创建一个新仓库。
插件类型说明
MioIsland 支持四种插件类型:主题(theme)用于改变 Notch 栏的颜色和视觉风格;伙伴精灵(companion)为 Notch 栏添加可爱的动画角色;音效(sound)提供氛围背景声和通知音效;扩展组件(utility)增加音乐播放器、状态统计等实用功能。每个插件只能属于一种类型。
主题
theme
伙伴精灵
companion
音效
sound
扩展组件
utility
构建插件
在项目根目录运行 bash build.sh 来构建插件。构建脚本会编译 Swift 代码并生成 .bundle 文件夹,同时自动将其压缩为 .zip 文件以便上传。.bundle 文件夹包含编译后的二进制文件、资源文件和 Info.plist 元数据文件。
准备提交
确保你的仓库包含一个详细的 README.md 文件,说明插件的功能、截图和使用方法。检查 Info.plist 中的版本号、Bundle Identifier 和插件名称是否正确。构建脚本生成的 .zip 文件即为上传所需的插件包,大小不得超过 50MB。
通过市场提交
前往开发者中心并使用 GitHub 账号登录。点击"提交插件",填写插件信息,上传 .zip 插件包并设置定价。提交时需提供源代码仓库地址,我们会对源代码进行安全审核,你的代码始终保存在你的私有仓库中。
审核流程说明
我们对所有插件进行源代码审核,以确保安全性和用户隐私。审核内容包括:是否存在恶意代码或数据收集行为、是否符合 MioIsland 插件 API 规范、资源文件是否合规、性能是否影响系统稳定性。审核通常在 3-5 个工作日内完成,审核结果会通过邮件通知。
更新与版本管理
在 Info.plist 中更新版本号(遵循语义化版本规范,如 1.0.1),重新运行 build.sh 构建新版本,然后在开发者中心上传新的 .zip 文件。每次更新都需要经过审核,审核通过后新版本会自动推送给已安装该插件的用户。建议在 README.md 中维护 CHANGELOG 记录每次更新的内容。