Skip to content

Commit 9a7f225

Browse files
ForteScarletForteScarlet
committed
1 parent 5e811bf commit 9a7f225

File tree

2,862 files changed

+32852
-60711
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,862 files changed

+32852
-60711
lines changed

‎components/kook/index.html‎

Lines changed: 38 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@
4242
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
4343
<div class="library-name">
4444
<a class="library-name--link" href="index.html">
45-
Simple Robot Component KOOK
45+
Simple Robot 组件 | KOOK
4646
</a>
4747
</div>
4848
<div class="library-version">
49-
3.3.0.0-beta3 </div>
49+
4.0.0-dev1 </div>
5050
</div>
5151
</div>
5252
<div class="navigation-controls">
@@ -59,59 +59,51 @@
5959
<div class="sidebar--inner" id="sideMenu"></div>
6060
</div>
6161
<div id="main">
62-
<div class="main-content" id="content" pageIds="Simple Robot Component KOOK::.ext/allModules///PointingToDeclaration//0">
62+
<div class="main-content" id="content" pageIds="Simple Robot 组件 | KOOK::.ext/allModules///PointingToDeclaration//0">
6363
<div class="breadcrumbs"></div>
6464
<div class="cover ">
6565
<div class="cover ">
6666
<h1 class="">Simple Robot - KOOK 组件</h1>
67-
<p class="paragraph">此为 <a href="https://github.com/simple-robot/simpler-robot">Simple Robot v3</a> （以下简称为 <code class="lang-kotlin">simbot3</code> ） 下基于simbot标准API对 <a href="https://www.kookapp.cn/">KOOK API</a> 的组件支持。</p>
68-
<p class="paragraph"><strong>Simple Robot - KOOK 组件</strong> <small>以下简称KOOK组件</small> 是一个基于 <a href="https://kotlinlang.org/docs/multiplatform.html">KMP</a>、 支持多平台（<code class="lang-kotlin">JVM</code>、<code class="lang-kotlin">JS</code>、native）且JVM平台库对Java友好、 （特定模块）实现simbot3标准API的 <strong>KOOK 机器人API</strong> 依赖库。</p>
69-
<p class="paragraph"><strong>KOOK组件</strong>提供多平台的KOOK API、bot事件订阅等功能实现的底层库， 以及基于simbot3标准API的高级功能应用库。</p>
67+
<p class="paragraph">这是 <a href="https://github.com/simple-robot/simpler-robot">Simple Robot v4</a> 下的子项目，是针对 <a href="https://developer.kookapp.cn/doc/reference">KOOK(开黑啦)bot</a> 各方面的 simbot 组件库实现， 包括对 <code class="lang-kotlin">API</code> 内容的实现、事件相关的实现以及 bot 对于事件的监听与交互等。</p>
68+
<p class="paragraph">KOOK组件库可以作为底层API依赖使用、 轻量级的KOOK事件调度框架使用， 也可以基于 simbot 核心库的种种快速开发一个功能强大的 KOOK 机器人！</p>
69+
<ul>
70+
<li>
71+
<p class="paragraph">基于 <a href="https://kotlinlang.org/"><code class="lang-kotlin">Kotlin</code></a> 提供 <a href="https://kotlinlang.org/docs/multiplatform.html">KMP 多平台</a> 特性</p>
72+
</li>
73+
<li>
74+
<p class="paragraph">基于 <a href="https://github.com/Kotlin/kotlinx.coroutines"><code class="lang-kotlin">Kotlin coroutines</code></a> 与 <a href="https://ktor.io/"><code class="lang-kotlin">Ktor</code></a> 提供高效易用的API；</p>
75+
</li>
76+
<li>
77+
<p class="paragraph">基于 <a href="https://kotlinlang.org/"><code class="lang-kotlin">Kotlin</code></a> 提供 <a href="https://kotlinlang.org/docs/multiplatform.html">KMP 多平台</a> 特性，提供 Java 友好的API。</p>
78+
</li>
79+
<li>
80+
<p class="paragraph">基于 <a href="https://github.com/Kotlin/kotlinx.coroutines"><code class="lang-kotlin">Kotlin coroutines</code></a> 与 <a href="https://ktor.io/"><code class="lang-kotlin">Ktor</code></a> 提供轻量高效的API。</p>
81+
</li>
82+
</ul>
83+
<blockquote class="quotation">
84+
<p class="paragraph">!Note 下文中 <code class="lang-kotlin">Simple Robot v4</code> 简称为 <code class="lang-kotlin">simbot4</code></p>
85+
</blockquote>
7086
<h2 class=""> 文档</h2>
71-
<p class="paragraph">了解<strong>simbot3</strong>: <a href="https://simbot.forte.love">simbot3官网</a></p>
72-
<p class="paragraph">KOOK组件的<strong>组件手册</strong>: <a href="https://component-kook.simbot.forte.love/">组件手册</a></p>
7387
<blockquote class="quotation">
74-
<p class="paragraph">!note 手册与simbot3官网均部署于GitHub Pages。 为了更好的浏览体验，<strong>推荐</strong>开启魔法后访问。</p>
88+
<p class="paragraph">!warning 建设中</p>
7589
</blockquote>
76-
<p class="paragraph"><strong>API文档</strong>: <a href="https://docs.simbot.forte.love">API文档引导站</a></p>
77-
<h2 class=""> 支持情况</h2>
78-
<p class="paragraph">前往查看 support-list.md。</p>
90+
<ul>
91+
<li>
92+
<p class="paragraph">了解simbot: <a href="https://simbot.forte.love"><strong>Simple Robot 应用手册</strong></a></p>
93+
</li>
94+
<li>
95+
<p class="paragraph"><strong>KOOK组件</strong>手册(v4 建设中)：<a href="https://component-kook.simbot.forte.love/">https://component-kook.simbot.forte.love/</a> (即当前仓库的 GitHub Pages)</p>
96+
</li>
97+
<li>
98+
<p class="paragraph"><strong>API文档</strong>: <a href="https://docs.simbot.forte.love"><strong>文档引导站点</strong></a> 中KOOK的 <a href="https://docs.simbot.forte.love/components/qq-guild"><strong>KDoc站点</strong></a></p>
99+
</li>
100+
</ul>
101+
102+
<p class="paragraph">我们欢迎并期望着您的 <a href="https://github.com/simple-robot/simbot-component-qq-guild/issues">反馈</a> 或 <a href="https://github.com/simple-robot/simbot-component-qq-guild/pulls">协助</a>， 感谢您的贡献与支持！</p>
79103
<h2 class=""> 快速开始</h2>
80104
<p class="paragraph">前往 <a href="https://component-kook.simbot.forte.love/">组件手册</a> 阅读 <strong>快速开始</strong> 相关章节。</p>
81-
<h2 class=""> 走马观花</h2>
82-
<details>
83-
<summary>简单示例</summary> <blockquote class="quotation">
84-
<p class="paragraph">!note Java开发者可直接参考 <a href="https://component-kook.simbot.forte.love/">组件手册</a> 中<strong>快速开始</strong>相关示例的Java部分代码。</p>
85-
</blockquote>
86-
<blockquote class="quotation">
87-
<p class="paragraph">使用 Kotlin + <code class="lang-kotlin">simbot-component-kook-core</code> 配合 <code class="lang-kotlin">simboot-core-spring-boot-starter</code> 使用 <code class="lang-kotlin">Spring Boot</code> 的情况下：</p>
88-
</blockquote>
89-
<div class="sample-container">
90-
<pre><code class="block lang-kotlin" theme="idea">// simbot-core / simbot-boot<br>suspend fun KookContactMessageEvent.onEvent() {<br> author().send(&quot;Hello World&quot;)<br>}</code></pre>
91-
<span class="top-right-position"><span class="copy-icon"></span>
92-
<div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div>
93-
</span></div>
94-
<div class="sample-container">
95-
<pre><code class="block lang-kotlin" theme="idea">// simbot-boot<br>@Listener<br>@Filter(&quot;签到&quot;)<br>suspend fun KookChannelMessageEvent.onEvent() {<br> reply(&quot;签到成功&quot;)<br>}</code></pre>
96-
<span class="top-right-position"><span class="copy-icon"></span>
97-
<div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div>
98-
</span></div>
99-
<div class="sample-container">
100-
<pre><code class="block lang-kotlin" theme="idea">@Listener<br>@Filter(&quot;叫我{{name,.+}}&quot;)<br>suspend fun KookChannelMessageEvent.onEvent(@FilterValue(&quot;name&quot;) name: String) {<br> group.send(At(author.id) + &quot;好的，以后就叫你$name了&quot;.toText())<br>}</code></pre>
101-
<span class="top-right-position"><span class="copy-icon"></span>
102-
<div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div>
103-
</span></div>
104-
<p class="paragraph">简单的完整示例：</p>
105-
<blockquote class="quotation">
106-
<p class="paragraph">(使用 Kotlin + <code class="lang-kotlin">simbot-component-kook-core</code>, 非 Spring Boot 的情况下：)</p>
107-
</blockquote>
108-
<div class="sample-container">
109-
<pre><code class="block lang-kotlin" theme="idea">suspend fun main() {<br> createSimpleApplication {<br> // 注册并使用Kook组件。<br> useKook()<br> <br> // 注册各种监听函数<br> listeners {<br> // 监听联系人(私聊)消息<br> // 此事件的逻辑：收到消息，回复一句&quot;你说的是：&quot;，<br> // 然后再复读一遍你说的话。<br> ContactMessageEvent { event -&gt;<br> val contact: Contact = event.source()<br> contact.send(&quot;你说的是：&quot;)<br> contact.send(event.messageContent)<br> }<br> }<br> <br> // 注册kook的bot<br> kookBots {<br> val bot = register(&quot;client_id&quot;, &quot;token&quot;)<br> // bot需要start才能连接服务器、初始化信息等。<br> bot.start()<br> }<br> }.join() // join, 挂起直到被终止。<br>}</code></pre>
110-
<span class="top-right-position"><span class="copy-icon"></span>
111-
<div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div>
112-
</span></div>
113-
</details> <h2 class=""> 应用案例</h2>
114-
<p class="paragraph">如果你想看看通过 simbot 开发的bot是什么样子，不妨添加我们亲爱的 <a href="https://www.kookapp.cn/app/oauth2/authorize?id=10250&amp;permissions=197958144&amp;client_id=jqdlyHK85xe1i5Bo&amp;redirect_uri=&amp;scope=bot">法欧莉斯卡雷特</a> 并使用 <code class="lang-kotlin">@法欧莉 今天的我</code> 来看看效果吧~</p>
105+
<h2 class=""> 法欧莉</h2>
106+
<p class="paragraph">如果你想看一看使用 KOOK组件实现的具体作品， 不妨添加我们亲爱的 <a href="https://www.kookapp.cn/app/oauth2/authorize?id=10250&amp;permissions=197958144&amp;client_id=jqdlyHK85xe1i5Bo&amp;redirect_uri=&amp;scope=bot">法欧莉斯卡雷特</a> 并使用 <code class="lang-kotlin">@法欧莉 今天的我</code> 来看看效果吧~</p>
115107
<h2 class=""> License</h2>
116108
<p class="paragraph"><code class="lang-kotlin">simbot-component-kook</code> 使用 <code class="lang-kotlin">LGPLv3</code> 许可证开源。</p>
117109
<div class="sample-container">

0 commit comments

Comments
 (0)