Skip to content
This repository was archived by the owner on Mar 11, 2026. It is now read-only.

Commit 2986b1d

Browse files
authored
Merge pull request #12 from anka-afk/v2
docs add: 增加部分插件数据文档
2 parents 15e76e6 + 3601a4c commit 2986b1d

6 files changed

Lines changed: 670 additions & 6 deletions

File tree

.vitepress/config.mjs

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -144,12 +144,12 @@ export default defineConfig({
144144
link: "/function-calling",
145145
},
146146
{
147-
text: 'MCP',
148-
link: '/mcp'
147+
text: "MCP",
148+
link: "/mcp",
149149
},
150150
{
151-
text: '网页搜索',
152-
link: '/websearch'
151+
text: "网页搜索",
152+
link: "/websearch",
153153
},
154154
{
155155
text: "沙箱化代码执行器(beta)",
@@ -180,14 +180,28 @@ export default defineConfig({
180180
collapsed: true,
181181
items: [
182182
{ text: "整体架构", link: "/overall_architecture" },
183-
{ text: "运行流程", link: "/overall_operation_process" }
183+
{ text: "运行流程", link: "/overall_operation_process" },
184184
],
185185
},
186186
{
187187
text: "插件开发",
188188
base: "/dev/star",
189189
collapsed: true,
190-
items: [{ text: "插件基础开发", link: "/plugin" }],
190+
items: [
191+
{ text: "插件基础开发", link: "/plugin" },
192+
{ text: "插件数据目录", link: "/all_resources" },
193+
{
194+
text: "插件开发数据",
195+
link: "/resources",
196+
collapsed: true,
197+
items: [
198+
{ text: "AstrMessageEvent", link: "/astr_message_event" },
199+
{ text: "Context", link: "/context" },
200+
{ text: "Star", link: "/star" },
201+
{ text: "StarMetadata", link: "/star_metadata" },
202+
],
203+
},
204+
],
191205
},
192206
{
193207
text: "接入平台适配器",

dev/star/all_resources.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
outline: deep
3+
---
4+
5+
# 插件开发使用的类与数据资源索引
6+
7+
下面讲解一些插件开发中使用到的 AstrBot 核心提供的类与数据资源, 文档中不会介绍类的所有的属性, 部分属性和方法不建议在插件中使用, 这部分内容不会在这里介绍。
8+
文档中默认 self 是指该类的实例, 你可以在对应类内部的任何方法中使用这些资源, 注意文档中的所有方法都省略了 self 参数, 你需要使用`self.属性名``self.方法名()`进行调用。
9+
10+
## AstrBot 消息事件
11+
12+
- [AstrMessageEvent](/dev/star/resources/astr_message_event.md)
13+
14+
## 功能类
15+
16+
- [Star](/dev/star/resources/star.md)
17+
18+
## 数据类
19+
20+
- [Context](/dev/star/resources/context.md)
21+
- [StarMetadata](/dev/star/resources/star_metadata.md)

0 commit comments

Comments
 (0)