# Technical Documentation: NapNeko/NapCatQQ

> ℹ️ **Provenance:** In-Tree Documentation (3 Chapters) · [CodeWiki Reference](https://codewiki.google/github.com/NapNeko/NapCatQQ) · Recency: Active (< 180 days)

## File: README.md

---

## New Framework ?

可以试试更新更好用的 [SnowLuma](https://github.com/SnowLuma/SnowLuma) 作为NapCat Gui替代品。

## 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

| Docs | [](https://napneko.github.io/) | [](https://doc.napneko.icu/) | [](https://napcat.napneko.icu/) |
|:-:|:-:|:-:|:-:|

| Docs | [](https://napneko.pages.dev/) | [](https://napcat.top/) | [](https://napcat.top/) |
|:-:|:-:|:-:|:-:|

| QQ Group | [](https://qm.qq.com/q/E4nfkGD6oK) | [](https://qm.qq.com/q/XyiyGPqa42) | [](https://qm.qq.com/q/gq18RH7o7S) | [](https://qm.qq.com/q/VwpnklcXqo) |
|:-:|:-:|:-:|:-:|:-:|

| Telegram | [](https://t.me/napcatqq) |
|:-:|:-:|

| DeepWiki | [](https://deepwiki.com/NapNeko/NapCatQQ) |
|:-:|:-:|

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

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

[困困猫猫的高中](https://qm.qq.com/q/14aUVclRUA)

## Thanks

- [Lagrange](https://github.com/LagrangeDev/Lagrange.Core) 对本项目的大力支持 参考部分代码 已获授权

- [AstrBot](https://github.com/AstrBotDevs/AstrBot) 是完美适配本项目的LLM Bot框架 在此推荐一下

- [MaiBot](https://github.com/MaiM-with-u/MaiBot) 一只赛博群友 麦麦 Bot框架 在此推荐一下

- [qq-chat-exporter](https://github.com/shuakami/qq-chat-exporter/) 基于NapCat的消息导出工具 在此推荐一下

- 不过最最重要的 还是需要感谢屏幕前的你哦~

---

## License

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

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

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

---

## File: CODE_OF_CONDUCT.md

# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
  and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
  overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
  advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
  address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
  professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
nanaeonn@outlook.com.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior,  harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.

---

## File: package.json

{
  "name": "napcat",
  "private": true,
  "type": "module",
  "version": "0.0.1",
  "scripts": {
    "build:shell": "pnpm --filter napcat-shell run build || exit 1",
    "build:shell:dev": "pnpm --filter napcat-shell run build:dev || exit 1",
    "build:shell:config": "pnpm --filter napcat-shell run build && pnpm --filter napcat-develop run copy-env",
    "build:framework": "pnpm --filter napcat-framework run build || exit 1",
    "build:webui": "pnpm --filter napcat-webui-frontend run build || exit 1",
    "build:plugin-builtin": "pnpm --filter napcat-plugin-builtin run build || exit 1",
    "build:openapi": "pnpm --filter napcat-schema run build:openapi || exit 1",
    "dev:shell": "pnpm --filter napcat-develop run dev || exit 1",
    "typecheck": "pnpm -r --if-present run typecheck",
    "test": "pnpm --filter napcat-test run test",
    "test:ui": "pnpm --filter napcat-test run test:ui",
    "lint": "eslint .",
    "lint:fix": "eslint . --fix"
  },
  "devDependencies": {
    "@rollup/plugin-node-resolve": "^16.0.3",
    "@vitejs/plugin-react-swc": "^4.2.2",
    "@vitest/ui": "^4.0.9",
    "eslint": "^9.39.1",
    "neostandard": "^0.12.2",
    "typescript": "^5.3.0",
    "vite": "^6.4.1",
    "vite-plugin-cp": "^6.0.3",
    "vitest": "^4.0.9"
  },
  "dependencies": {
    "express": "^5.0.0",
    "ws": "^8.18.3"
  }
}

--- METRICS ---
- Files Extracted: 3
- Estimated Token Budget: ~2512 tokens
- Recency Window: Active (< 180 days)
- Canonical Reference: https://codewiki.google/github.com/NapNeko/NapCatQQ