简介
<p><a href="https://npm.im/package/kivibot"><img src="https://shields.io/npm/dm/kivibot?label=downloads&amp;style=flat-square" alt="dm" /></a></p>
<p><a href="https://qun.qq.com/universal-share/share?ac=1&amp;authKey=KZX4MYboWE2E8UCniWeG65if95Zhb0nYz849YFd8GKKyOWbyt9oP5ev%2Bo7XHKVxZ&amp;busi_data=eyJncm91cENvZGUiOiI2OTI0Mzg3NDAiLCJ0b2tlbiI6ImhHS1c0OTA1eU95aVVSYUZZbEVkSHE3Ny9qM0poVjFldWdGTm5PeEcyMmRGajJuN2VVRjM0Q0ZiQTliY0RpL1AiLCJ1aW4iOiIyODY3MDMzNzg1In0%3D&amp;data=FLsWViti97FjOvvXSfd_b2PYsEhNNlnkGNdFX7iGc5FtoQeeG4z8HiAiMmwwUGBh-ys9P3a03dbo2gCfL6lFaQ&amp;svctype=4&amp;tempid=h5_group_info"><img src="https://img.shields.io/badge/QQ%20%E7%BE%A4-692438740-527dec?logo=TencentQQ&amp;style=flat-square&amp;logoColor=ffffff" alt="qq-group" /></a></p>
<p><a href="https://qun.qq.com/universal-share/share?ac=1&amp;authKey=DQ%2BRsDXgDK39j%2BPpBe9F2V1UvAX7gPr9m3ccYnG7pfO75Xm2ZOmRp1znKuzTQZme&amp;busi_data=eyJncm91cENvZGUiOiIzNDc5MzM0NTAiLCJ0b2tlbiI6InpBY0g3cGZwbjZGeWxUUWVtcjZhMEV4ZDFDYlJVNGlUUlVJVnlSN0kvb3JrMHVaK3dGb1N4L015MHZQTXFqVGQiLCJ1aW4iOiIyODY3MDMzNzg1In0%3D&amp;data=w2LZhmHQZ2zHUtdzFGXdjhY2G9TTEtcUdt4HhhE_rwpWoRR5qhBmEdRcQDILuKOLd6T0wtfR6B8aFSvmecRIAA&amp;svctype=4&amp;tempid=h5_group_info"><img src="https://img.shields.io/badge/QQ%20%E7%BE%A4-347933450-527dec?logo=TencentQQ&amp;style=flat-square&amp;logoColor=ffffff" alt="qq-group" /></a></p>
<p>请注意</p>
<p>本文档由官方维护，框架作者是 <a href="https://mys.yiciwl.icu">Cracked</a> <a href="https://mys.yiciwl.icu">点我前往linbaoyo</a>，框架也仅发布为 npm 包的形式。<br />
如果文档有问题可以及时与我们联系，见标题栏 <code>更多</code></p>
<p><code>KiviBot</code> 是使用 <a href="https://www.typescriptlang.org/">TypeScript</a> 语言编写的<strong>轻量</strong>、<strong>优雅</strong>、<strong>跨平台</strong>、<strong>开发者友好</strong>的 QQ 机器人框架。</p>
<p>框架提供了状态监控、插件管理、管理员机制、消息通知、请求处理功能，开箱即用。框架完全开源，可扩展性强，插件开发简单，核心底层协议使用 icqq<-<a href="https://github.com/takayama-lily/oicq">oicq</a> v2，API 众多，功能强大。另外，框架使用 <a href="https://nodejs.org/">node</a> 驱动，得益于 node 及其高效的 v8 引擎，KiviBot 的性能可观。</p>
<p>本项目开发初衷在于提高群活跃氛围、方便群管理，仅供个人娱乐、学习和交流使用，<strong>不得将本项目用于任何非法用途</strong>。</p>
<h2>为什么选择 KiviBot<a href="https://www.showdoc.com.cn/p/8d9657a008f0fccac079e11e92cc6a4b">#</a></h2>
<ul>
<li>
<p><strong>轻量</strong>：无需运行 UI，内存占用低。</p>
</li>
<li>
<p><strong>高效</strong>：框架依赖少，执行效率高。</p>
</li>
<li>
<p><strong>跨平台</strong>：Windows, Linux, Android 等都能运行。</p>
</li>
<li>
<p><strong>多协议</strong>：支持安卓手机、安卓平板、iPad、安卓手表和 MacOS 协议。</p>
</li>
<li>
<p><strong>注重体验</strong>：使用 QQ 消息 执行操作、启用或升级插件。</p>
</li>
<li>
<p><strong>极速开发</strong>：学习门槛低，只需几行 JS/TS 代码就能编写插件。</p>
</li>
<li><strong>开发者友好</strong>：插件支持热重载，拥有友好的 Kivi API。</li>
</ul>
<p>三步安装：<a href="https://www.showdoc.com.cn/p/d60084e69e64a4041b9747d616568aec">快速上手</a></p>
<h2>插件示例<a href="https://www.showdoc.com.cn/p/8d9657a008f0fccac079e11e92cc6a4b">#</a></h2>
<p>仅需编写少量 TypeScript 代码即可实现丰富功能，参考下面的 Demo。</p>
<p>请注意</p>
<p>框架仍处于<strong>测试阶段</strong>，插件的 API 会不断完善，请留意文档更新。</p>
<p>js</p>
<pre><code>import { definePlugin } from &quot;kivibot&quot;;
export default definePlugin({
name: &quot;模版&quot;,
version: &quot;1.0.0&quot;,
async setup(ctx) {
// 处理群消息 这里的e是指event事件
ctx.handle(&quot;message.group&quot;, (e) =&gt; {
// 控制台打印字符串内容(两种方法 有差异)
console.log(e.toString());
console.log(e.raw_message);
// 快速回复消息
e.reply(e.raw_message);
});
},
});</code></pre>
<p>详细 Bot <code>API</code> 说明请参阅 <a href="https://www.showdoc.com.cn/KiviBot/11558839261928774"><code>Bot API</code></a></p>
<h2>留给用户的话<a href="https://www.showdoc.com.cn/p/8d9657a008f0fccac079e11e92cc6a4b">#</a></h2>
<p>> 真正意义上的理想机器人，理应是功能足够强大，默默无闻的，在你需要的时候，又能以最高的效率及时给予你帮助，足够方便，还能偶尔带来趣味与欢乐，而不是一味的堆积菜单，搞一堆花里胡哨的插件或者功能，抛开太多无意义的功能不说，还不断的刷屏，就为了显得机器人有多么多的功能 —— bot</p>
<p>>
Cracked 说的对 —— QQ bot</p>