<img src="https://napneko.github.io/assets/newnewlogo.png" width = "305" height = "411" alt="NapCat" align=right />
<div align="center">

# NapCat

_Modern protocol-side framework implemented based on NTQQ._

> Where clouds rise and winds are born, the heart yearns for distant lands yet untraveled.

English | [简体中文](./docs/README_zh-CN.md) | [繁體中文](./docs/README_zh-TW.md) | [日本語](./docs/README_ja.md) | [한국어](./docs/README_ko.md) | [Русский](./docs/README_ru.md) | [العربية](./docs/README_ar.md)

</div>

---

## Notice
NapCat is currently looking for a new primary maintainer. Please email nanaeonn@outlook.com if you are interested. No public community groups will be established during this period, but NapCat will continue to receive regular updates.

## Welcome

- NapCatQQ is a modern implementation of the Bot protocol based on NTQQ.

## Features

- **Easy to Use**
  - Beginners can get started effortlessly.
- **Quick and Efficient**
  - Runs for extended periods on low-memory systems.
- **Rich API Interface**
  - Fully implements most standard interfaces.
- **Stable and Reliable**
  - Continuous and stable development and maintenance.

## Quick Start

Download the latest version from the [Release](https://github.com/NapNeko/NapCatQQ/releases/) page.

**First-time users** should make sure to read the documentation below for a usage guide.

> This is a non-profit project. For integration issues, basic questions, or underlying framework issues, please search for solutions on your own — this project's community does not provide such support.

## Links

| 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/) |
|:-:|:-:|:-:|:-:|

| 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://napcat.top/) | [![NapCat.Top](https://img.shields.io/badge/docs%20on-NapCat.Top-red)](https://napcat.top/) |
|:-:|:-:|:-:|:-:|

| DeepWiki | [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/NapNeko/NapCatQQ) |
|:-:|:-:|

> Please do not mention this project in other communities (including other protocol-side or related application-side projects) to avoid disputes. If you have suggestions, please discuss them in the official group or submit a PR.

## Thanks

- [Lagrange](https://github.com/LagrangeDev/Lagrange.Core) — Great support for this project; some code was referenced (with permission)

- [AstrBot](https://github.com/AstrBotDevs/AstrBot) — An LLM Bot framework that perfectly integrates with this project

- [MaiBot](https://github.com/MaiM-with-u/MaiBot) — A cyber companion Bot framework

- [qq-chat-exporter](https://github.com/shuakami/qq-chat-exporter/) — A message export tool based on NapCat

- And most importantly, thank you — the person reading this right now~

---

## License

This project is open-sourced under a hybrid license. When using this project, please note the following:

1. Third-party library code or modified portions follow their original open-source licenses.
2. This project has obtained authorization from certain projects and is not subject to some restrictions.
3. The remaining logic code of the project is governed by the [repository license](./LICENSE).

**This repository is solely intended to improve usability and implement message push features. Furthermore, developing any project based on NapCat code without prior authorization from the repository's main author is prohibited. Please comply with local laws and regulations when using this project. Any issues arising from misuse are the responsibility of the user and anyone providing tutorials for unauthorized use.**
