QiHome Plugins

中文 · English

中文

这里是给 QiHome 提交插件想法、反馈问题，以及把插件源码列进社区目录的地方。

先说清楚现在的状态

• Plugin API 是 0.1 开发者预览：能用、经过测试，但接口还没有冻结。
• 社区插件商店已经开放（QiHome OS 2.0 测试版起）。想让别的家庭在 App 的插件商店里直接安装你的插件，不用来这里提 PR，直接用命令行发布：

  qihome-plugin create ./my-plugin --id io.github.<你的 GitHub 用户名>.my-plugin --kind wasm
  qihome-plugin login      # 用 GitHub 登录
  qihome-plugin publish ./my-plugin
  

  商店会自动审核（规则检查、静态分析、由商店从源码构建、在测试环境里实际运行），全部通过后用社区密钥签名上架，通常一两分钟。社区插件只能是声明式或 WASM 插件，只能使用对社区开放的权限；每个家庭默认关闭社区插件，由主人打开。详见发布说明。
• 在这里提 PR 的插件会由人工审核，通过后列进这个仓库的社区目录，其他人可以看源码、在开发模式下自己安装；它们不会因此出现在 App 的商店里。

你可以做什么

想做的事	怎么做
提一个插件想法	开一个 插件想法 Issue
提交你写好的插件	按 CONTRIBUTING.md 提一个 Pull Request
报告插件或 SDK 的问题	开一个 问题反馈 Issue

开始写插件

1. 下载 SDK：qihome-plugin-sdk-0.1.1.zip（SHA-256 6f23103ce33efc8cd7dba571a8f699a056adb8861c21eaed817e1dda5945790b）。里面有命令行工具 qihome-plugin（macOS Apple 芯片、Linux x86_64 / ARM64，含 login / publish）、Go（含 WASM）和 TypeScript 的 SDK、文档和 10 个示例。
2. 读开发文档：https://123457.shop/qihome/developers/docs/
3. 在自己的 QiHome 上打开插件开发模式试装（qihome-plugin install-local），确认能用。
4. 用 qihome-plugin publish 发布到社区插件商店，或者来这里提交。

每个 Pull Request 都会自动跑一遍 qihome-plugin validate --report（只检查，不运行你的代码）。审核看什么，写在 REVIEW.md。

English

This is where you suggest plugins for QiHome, report problems, and list plugin sources in the community catalog.

Where things stand

• The Plugin API is a 0.1 developer preview: usable and tested, not frozen.
• The community Plugin Store is open (from the QiHome OS 2.0 test builds). To have other homes install your plugin straight from the Plugin Store in their app, you don't need a pull request here; publish from the command line:

  qihome-plugin create ./my-plugin --id io.github.<your-github-login>.my-plugin --kind wasm
  qihome-plugin login      # sign in with GitHub
  qihome-plugin publish ./my-plugin
  

  The store reviews automatically (rule checks, static analysis, a build from source by the store, a real run in the test environment) and, when every check passes, signs the plugin with the community key and lists it, usually within a minute or two. Community plugins are declarative or WASM plugins using the permissions open to community plugins; community plugins are off in every home until its owner turns them on. See how publishing works.
• Plugins submitted here by pull request are reviewed by people and, once accepted, listed in this repository's community catalog, where others can read the source and install them in development mode; that does not put them in the app's store.

What you can do

You want to	Do this
Suggest a plugin	Open a Plugin idea issue
Submit a plugin you wrote	Open a pull request following CONTRIBUTING.md
Report a problem with a plugin or the SDK	Open a Problem report issue

Start writing a plugin

1. Download the SDK: qihome-plugin-sdk-0.1.1.zip (SHA-256 6f23103ce33efc8cd7dba571a8f699a056adb8861c21eaed817e1dda5945790b): the qihome-plugin CLI (macOS Apple silicon, Linux x86_64 / ARM64, with login / publish), Go (with WASM) and TypeScript SDKs, docs and 10 examples.
2. Read the developer docs: https://123457.shop/qihome/developers/docs/
3. Try it on your own QiHome in plugin development mode (qihome-plugin install-local).
4. Publish it to the community Plugin Store with qihome-plugin publish, or submit it here.

Every pull request runs qihome-plugin validate --report automatically (it checks; it never runs your code). What review looks at is in REVIEW.md.

---

The documents and tools in this repository are under the MIT License. Each plugin keeps its own license, in its own folder.