介绍
Koishi 是一个现代、高效的跨平台聊天机器人框架。
它的名字和图标设计来源于东方 Project 中的角色古明地恋(Komeiji Koishi)。古明地恋是一个会做出无意识举动的角色,取这个名字既象征着聊天机器人的主题,也表达了作者我为这个项目以及开源工作倾注的热爱。
特性
开箱即用的控制台
高度便利的控制台让你无需基础让你在几分钟之内搭建自己的聊天机器人。
- 提供在线插件市场,即使没有 js 编程基础,也能轻松在控制台中下载安装插件
- 支持 QQ,Telegram,Discord 等主流聊天平台,支持多账户和跨平台数据互通
- 随时随地通过控制面板监控运行状态,控制机器人的行为,甚至上号聊天
功能强大的 API
经过了几个版本的迭代,Koishi 已经发展出了丰富的 API,功能覆盖机器人领域的方方面面。从上层负责交互的指令、会话、中间件,再到中层负责控制的应用、上下文、插件,最后到底层的机器人和适配器,每一个部分都经过了精心的编写,可以让你轻松实现任何需求。如果担心在复杂的功能中迷失方向,我们也准备了细致的文档来提供帮助。
参见:API 文档
丰富的生态系统
官方提供了大量插件和解决方案,覆盖了绝大多数常见需求的同时,也为开发提供了绝佳的范例。
- @koishijs/plugin-console:网页控制台
- @koishijs/plugin-schedule:计划任务
- @koishijs/plugin-teach:问答教学
除了这些官方插件以外,社区贡献者也编写了各种各样的第三方插件:
- koishi-plugin-genshin:原神资料查询
- koishi-plugin-ink:展示视觉小说
- koishi-plugin-shell:执行终端命令
这些插件共同组成了 Koishi 如今的生态。
参见:官方插件
专为开发者打造
Koishi 更为开发者提供了众多专业功能,使开发者得以在各种复杂需求中构建规模化的解决方案。
类型支持
Koishi 完全基于 TypeScript 开发,拥有顶级的类型支持,丰富的代码提示让你在编写代码的时候甚至无需查看文档。
单元测试
所有核心功能均已经通过单元测试,既确保了可靠性,也为开发者提供了一套测试插件和定位问题的最佳实践。
模块热重载
开发 Koishi 插件时,只需轻点保存即可热重载,无需频繁重启机器人,如同前端开发一样丝滑顺畅。