Koishi是一个功能强大的聊天机器人框架，基于TypeScript开发，具有高度的可配置性和扩展性。它提供了丰富的API和插件，覆盖了机器人开发的方方面面，能够满足各种需求。无论是构建大型交互应用还是轻量级的辅助机器人，Koishi都能提供最佳实践。其简洁的API设计和人性化的提示，让新手也能快速上手，打造属于自己的对话应用。

koishi机器人是什么

Koishi 是一个强大的聊天机器人框架，因此有大量的知识需要学习。不过请不用担心，我们为学习者提供了一部循序渐进的教程，帮助你从最基础的概念出发，逐步掌握 Koishi 开发。

koishi机器人怎么样

开箱即用

高度便利的控制台让你无需基础让你在几分钟之内搭建自己的聊天机器人。

提供在线插件市场，一键下载安装插件

支持 QQ，Telegram，Discord 等主流聊天平台

随时随地通过控制面板监控运行状态，甚至上号聊天

功能强大

中间件，指令系统，插件系统，数据库，跨平台……它们可以让你顺利实现任何需求。

生态丰富

官方提供了大量插件和解决方案，覆盖了绝大多数常见需求的同时，也为开发提供了绝佳的范例。

专为开发者打造

Koishi 更为开发者提供了众多专业功能，使开发者得以在各种复杂需求中构建规模化的解决方案。

koishi安装和配置插件教程

认识控制台

在你成功安装了模板项目或启动器后，控制台将自动打开。

控制台的界面主要分为两部分，左侧是活动栏，用来切换右边的界面，右边默认打开的是仪表盘页面。在宽屏设备的下方还有一个状态栏，主要用来显示机器人的运行状态。

在之后的几节里，我们会逐一介绍各界面的功能和使用。

安装插件

Koishi 不对非官方插件的安全性做任何保证。请不要随意下载来源不明的插件，因为它们可能导致 Koishi 无法运行，甚至更严重的后果。如果你下载插件后遇到了问题，可以前往用户群或论坛进行反馈。此外，部分插件带有「不安全」标识，安装此类插件将不会受到官方群内的支持。

前往「插件市场」页面，你将在这里看到所有可下载的插件。在搜索框中输入 echo，找到我们想要的插件，点击「添加」按钮，然后在弹出的对话框中点击「安装」。等待片刻，插件就已经安装成功了。

启用和停用插件

Koishi 不会自动启用刚刚安装的插件，你需要手动配置并启用。前往「插件配置」页面，左侧栏中列出了已配置的各种插件。其中黑色字体显示的是正在运行的插件，而灰色字体则对应尚未运行的插件。

我们可以看到此时 echo 插件的名字是灰色的，这表明它并未处于运行状态。echo 插件没有可配置的项目，因此右侧的详情页是空白的。我们可以直接点击右上角的「启用插件」按钮，看到「启用成功」的提示信息，这表明 echo 插件就已经处于运行状态了。

要停用 echo 插件同样很简单。点击右上角的「停用插件」按钮，插件便会停止运行。停用插件既不会删除插件的代码，也不会删除插件的配置，你可以随时重新启用它。

配置插件

在配置插件的过程中，请大家记住这个原则：如无必要，勿动配置。Koishi 在设计上兼顾了扩展性和实用性，许多基础功能是以预装插件的形式提供的。前面我们已经用到的「插件市场」和「插件配置」页面本身就分别由预装的 market 插件和 config 插件提供。正是因为所有的预装插件均已配置完善，通常情况下你不需要修改预装插件的配置。随意改动插件配置、删除预装插件都可能导致 Koishi 无法正常运行。

虽然 echo 插件没有需要配置的地方，但更复杂的插件则通常会提供各种配置项，允许使用者控制插件的行为。下图展示了 novelai 插件的配置界面。

在这个界面中，我们可以看到许多配置项。其中你需要注意：

必选但尚未填入的配置项会在左侧呈现红色的提示条，只有正确填写配置才能启动插件。

已修改但未保存的配置项会在左侧呈现紫色的提示条，点击「启用插件」或「保存配置」按钮后会保存配置；如果你想撤销这些改动，可以在配置名称旁的小三角处呼出菜单，选择「撤销更改」使该配置恢复到上次保存时的状态。

管理插件

分组管理

Koishi 提供了插件分组的机制，分组内可以添加插件，方便同时管理多个插件。

Koishi 在安装时预先配置了一些分组，而新安装的插件会放置在插件列表的底部，这表明它不属于任何分组。插件和分组都可以通过点选并拖拽的方式改变排列顺序或在分组之间移动。相信你也发现了，分组是可以嵌套的。

创建新的分组同样很简单。点击「全局配置」或任意分组名后，点击右上角的「创建分组」按钮可以在此创建一个新的插件分组。新分组的名字是随机生成的，但你可以点击名字修改成你喜欢的名字。分组可以在左侧栏中点击小三角来控制展开和收起。

此外，过滤器 机制也可用于分组，便于控制一系列插件的行为。

添加更多插件

通常情况下，一个插件只能同时运行一份配置。请参考维护多份配置章节。

如果某个已安装的插件并未显示在插件列表中，你也可以手动添加它。在「全局配置」或任意分组界面中，点击右上角的「添加插件」将会弹出对话框。在对话框中点击要添加的插件，即可创建一份未启用的插件配置。

