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

Commit f8fbc55

Browse files
committed
Merge remote-tracking branch 'origin/v2' into update-repo-link
2 parents c211e6c + de76dcf commit f8fbc55

12 files changed

Lines changed: 754 additions & 40 deletions

File tree

.vitepress/config.mjs

Lines changed: 20 additions & 10 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,18 +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" }],
191-
},
192-
{
193-
text: "插件基础开发",
194-
link: "/plugin",
190+
items: [
191+
{ text: "插件基础开发", link: "/plugin" },
192+
{ text: "插件数据目录", link: "/all_resources" },
193+
{
194+
text: "插件开发数据",
195+
base: "/dev/star/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+
],
195205
},
196206
{
197207
text: "接入平台适配器",

community.md

Lines changed: 43 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,56 @@
11
# 社区
22

3-
本文档可能没有完全覆盖所有的功能,如果你有任何问题或者建议,或者发现了 AstrBot 或者是本文档的问题,欢迎通过下面的社区渠道联系我。
4-
5-
## QQ 群
6-
7-
欢迎加群讨论:[322154837](https://qm.qq.com/cgi-bin/qm/qr?k=EYGsuUTfe00_iOu9JTXS7_TEpMkXOvwv&jump_from=webapi&authKey=uUEMKCROfsseS+8IzqPjzV3y1tzy4AkykwTib2jNkOFdzezF9s9XknqnIaf3CDft)
8-
9-
10-
> [!TIP]
11-
> 为了该项目的可持续性,如果遇到问题,请优先提交 ISSUE,其次是在 QQ 群里提问。
3+
## 社区渠道
124

5+
本文档可能没有完全覆盖所有的功能,如果你有任何问题或者建议,或者发现了 AstrBot 或者是本文档的问题,欢迎通过下面的社区渠道联系我们。
136

147
> [!TIP]
158
> 为了该项目的可持续性,如果遇到问题,请优先提交 ISSUE,其次是在 QQ 群里提问。
169
10+
### QQ 群
1711

18-
> [!TIP]
19-
> 为了该项目的可持续性,如果遇到问题,请优先提交 ISSUE,其次是在 QQ 群里提问。
20-
12+
欢迎加群讨论:[322154837](https://qm.qq.com/cgi-bin/qm/qr?k=EYGsuUTfe00_iOu9JTXS7_TEpMkXOvwv&jump_from=webapi&authKey=uUEMKCROfsseS+8IzqPjzV3y1tzy4AkykwTib2jNkOFdzezF9s9XknqnIaf3CDft)
2113

22-
## GitHub
14+
### GitHub
2315

2416
欢迎提交 Issue 或 Pull Request:
2517

26-
[Soulter/AstrBot](https://github.com/AstrBotDevs/AstrBot)
18+
- [AstrBotDevs/AstrBot](https://github.com/AstrBotDevs/AstrBot)
19+
20+
- [AstrBotDevs/AstrBot-Docs](https://github.com/AstrBotDevs/AstrBot-docs)
21+
22+
## 成为 AstrBot 组织成员
23+
24+
为了维护一个积极、健康和高效的社区环境,我们希望您满足以下任何一个条件:
25+
26+
1. **对项目有贡献**
27+
* 通过提交 **Pull Requests (PR)**、修复 **Issues** 或提供 **Bug Reports**,参与并推动项目的开发。
28+
* 贡献代码、文档、测试、或其他任何能推动项目进展的内容。
29+
2. **遵守 AGPL-3.0 协议与社区行为准则**
30+
* 您必须阅读并同意项目的**开源许可协议**(AGPL-3.0)。
31+
* 当您以 AstrBot 组织成员的身份在公开场合参与活动时,您必须遵守 AstrBot 采用的社区行为准则:[GitHub 社区行为准则 - GitHub 文档](https://docs.github.com/zh/site-policy/github-terms/github-community-code-of-conduct)
32+
3. **冷静应对分歧**
33+
* 在遇到社区、技术上的分歧或意见不合时,保持冷静,采取积极建设性的讨论方式,避免采取过激或攻击性的言辞——请对有其他想法和经验水平的用户持开放态度。
34+
4. **积极参与讨论**
35+
***Issues****Discussions、QQ 群 **或其他社区沟通渠道中积极参与讨论,提出有价值的意见和建议。
36+
* 掌握编程技术不是硬性规定,如果您无法提供直接的代码贡献,仍可通过帮助解决问题、提供反馈或提出创意来支持社区。
37+
5. **遵循项目的开发流程**
38+
* 在贡献代码时,遵循项目采用的代码风格(使用 PEP 8)。
39+
* 在提交改动较大的 PR 时(无论是代码还是文档),必须邀请组织其余成员进行 **Code Review**
40+
* 保证您的提交是经过适当测试的。
41+
7. **不得破坏社区**
42+
* 任何行为或举动(包括但不限于破坏代码、提交恶意 Pull Requests、滥用 Issue 系统等)旨在削弱或破坏项目的开发、文档、社区协作等方面的工作,都是不被允许的。
43+
* 禁止通过篡改仓库、无效 PR 或故意引发冲突等方式导致项目进度受阻或带来不必要的困扰。对于严重违规行为,管理团队有权将该成员从组织中移除,并在必要时采取法律行动。
44+
8. **持续支持与学习**
45+
* 成为社区成员意味着你愿意**持续参与**项目并帮助其他成员,无论是通过技术支持还是其他形式的帮助。管理团队有权移除长时间未活动的成员。
46+
* 您必须对 AI 等技术具有好奇心和自我驱动力,并在开发过程中持续学习。
47+
9. **推荐与提名**
48+
* 成员的推荐:如果您认为某个贡献者符合上述条件,可以通过组织内的团队成员或管理者进行提名。
49+
* 经过团队和社区的评估后,该贡献者可以被邀请加入组织成员名单。
50+
51+
成为组织成员后,您将享有以下权益:
52+
53+
* **项目管理权限**:有权审查和合并 PR、管理 Issues、以及对项目进行结构性修改。
54+
* **社区认可**:在项目文档中标明为组织成员,展示贡献和影响力。
55+
2756

28-
[Soulter/AstrBot-Docs](https://github.com/AstrBotDevs/AstrBot-docs)

dev/core/overall_operation_process.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,11 +96,6 @@ async def _process_stages(self, event: AstrMessageEvent, from_stage=0):
9696
if event.is_stopped():
9797
logger.debug(f"阶段 {stage.__class__.__name__} 已终止事件传播。")
9898
break
99-
100-
# 检查整个阶段是否完成后事件是否被停止
101-
if event.is_stopped():
102-
logger.debug(f"阶段 {stage.__class__.__name__} 已终止事件传播。")
103-
break
10499
```
105100

106101
这似乎很难理解, 这里提供一个示例进行解释:

dev/plugin.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
本页面已经迁移至 [插件基础开发](/dev/star/plugin)

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)

dev/star/plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -514,7 +514,7 @@ async def after_message_sent(self, event: AstrMessageEvent):
514514

515515
> 大于等于 v3.4.21。
516516
517-
指令、事件监听器可以设置优先级,先于其他指令、监听器执行。默认优先级是 `0`
517+
指令、事件监听器、事件钩子可以设置优先级,先于其他指令、监听器、钩子执行。默认优先级是 `0`
518518

519519
```python
520520
@filter.command("helloworld", priority=1)

0 commit comments

Comments
 (0)