快速上手

本章通过三个最小示例演示插件开发的基本流程。你将分别创建一个 Service 插件、一个 Data 插件和一个 UI 插件。

环境准备

在开始开发前，你需要准备以下软件：

• Python 3.14
• uv 或其他 Python 包管理（如 pip）
• PyriteIDE 用于调试插件

1. 新建项目并初始化虚拟环境：

uv init --python 3.14
uv venv

python3.14 -m venv .venv

2. 安装 PyriteSDK：

uv add pyrite-sdk

pip install pyrite-sdk

3. 进入虚拟环境：

.\.venv\Scripts\activate

source .venv/bin/activate

source .venv/bin/activate

4. 确认安装

pyrsdk -v

测试插件

1. 新建

创建模板插件（这会新建一个 src 文件夹）：

pyrsdk create <plugin_type>

2. 打包

pyrsdk package --platform <platform>

打包完成后，build/ 目录会生成 <插件ID>.zip 及对应的 <插件ID>.zip.hash 校验文件。

目录结构

每个插件的标准目录结构：

<plugin_name>
├── src
│   ├── __main__.py      # 插件入口
│   ├── plugin.toml      # 插件清单（manifest v2）
│   ├── requirements.txt # 第三方依赖
│   └── assets/          # 可选，只读资源（图片、视频等）
└── build                # pyrsdk package 输出目录

下一步

• 实战：从零写一个 Ui 插件 — 完整链路演练（清单、视图、命令、配置、打包）
• 插件类型 — 了解三种插件类型的详细区别
• 生命周期 — 理解插件的启动、暂停、恢复和销毁流程
• UI 插件开发 — 原生视图、组件与事件回调
• 服务插件开发 — 后台任务的实现方式
• 数据插件开发 — 主题、语言包和类型存根的贡献方式
• 打包与发布 — plugin.toml 配置和打包命令详解
• 排错指南 — 常见错误码与修复步骤