删除插件或分组

注意：此操作无法被撤销，如果你想要恢复之前的配置，只能再次手动添加。请谨慎操作。

在任何插件的配置界面点击右上角的「删除插件」可删除这份配置。与之类似，在分组的配置界面点击右上角的「删除分组」可删除这个分组。删除分组时，分组内的所有插件也会一并删除。

更新和卸载插件

依赖管理功能仅为生产环境设计。如果当前 Koishi 是开发环境，请使用dep命令来更新依赖。

前往「依赖管理」页面，你可以在这里看到依赖列表。依赖可能包括 Koishi 本体，各种插件，以及支持插件运行的软件包等。

当依赖的状态显示为「可更新」时，点击其右侧的「修改」按钮，在弹出的窗口左上角选择你需要的版本，点击右下角的「更新」按钮即可完成更新。

你也可以批量更新多个插件，通过依赖名右侧的下拉菜单选择好所需更改的版本，点击右上角的「应用更改」按钮即可。此外，右上角的「全部更新」按钮可以一键更新所有依赖。

koishi机器人怎么对话

在沙盒中模拟对话

在控制台中前往「沙盒」页面，在这里我们可以模拟与机器人的对话。

首先点击屏幕左上角的「添加用户」来创建一个虚拟用户 (通常第一位虚拟用户的名字会是 Alice)，此时屏幕右侧会出现空白的聊天界面。点击屏幕下方的对话框，输入「help」，并按回车键发送。你会立即在聊天界面中看到机器人的回复，列出了包括echo和help在内的所有可用的指令，这便是help这个内置指令的功能。

可以看到，这里的echo就是我们刚刚安装的插件，它的功能是将用户的输入原样返回。让我们现在尝试一下：输入「echo 你好」，并按回车键发送。你会看到机器人的回复是「你好」。

如果想要模拟群聊，我们可以创建更多的用户，并在聊天界面顶部点击切换到「群聊模式」。这样，你就可以通过在左侧栏切换并控制多个虚拟用户与机器人聊天了。如果你要体验的是下棋一类的多人交互插件，这会非常有用。

除此以外，如果某些指令需要一定的权限等级，你也可以切换到「用户设置」中进行调整。

接入真实聊天平台

仅仅是在沙盒中对话是远远不够的。我们需要将机器人接入到真实的聊天平台中，才能让它真正地为我们服务。Koishi 使用适配器插件来支持各种聊天平台。下面是官方维护的适配器列表：

钉钉

Discord

KOOK

飞书

LINE

邮件

Matrix

QQ

Slack

Telegram

微信公众号

企业微信

WhatsApp

Zulip

其中，常用的适配器插件已经预装在了 Koishi 中，你可以在插件配置中的 adapter 分组中找到它们。如果没有看到你想要的平台，你也可以在插件市场中搜索并安装更多适配器插件。

一个 Koishi 应用可以同时接入多个聊天平台的多个账号。每个账号对应一份插件配置，你可以参考添加更多插件中的方法添加新的插件配置。由于同一平台内接入的多个机器人共享了相同的用户数据。因此，你可以非常方便地在多个机器人之间切换以实现负载均衡。

不同平台的接入方式与难度存在较大的差异。对于不同的平台，你需要做好相应的准备工作。这些工作可能包括在平台内注册开发者账号、准备一台部署到公网的服务器等等。你可以在各个适配器插件的文档中找到详细的指引。

好消息是，Koishi 的大部分功能都不依赖特定的聊天平台。因此在进行准备工作的同时，你完全可以阅读本文档的后续部分，并在沙盒中体验并学习 Koishi 的功能。

对比沙盒与真实环境

事实上，大多数机器人框架都没有提供沙盒功能，或是倾向于用户在真实环境中进行体验。你可能会有疑惑：为什么 Koishi 要推荐使用沙盒功能呢？因此我们列出了沙盒的几点优势。

首先，沙盒可以让你快速地了解插件的效果，而不需要在真实环境中进行大量的测试。想象一下，你刚刚安装了一个陌生的插件，你并不知道应该如何使用它，也不知道它的效果是什么。最糟糕的情况下，一旦插件的某些功能触发了机器人的敏感行为，你的真实账号还存在被封禁的风险。而沙盒则可以让你在不用担心这些问题的情况下，快速地了解插件的功能。

其次，如果你是插件的开发者而非使用者，沙盒功能的意义则更大了：得益于 Koishi 的热重载机制，每次修改插件源码后，你只需要按下保存，即可立即在沙盒中体验修改后的效果。这允许你在任何设备上进行快速的迭代开发，而根本不需要准备真实环境的账号。

当然，沙盒并不能代替真实的聊天环境，有些插件的效果可能无法在沙盒中体验。因此，我们推荐你在沙盒中体验插件的基础功能，而在真实环境中进行更加深入的测试。

小编点评

Koishi以其强大的功能和丰富的插件生态，成为了开发者们构建聊天机器人的首选框架。它不仅易于上手，还支持跨平台和高度定制化，满足了各种复杂需求。此外，其优秀的开发体验和丰富的文档资源，更是为开发者们提供了极大的便利。