appstore-1panel/apps/koishi/README.md
2023-12-07 15:18:34 +08:00

56 lines
3.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div align="center">
<a href="https://koishi.chat/" target="_blank">
<img width="160" src="https://koishi.chat/logo.png" alt="logo">
</a>
<h1 id="koishi"><a href="https://koishi.chat/" target="_blank">Koishi</a></h1>
[![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)
</div>
Koishi 是一个跨平台、可扩展、高性能的聊天机器人框架。
它的名字和图标设计来源于来源于东方 Project 中的角色古明地恋 (Komeiji Koishi)。古明地恋是一个会做出无意识举动的角色,取这个名字既象征着聊天机器人的主题,也蕴含了开发者为之倾注的热爱。
## 特性
### 开箱即用
Koishi 提供了高度便利的控制台,让你无需基础让你在几分钟之内搭建自己的聊天机器人。
- 提供在线插件市场,即使没有任何编程基础,也能轻松在控制台中下载安装插件
- 支持 QQTelegramDiscord飞书等主流聊天平台支持多账户和跨平台数据互通
- 随时随地通过控制面板监控运行状态,控制机器人的行为,甚至上号聊天
### 生态丰富
经过了长达四年的迭代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)