jianf/HomeAgent
1
0
Fork 0
mirror of https://gitcode.com/JianFeeeee/HomeAgent.git synced 2026-10-03 15:53:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: mascot before each section heading in tutorial docs

Browse Source
This commit is contained in:
jianf
2026-07-17 21:44:15 +08:00
parent 706700ba8e
commit 0164e1cc12
8 changed files with 108 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/zh/PLUGIN_DEV.md
View File

@ -1,9 +1,9 @@
[English](../en/PLUGIN_DEV.md) | **中文**
<img src="../../branding/mascot-xiaozhai.webp" width="20" style="border-radius:50%;vertical-align:middle"> :
# HomeAgent 插件开发指南
<img src="../../branding/mascot-xiaozhai.webp" width="20" style="border-radius:50%;vertical-align:middle"> :
## 概述
HomeAgent 的所有外部交互能力都来自插件。插件通过 `PluginSDK`（Go API）与内核交互。
@ -36,6 +36,8 @@ type Plugin interface {
---
<img src="../../branding/mascot-xiaozhai.webp" width="20" style="border-radius:50%;vertical-align:middle"> :
## 一、快速开始：使用 plugindev 工具链
`plugindev` 是 SDK 仓库提供的统一插件开发工具链，支持 Go 和 Lua 两种插件类型。
@ -135,6 +137,8 @@ curl -X POST http://127.0.0.1:9876/plugins \
---
<img src="../../branding/mascot-xiaozhai.webp" width="20" style="border-radius:50%;vertical-align:middle"> :
## 二、Go 插件开发详解
### 插件接口
@ -347,6 +351,8 @@ channels := s.ListChannels()
---
<img src="../../branding/mascot-xiaozhai.webp" width="20" style="border-radius:50%;vertical-align:middle"> :
## 三、Lua 插件开发详解
Lua 插件适合轻量级快速原型，无需 Go 编译环境，修改后直接重启内核即可生效。
@ -417,6 +423,8 @@ lua main.lua
---
<img src="../../branding/mascot-xiaozhai.webp" width="20" style="border-radius:50%;vertical-align:middle"> :
## 四、内置插件
内置插件使用 `init()` 自注册方式，编译进内核，无需单独部署。
@ -480,6 +488,8 @@ import (
---
<img src="../../branding/mascot-xiaozhai.webp" width="20" style="border-radius:50%;vertical-align:middle"> :
## 五、最佳实践
1. `Start()` 非阻塞 — goroutine 启动长任务，不要阻塞 Start
@ -492,6 +502,8 @@ import (
---
<img src="../../branding/mascot-xiaozhai.webp" width="20" style="border-radius:50%;vertical-align:middle"> :
## 六、示例插件参考
### SDK 仓库示例（`homeagent-sdk/example/`）