Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

🌟 AstrBot 插件开发技能指南

让 AI 助手能够快速、准确地编写 AstrBot 插件的完整知识库。

📖 这是什么?

这是一份专为 AI 编程助手设计的 AstrBot 插件开发技能文件,包含 SKILL.md 主文件和详细的 references 参考文档,涵盖了编写 AstrBot 插件所需的全部知识。

当你让 AI 助手"帮我写一个 AstrBot 插件"时,它可以加载这份技能文件,直接产出正确、可运行的插件代码。

🎯 覆盖内容

模块 说明
🏗️ 架构概览 AstrBot 核心架构与设计理念
📦 插件配置 装饰器 / Schema / 环境变量 / 文件配置 / 生命周期
🪝 Hooks 系统 事件钩子、Agent 相关钩子
💬 消息系统 消息模型 / 组件 / 事件 / UMO 统一消息
🤖 Agent 系统 LLM 调用 / 对话管理 / 工具注册 / 子代理 / 沙箱
🔌 平台适配器 适配器接口 / 消息转换 / Telegram 媒体组
💾 存储系统 KV 存储 / 文件存储
🖼️ 文字转图片 text_to_image 工具
🎨 设计规范 核心概念 / 事件流 / 上下文 / 最佳实践 / 可视化工具
⏰ 定时任务 Cron 定时任务集成
🌐 国际化 插件 i18n 支持
📄 插件页面 自定义 Web 页面

📁 文件结构

├── SKILL.md                          # 主技能文件(入口)
└── references/                       # 详细参考文档
    ├── agent/                        # Agent 系统
    │   ├── index.md                  # Agent 概览
    │   ├── Invoke-llm.md            # LLM 调用
    │   ├── conversation.md           # 对话管理
    │   ├── registe tools.md          # 工具注册
    │   ├── subagents.md              # 子代理
    │   ├── sandbox.md                # 沙箱
    │   ├── cron.md                   # 定时任务
    │   ├── persona-sets.md           # 人设集
    │   ├── persona-resolution.md     # 人设解析
    │   ├── agent-related-hooks.md    # Agent 钩子
    │   ├── agent-runner.md           # Agent 运行器
    │   └── context-compression.md    # 上下文压缩
    ├── design_standards/             # 设计规范
    │   ├── architecture_overview.md  # 架构概览
    │   ├── core_concepts.md          # 核心概念
    │   ├── event_flow.md             # 事件流
    │   ├── context_usage.md          # 上下文使用
    │   ├── best_practices.md         # 最佳实践
    │   ├── sandbox.md                # 沙箱设计
    │   └── visual_utils.md           # 可视化工具
    ├── messages/                     # 消息系统
    │   ├── model.md                  # 消息模型
    │   ├── components.md             # 消息组件
    │   ├── events.md                 # 消息事件
    │   └── umo.md                    # 统一消息对象
    ├── platform_adapters/            # 平台适配器
    │   ├── adapter_interface.md      # 适配器接口
    │   ├── message_conversion.md     # 消息转换
    │   └── telegram_media_group.md   # Telegram 媒体组
    ├── plugin_config/                # 插件配置
    │   ├── simple.md                 # 简单插件
    │   ├── decorators.md             # 装饰器
    │   ├── schema.md                 # Schema 配置
    │   ├── env.md                    # 环境变量
    │   ├── file_config.md            # 文件配置
    │   ├── hooks.md                  # 钩子
    │   ├── lifecycle.md              # 生命周期
    │   ├── command_management.md     # 命令管理
    │   ├── session_control.md        # 会话控制
    │   ├── plugin-i18n.md            # 国际化
    │   └── plugin-pages.md           # 插件页面
    ├── kv_storage.md                 # KV 存储
    ├── file_storage.md               # 文件存储
    └── text_to_image.md              # 文字转图片

🚀 如何使用

作为 OpenClaw / Codex 技能

将本仓库克隆到技能目录:

# OpenClaw
git clone https://github.com/MeowAndy/astrbot-plugin-skill.git ~/.openclaw/plugin-skills/astrbot-plugin-dev

# Codex
git clone https://github.com/MeowAndy/astrbot-plugin-skill.git ~/.codex/skills/astrbot-plugin-dev

之后 AI 助手在收到 AstrBot 插件开发相关请求时会自动加载此技能。

作为参考文档

  1. 先阅读 SKILL.md 了解整体框架
  2. 按需查阅 references/ 下的详细文档

📋 适用版本

  • AstrBot: v4.x+
  • 语言: Python 3.10+
  • 特性: 异步优先、装饰器驱动、多平台适配

🐺 作者

小凌虾 整理发布。

📄 License

MIT

About

AstrBot 插件开发 SKILL.md - AI 辅助编写 AstrBot 插件的完整知识库

Resources

Stars

5 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors