mirror of https://github.com/NapNeko/NapCatQQ.git synced 2025-12-18 20:30:08 +08:00

Modern protocol-side framework implemented based on NTQQ

Go to file

手瓜一十雪 652b5d6118 Enhance GrayTip JSON event handling and types Added the XmlToJsonParam interface and extended the GrayTipElement type to support additional JSON event fields. Updated group API logic to handle busiId as string or number and improved event type checks for robustness.		2025-11-03 23:11:48 +08:00
.github	ci: dispatch docker build workflow after release (#1078 )	2025-06-15 23:26:17 +08:00
.vscode	refactor: 优化eslint配置，提升代码质量 (#1341 )	2025-11-03 16:30:45 +08:00
external	feat: Update QQ version data and add macOS ARM64 native module	2025-10-14 20:32:41 +08:00
launcher	Update qqnt.json to version 9.9.22-40990	2025-10-31 00:11:28 +08:00
napcat.webui	refactor: 优化eslint配置，提升代码质量 (#1341 )	2025-11-03 16:30:45 +08:00
script	feat: 移除无用代码	2024-11-16 12:45:27 +08:00
src	Enhance GrayTip JSON event handling and types	2025-11-03 23:11:48 +08:00
.editorconfig	refactor: 优化eslint配置，提升代码质量 (#1341 )	2025-11-03 16:30:45 +08:00
.env.framework	fix: typo	2024-08-10 17:51:25 +08:00
.env.shell	build: V2.0.0 fast	2024-08-12 02:37:20 +08:00
.env.shell-analysis	Pr enhance (#1176 )	2025-08-06 20:37:45 +08:00
.env.universal	feat: Universal Package (#578 )	2024-11-29 15:11:35 +08:00
.gitignore	feat: package	2025-06-26 18:32:31 +08:00
CODE_OF_CONDUCT.md	doc: code of conduct	2025-03-16 09:33:06 +08:00
eslint.config.mjs	refactor: 优化eslint配置，提升代码质量 (#1341 )	2025-11-03 16:30:45 +08:00
LICENSE	update: Limited Redistribution License	2024-11-23 18:52:53 +08:00
logo.png	feat: 调整logo	2024-12-25 12:24:03 +08:00
manifest.json	release: v4.9.21	2025-11-02 13:33:28 +00:00
package-lock.json	refactor: 优化eslint配置，提升代码质量 (#1341 )	2025-11-03 16:30:45 +08:00
package.json	refactor: 优化eslint配置，提升代码质量 (#1341 )	2025-11-03 16:30:45 +08:00
README.md	refactor: 优化eslint配置，提升代码质量 (#1341 )	2025-11-03 16:30:45 +08:00
SECURITY.md	doc: security	2025-03-16 09:36:27 +08:00
tsconfig.json	refactor: 优化eslint配置，提升代码质量 (#1341 )	2025-11-03 16:30:45 +08:00
vite-plugin-performance-monitor.ts	Add explicit type annotations to AST traversal paths	2025-08-15 19:02:53 +08:00
vite.config.ts	refactor: 重构目录删除旧支持	2025-10-30 10:08:32 +08:00

README.md

NapCat

Modern protocol-side framework implemented based on NTQQ.

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

New Feature

在 v4.8.115+ 版本开始

NapCatQQ 支持 Stream Api
NapCatQQ 推荐 message_id/user_id/group_id 均使用字符串类型

[1] 解决 Docker/跨设备/大文件的多媒体上下传问题
[2] 采用字符串可以解决扩展到int64的问题，同时也可以解决部分语言（如JavaScript）对大整数支持不佳的问题，增加极少成本。

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 页面下载最新版本

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

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

Development Guide

代码提交前检查

在提交代码前，必须执行以下命令进行代码检查：

# 1. 代码格式化修复
npm run lint:fix

# 2. TypeScript 类型检查
npm run tsc

关于 TypeScript 类型检查

执行 npm run tsc 时，会出现 22 个已知的第三方库类型错误，这是正常现象：

Found 22 errors in 3 files.

Errors  Files
     3  node_modules/@homebridge/node-pty-prebuilt-multiarch/src/eventEmitter2.ts:42
     2  node_modules/@homebridge/node-pty-prebuilt-multiarch/src/terminal.ts:158
    17  node_modules/@napneko/nap-proto-core/NapProto.ts:94

这些错误是由于启用了严格类型检查模式导致的第三方库内部类型问题，不影响项目运行。

⚠️ 注意：除了上述 22 个已知错误外，不应该出现其他类型错误。如果有新的错误，请在提交前修复。