NapCatQQ README

The project's README from github.com/NapNeko/NapCatQQ. As one markdown file: README.md.

NapCat

NapCat

Modern protocol-side framework implemented based on NTQQ.

云起兮风生,心向远方兮路未曾至.


New Framework ?

可以试试更新更好用的 SnowLuma 作为NapCat Gui替代品。

Welcome

Feature

Quick Start

可前往 Release 页面下载最新版本

首次使用请务必查看如下文档看使用教程

项目非盈利,涉及 对接问题/基础问题/下层框架问题 请自行搜索解决,本项目社区不提供此类解答。

Docs Github.IO Cloudflare.Worker Cloudflare.HKServer
Docs Cloudflare.Pages Server.Other NapCat.Top
QQ Group NapCat Family Group 4 NapCat Family Group 3 NapCat Family Group 2 NapCat Family Group 1
Telegram Telegram
DeepWiki Ask DeepWiki

QQ群因为特殊原因需要入群密钥,请在webui关于页面获取,仅最新的100个版本以内有效。

社区相关日后会进一步加强审核,并严格限制一定时间的入群人数,请具备一定编程基础和问题解决能力再申请入群。

困困猫猫的高中

Thanks


License

本项目采用 混合协议 开源,因此使用本项目时,你需要注意以下几点:

  1. 第三方库代码或修改部分遵循其原始开源许可.
  2. 本项目获取部分项目授权而不受部分约束
  3. 项目其余逻辑代码采用本仓库开源许可.

本仓库仅用于提高易用性,实现消息推送类功能,此外,禁止任何项目未经仓库主作者授权基于 NapCat 代码开发。使用请遵守当地法律法规,由此造成的问题由使用者和提供违规使用教程者负责。

NapCatQQ (NapNeko/NapCatQQ)

Searching Database…

What is this?NapCatQQ is a modern protocol-side implementation of the QQ bot protocol built on NTQQ: it turns a QQ account into a bot endpoint that external frameworks can drive through standard APIs.
Is this a ready-made chatbot, or something my bot framework plugs into?It is the protocol side, not the bot's brain: it implements most standard OneBot 11 interfaces, served over HTTP and WebSocket (express and ws in the code), so bot frameworks like AstrBot connect to it.
How do I get it running?Download the latest version from the Releases page and follow the docs tutorial - the README insists first-time users read it. Day-to-day management runs through the built-in WebUI.
How do I get into their QQ support group?You need an entry key shown on the WebUI About page, and it only works for the latest 100 versions. Membership is capped and audited, so basic problems are expected to be researched on your own.
Is it beginner friendly, or do I need coding experience?It is marketed as easy enough for beginners, but the community draws a line: it will not answer basic integration questions and expects applicants to have some programming and problem-solving ability.
Can I build my own project on top of NapCat's code?Not without permission. It is a mixed license: third-party parts keep their original licenses, the rest follows this repo's license, and projects based on NapCat code need the author's authorization. You must also comply with local laws.
What is SnowLuma?A newer GUI alternative the README recommends trying; it positions itself as a replacement for NapCat's GUI shell, not for the protocol core.
Which bot frameworks pair well with it?The README recommends AstrBot, an LLM bot framework it calls perfectly compatible, and MaiBot, a cyborg groupmate bot framework. qq-chat-exporter, a chat history export tool, is also built on NapCat.
Is it free to use?Yes - the project describes itself as non-profit with no paid plans. It adds that problems arising from use, and from violating-use tutorials, are the responsibility of the user under local laws.
Creator
NapNeko
Size
388.3 MB
Stars
11K
Age
2y
Commits · 90 Days