From aac52de89cb8f61f059583d9c752426521e485ea Mon Sep 17 00:00:00 2001 From: ForteScarlet Date: Mon, 4 Mar 2024 15:53:35 +0800 Subject: [PATCH] =?UTF-8?q?doc:=20=E6=8C=96=E4=B8=80=E5=A0=86=E6=96=87?= =?UTF-8?q?=E6=A1=A3=E7=9A=84=E5=9D=91?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Writerside/kook.tree | 13 ++++++++ Writerside/topics/KookChannel.md | 3 ++ Writerside/topics/KookGuild.md | 3 ++ Writerside/topics/KookMember.md | 3 ++ Writerside/topics/KookUserChat.md | 3 ++ Writerside/topics/actors.md | 6 ++++ Writerside/topics/kookbot.md | 3 ++ Writerside/topics/logger.md | 42 ++++++++++++++++++++++++ Writerside/topics/message-element.md | 14 +++++--- Writerside/topics/object-KMarkdown.md | 5 +++ Writerside/topics/objects-Attachments.md | 5 +++ Writerside/topics/objects-Card.md | 5 +++ Writerside/topics/objects.md | 11 +++++++ Writerside/topics/role-api.md | 4 +-- 14 files changed, 114 insertions(+), 6 deletions(-) create mode 100644 Writerside/topics/KookChannel.md create mode 100644 Writerside/topics/KookGuild.md create mode 100644 Writerside/topics/KookMember.md create mode 100644 Writerside/topics/KookUserChat.md create mode 100644 Writerside/topics/actors.md create mode 100644 Writerside/topics/kookbot.md create mode 100644 Writerside/topics/logger.md create mode 100644 Writerside/topics/object-KMarkdown.md create mode 100644 Writerside/topics/objects-Attachments.md create mode 100644 Writerside/topics/objects-Card.md create mode 100644 Writerside/topics/objects.md diff --git a/Writerside/kook.tree b/Writerside/kook.tree index d665fe37..98f1506d 100644 --- a/Writerside/kook.tree +++ b/Writerside/kook.tree @@ -20,7 +20,20 @@ + + + + + + + + + + + + + diff --git a/Writerside/topics/KookChannel.md b/Writerside/topics/KookChannel.md new file mode 100644 index 00000000..1bb6c829 --- /dev/null +++ b/Writerside/topics/KookChannel.md @@ -0,0 +1,3 @@ +# 子频道 KookChannel + +Start typing here... \ No newline at end of file diff --git a/Writerside/topics/KookGuild.md b/Writerside/topics/KookGuild.md new file mode 100644 index 00000000..f1347072 --- /dev/null +++ b/Writerside/topics/KookGuild.md @@ -0,0 +1,3 @@ +# 频道 KookGuild + +Start typing here... \ No newline at end of file diff --git a/Writerside/topics/KookMember.md b/Writerside/topics/KookMember.md new file mode 100644 index 00000000..ccfbdf05 --- /dev/null +++ b/Writerside/topics/KookMember.md @@ -0,0 +1,3 @@ +# 频道成员 KookMember + +Start typing here... \ No newline at end of file diff --git a/Writerside/topics/KookUserChat.md b/Writerside/topics/KookUserChat.md new file mode 100644 index 00000000..b52399dd --- /dev/null +++ b/Writerside/topics/KookUserChat.md @@ -0,0 +1,3 @@ +# 私聊会话 KookUserChat + +Start typing here... \ No newline at end of file diff --git a/Writerside/topics/actors.md b/Writerside/topics/actors.md new file mode 100644 index 00000000..e13ff16c --- /dev/null +++ b/Writerside/topics/actors.md @@ -0,0 +1,6 @@ +# 行为对象 + +KOOK的**行为对象**(例如 `KookGuild`、`KookMember` 等) +都是对 simbot 标准库中的行为对象进行的实现与延伸扩展。 + +你可以前往了解 [simbot标准库的 **行为对象**](https://simbot.forte.love/basic-actor.html)。 diff --git a/Writerside/topics/kookbot.md b/Writerside/topics/kookbot.md new file mode 100644 index 00000000..460c6dc3 --- /dev/null +++ b/Writerside/topics/kookbot.md @@ -0,0 +1,3 @@ +# KookBot + +Start typing here... \ No newline at end of file diff --git a/Writerside/topics/logger.md b/Writerside/topics/logger.md new file mode 100644 index 00000000..cf1d3923 --- /dev/null +++ b/Writerside/topics/logger.md @@ -0,0 +1,42 @@ +# 日志 + +## API 日志 + +开启 `love.forte.simbot.kook.api` 的 `DEBUG` 级别日志， +可以看到 **所有** API 请求过程中的信息，例如入参、结果等。 + + + +这可能会泄露一些隐私信息，请注意保护日志安全。 + + + +## Stdlib Bot 日志 + +在stdlib模块下的 `Bot` 中提供了两个日志命名： + + +
  • + +`love.forte.simbot.kook.bot.${ticket.clientId}` + +开启 `DEBUG` 和 `TRACE` 级别的日志可得到一些利于调试的、与事件之外的内容相关的日志。 + +
    • +
  • + +`love.forte.simbot.kook.event.${ticket.clientId}` + +开启 `DEBUG` 和 `TRACE` 级别的日志可得到一些利于调试的、与事件相关的日志。 + +
    • +     + +其中 `${ticket.clientId}` 就是你 Bot 对应的信息。 + +## 组件库 KookBot 日志 + +在core模块下的 `KookBot` 中提供了 +`love.forte.simbot.component.kook.bot.${sourceBot.ticket.clientId}` +的日志，开启它的 `DEBUG` 级别日志可以得到一些由组件库的 `KookBot` +额外提供的一些利于调试的日志。 diff --git a/Writerside/topics/message-element.md b/Writerside/topics/message-element.md index 2dea26c2..b8e95edb 100644 --- a/Writerside/topics/message-element.md +++ b/Writerside/topics/message-element.md @@ -3,18 +3,24 @@ switcher-label: Java API 风格 --- # 消息元素 -本章节介绍 KOOK 组件中针对 simbot4 的 **消息元素(`Message.Element`)** 的实现类型。 +本章节介绍 KOOK 组件中针对 simbot 标准库中 **消息元素(`Message.Element`)** 的实现类型。 + + + + + ## Message.Element -先简单介绍一下 `Message.Element`。它是 simbot4 标准库中提供一个接口类型， +先简单介绍一下 `Message.Element`。它是 simbot 标准库中提供一个接口类型， 用来定义一个**消息元素**。一个消息元素或多个消息元素组成的**消息链**可用于发送消息。 -simbot4 的标准库提供了一些常见的标准消息元素实现，例如 `At`、`Image` 等。 +simbot 标准库提供了一些常见的标准消息元素实现，例如 `At`、`Image` 等。 但是很多情况下，对于一个组件而言这些标准实现可能不能满足需求，这时候就需要组件实现这个接口， 来提供更多期望的功能。 -> 有关更详细的描述参考 [simbot4 手册](https://simbot.forte.love) 中的相关章节。 +> 你可以前往 [simbot4 手册的消息元素](https://simbot.forte.love/basic-messages.html) +> 了解更多详情。 ## 标准消息元素支持 diff --git a/Writerside/topics/object-KMarkdown.md b/Writerside/topics/object-KMarkdown.md new file mode 100644 index 00000000..52f47d56 --- /dev/null +++ b/Writerside/topics/object-KMarkdown.md @@ -0,0 +1,5 @@ +# KMarkdown + +> 官方文档: [KMarkdown](https://developer.kookapp.cn/doc/kmarkdown) + +Start typing here... diff --git a/Writerside/topics/objects-Attachments.md b/Writerside/topics/objects-Attachments.md new file mode 100644 index 00000000..d5653496 --- /dev/null +++ b/Writerside/topics/objects-Attachments.md @@ -0,0 +1,5 @@ +# Attachments + +> 官方文档: [附加的多媒体数据 Attachments](https://developer.kookapp.cn/doc/objects#附加的多媒体数据%20Attachments) + +Start typing here... diff --git a/Writerside/topics/objects-Card.md b/Writerside/topics/objects-Card.md new file mode 100644 index 00000000..839d827d --- /dev/null +++ b/Writerside/topics/objects-Card.md @@ -0,0 +1,5 @@ +# Card + +> 官方文档: [卡片消息](https://developer.kookapp.cn/doc/cardmessage) + +Start typing here... diff --git a/Writerside/topics/objects.md b/Writerside/topics/objects.md new file mode 100644 index 00000000..a0d98cd3 --- /dev/null +++ b/Writerside/topics/objects.md @@ -0,0 +1,11 @@ +# Objects + +KOOK API 中提供了一些 [Objects](https://developer.kookapp.cn/doc/objects) 的定义， +在KOOK组件库的 **API模块** 针对这其中的大部分类型提供了对应的封装。 + +> 它们基本上都在包 `love.forte.simbot.kook.objects` 中。 +> +> 此包下的部分内容也可能不在官方的 [Objects](https://developer.kookapp.cn/doc/objects) 分类下， +> 例如 `Card` 和 `KMarkdown`。 + + diff --git a/Writerside/topics/role-api.md b/Writerside/topics/role-api.md index 68e1bd4c..c8a5f5dc 100644 --- a/Writerside/topics/role-api.md +++ b/Writerside/topics/role-api.md @@ -1,3 +1,3 @@ -# 角色操作 +# 角色 KookRole -Start typing here... \ No newline at end of file +Start typing here...