diff --git a/README.md b/README.md index 3b8fc828..19a9a00c 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,62 @@
- + +# NapCat + ![NapCatQQ](https://socialify.git.ci/NapNeko/NapCatQQ/image?font=Jost&logo=https%3A%2F%2Fnapneko.github.io%2Fassets%2Fnewlogo.png&name=1&owner=1&pattern=Diagonal+Stripes&stargazers=1&theme=Auto) - + +_Modern protocol-side framework implemented based on NTQQ._ + +> 云起兮风生，心向远方兮路未曾至. +
--- -## 欢迎回家 -NapCatQQ 是现代化的基于 NTQQ 的 Bot 协议端实现 -## 特性介绍 -- [x] **安装简单**：就算是笨蛋也能使用 -- [x] **性能友好**：就算是低内存也能使用 -- [x] **接口丰富**：就算是没有也能使用 -- [x] **稳定好用**：就算是被捉也能使用 +## Welcome ++ NapCatQQ is a modern implementation of the Bot protocol based on NTQQ. + - NapCatQQ 是现代化的基于 NTQQ 的 Bot 协议端实现 -## 使用框架 +## Feature + ++ **Easy to Use** + - 作为初学者能够轻松使用. ++ **Quick and Efficient** + - 在低内存操作系统长时运行. ++ **Rich API Interface** + - 完整实现了大部分标准接口. ++ **Stable and Reliable** + - 持续稳定的开发与维护. +## Quick Start 可前往 [Release](https://github.com/NapNeko/NapCatQQ/releases/) 页面下载最新版本 **首次使用**请务必查看如下文档看使用教程 -### 文档地址 +## Link -[Cloudflare.Worker](https://doc.napneko.icu/) +| Docs | [![Github.IO](https://img.shields.io/badge/docs%20on-Github.IO-orange)](https://napneko.github.io/) | [![Cloudflare.Worker](https://img.shields.io/badge/docs%20on-Cloudflare.Worker-black)](https://doc.napneko.icu/) | [![Cloudflare.HKServer](https://img.shields.io/badge/docs%20on-Cloudflare.HKServer-informational)](https://napcat.napneko.icu/) | +|:-:|:-:|:-:|:-:| -[Cloudflare.HKServer](https://napcat.napneko.icu/) +| Docs | [![Cloudflare.Pages](https://img.shields.io/badge/docs%20on-Cloudflare.Pages-blue)](https://napneko.pages.dev/) | [![Server.Other](https://img.shields.io/badge/docs%20on-Server.Other-green)](https://docs.napcat.cyou/) | [![NapCat.Wiki](https://img.shields.io/badge/docs%20on-NapCat.Wiki-red)](https://www.napcat.wiki) | +|:-:|:-:|:-:|:-:| -[Github.IO](https://napneko.github.io/) +| Contact | [![QQ Group#1](https://img.shields.io/badge/QQ%20Group%231-Join-blue)](https://qm.qq.com/q/I6LU87a0Yq) | [![QQ Group#2](https://img.shields.io/badge/QQ%20Group%232-Join-blue)](https://qm.qq.com/q/HaRcfrHpUk) | [![Telegram](https://img.shields.io/badge/Telegram-MelodicMoonlight-blue)](https://t.me/MelodicMoonlight) | +|:-:|:-:|:-:|:-:| -[Cloudflare.Pages](https://napneko.pages.dev/) +## Thanks -[Server.Other](https://docs.napcat.cyou/) ++ [Lagrange](https://github.com/LagrangeDev/Lagrange.Core) 对本项目的大力支持 参考部分代码 已获授权 -[NapCat.Wiki](https://www.napcat.wiki) ++ [LLOneBot](https://github.com/LLOneBot/LLOneBot) 相关的开发曾参与本项目部分开发 -## 回家旅途 -[QQ Group#1](https://qm.qq.com/q/I6LU87a0Yq) - -[QQ Group#2](https://qm.qq.com/q/HaRcfrHpUk) - -[Telegram](https://t.me/MelodicMoonlight) - -> QQ Group#2 准许Bot / Telegram与QQ Group#2 为新建Group - -## 性能设计/协议标准 -NapCat 已实现90％+的 OneBot / GoCQ 标准接口，并提供兼容性保留接口，其设计理念遵守 无数据库/异步优先/后台刷新 的性能思想。 - -由此设计带来一系列好处，在开发中，获取群员列表通常小于50Ms，单条文本消息发送在320Ms以内，在1k+的群聊流畅运行，同时带来一些副作用，消息Id无法持久，无法上报撤回消息原始内容。 - -NapCat 在设计理念下遵守 OneBot 规范大多数要求并且积极改进，任何合理的标准化 Issue 与 Pr 将被接收。 - -## 感谢他们 -感谢 [Lagrange](https://github.com/LagrangeDev/Lagrange.Core) 对本项目的大力支持 参考部分代码 已获授权 - -感谢 React 强力驱动 NapCat.WebUi - -不过最最重要的 还是需要感谢屏幕前的你哦~ ++ 不过最最重要的 还是需要感谢屏幕前的你哦~ --- -## 特殊感谢 -[LLOneBot](https://github.com/LLOneBot/LLOneBot) 相关的开发曾参与本项目 +## License +本项目采用 混合协议 开源，因此使用本项目时，你需要注意以下几点： +1. 第三方库代码或修改部分遵循其原始开源许可. +2. 本项目获取部分项目授权而不受部分约束 +2. 项目其余逻辑代码采用[本仓库开源许可](./LICENSE). -## 开源附加 - -任何使用本仓库代码的地方，都应当严格遵守[本仓库开源许可](./LICENSE)。**本仓库仅用于提高易用性，实现消息推送类功能，此外，禁止任何项目未经仓库主作者授权基于 NapCat 代码开发。使用请遵守当地法律法规，由此造成的问题由使用者和提供违规使用教程者负责。** +**本仓库仅用于提高易用性，实现消息推送类功能，此外，禁止任何项目未经仓库主作者授权基于 NapCat 代码开发。使用请遵守当地法律法规，由此造成的问题由使用者和提供违规使用教程者负责。**