https://github.com/koishijs/koishi

Cross-platform chatbot framework made with love
https://github.com/koishijs/koishi

bot chatbot discord feishu framework koishi koishijs lark line mail matrix onebot sdk telegram

Last synced: about 2 months ago
JSON representation

Cross-platform chatbot framework made with love

• Host: GitHub
• URL: https://github.com/koishijs/koishi
• Owner: koishijs
• License: mit
• Created: 2019-12-03T08:47:29.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-12T08:20:02.000Z (4 months ago)
• Last Synced: 2024-05-14T22:22:52.070Z (4 months ago)
• Topics: bot, chatbot, discord, feishu, framework, koishi, koishijs, lark, line, mail, matrix, onebot, sdk, telegram
• Language: TypeScript
• Homepage: https://koishi.chat
• Size: 16.4 MB
• Stars: 4,015
• Watchers: 35
• Forks: 227
• Open Issues: 63
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-web-cn - koishi - 一个跨平台的机器人框架，支持 QQ，Telegram，Discord 等多个平台 (Uncategorized / Uncategorized)
• awesome-github-star - koishi - platform chatbot framework made with love | koishijs | 3280 | (TypeScript)
• awesome-mirai - Koishi
• StarryDivineSky - koishijs/koishi

README

        


  

    

  

  
Koishi


[![Codecov](https://img.shields.io/codecov/c/github/koishijs/koishi?style=flat-square)](https://codecov.io/gh/koishijs/koishi)

[![downloads](https://img.shields.io/npm/dm/koishi?style=flat-square)](https://www.npmjs.com/package/koishi)

[![npm](https://img.shields.io/npm/v/koishi?style=flat-square)](https://www.npmjs.com/package/koishi)

[![GitHub](https://img.shields.io/github/license/koishijs/koishi?style=flat-square)](https://github.com/koishijs/koishi/blob/master/LICENSE)



Koishi 是一个跨平台、可扩展、高性能的聊天机器人框架。

它的名字和图标设计来源于来源于东方 Project 中的角色古明地恋 (Komeiji Koishi)。古明地恋是一个会做出无意识举动的角色，取这个名字既象征着聊天机器人的主题，也蕴含了开发者为之倾注的热爱。

## 特性

### 开箱即用

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

- 提供在线插件市场，即使没有任何编程基础，也能轻松在控制台中下载安装插件

- 支持 QQ，Telegram，Discord，飞书等主流聊天平台，支持多账户和跨平台数据互通

- 随时随地通过控制面板监控运行状态，控制机器人的行为，甚至上号聊天

### 生态丰富

经过了长达四年的迭代，Koishi 已经发展出了丰富的插件生态和与之匹配的健壮系统。超过 1000 个官方和社区插件覆盖了机器人开发的方方面面，从平台支持、数据库、资源存储、网页控制台、状态管理到具体的业务功能一应俱全。无论你的目标是构建大型交互应用还是轻量级的辅助机器人，Koishi 都为你提供了最佳实践。如果担心在复杂的功能中迷失方向，我们也准备了细致的文档来提供帮助。

### 专为开发者打造

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

- 类型支持：Koishi 完全基于 TypeScript 开发，拥有顶级的类型支持，丰富的代码提示让你在编写代码的时候甚至无需查看文档

- 单元测试：所有核心功能均已经通过单元测试，既确保了可靠性，也为开发者提供了一套测试插件和定位问题的最佳实践

- 模块热重载：开发 Koishi 插件时，只需轻点保存即可热重载，无需频繁重启机器人，如同前端开发一样丝滑顺畅

## 快速起步

[前往文档](https://koishi.chat/manual/starter/)

## 许可证

Koishi 完全使用 [MIT](./LICENSE) 协议开源，维护良好的开源生态从我做起 (*>ω<)φ

Copyright © 2019-2023, Shigma

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkoishijs%2Fkoishi.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkoishijs%2Fkoishi?ref=badge_large)

## 更多

- [贡献指南](./CONTRIBUTING.md)

- [参与讨论](https://koishi.chat/about/contact.html)

- [支持作者](https://afdian.net/a/shigma)