Community

​

Welcome to the NapCat Community

Join thousands of developers using NapCat to build amazing QQ bots!

​

QQ Community Groups

Get help, share your projects, and connect with other NapCat users in our official QQ groups.

​

Join Password

You can get the join password directly from the About page of the WebUI. Requirements:

• NapCat version >= 4.17.31
• Join key is only valid for the latest 100 versions
• If joining fails, please update to the latest version

​

Official Groups

​

NapCat Family Group 1

• Group ID: 1090875633
• Join Link: https://qm.qq.com/q/VwpnklcXqo
• Nickname: Happy Family

​

NapCat Family Group 2

• Group ID: 1059714215
• Join Link: https://qm.qq.com/q/gq18RH7o7S
• Nickname: Royal Relatives

​

NapCat Family Group 3

• Group ID: 1085662710
• Join Link: https://qm.qq.com/q/XyiyGPqa42
• Nickname: Loving Family

​

NapCat Family Group 4

• Group ID: 1085359803
• Join Link: https://qm.qq.com/q/E4nfkGD6oK
• Nickname: Joyful Family

​

Community Guidelines

​

What to Expect

The NapCat community is welcoming and helpful, but please note: This is a non-profit project. For integration issues, basic questions, or underlying framework issues, please search for solutions on your own — the community does not provide such support.

​

Best Practices

When asking for help:

1. Search first - Check if your question has been answered
2. Be specific - Describe your issue clearly with details
3. Include context:
   • NapCat version
   • NTQQ version
   • Operating system
   • Relevant configuration (remove sensitive tokens!)
   • Error messages
   • Steps to reproduce
4. Be patient - Community members volunteer their time
5. Be respectful - Follow the code of conduct
6. Give back - Help others when you can!

​

What Not to Ask

The community cannot help with:

• Basic programming questions (“How do I use Node.js?”)
• General integration tutorials (“How do I use Nonebot2?”)
• Third-party application issues
• Questions already answered in documentation

For these topics, please search online or consult the relevant project’s documentation.

​

Community Rules

1. Be respectful - Treat everyone with kindness and respect
2. Stay on topic - Keep discussions relevant to NapCat
3. No spam - Don’t post advertisements or off-topic content
4. No harassment - Zero tolerance for harassment of any kind
5. Follow the law - Comply with local laws and regulations
6. Don’t mention in other communities - Do not mention NapCat in other protocol-side or related application-side project communities to avoid disputes

​

Code of Conduct

NapCat follows the Contributor Covenant Code of Conduct. Reporting Violations Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to community leaders at [email protected].

​

Online Resources

​

Documentation

Access NapCat documentation at multiple locations:

• https://napneko.github.io/ - GitHub Pages
• https://doc.napneko.icu/ - Cloudflare Worker
• https://napcat.napneko.icu/ - Cloudflare HK Server
• https://napneko.pages.dev/ - Cloudflare Pages
• https://napcat.top/ - Primary domain

​

DeepWiki

Ask questions and get AI-powered answers:

• Ask DeepWiki

​

GitHub

• Repository: https://github.com/NapNeko/NapCatQQ
• Issues: https://github.com/NapNeko/NapCatQQ/issues
• Releases: https://github.com/NapNeko/NapCatQQ/releases

​

Contributing

Want to contribute to NapCat? We welcome:

• Code contributions - Bug fixes, features, improvements
• Documentation - Tutorials, guides, translations
• Bug reports - Help us identify and fix issues
• Community support - Answer questions, help others
• Feedback - Suggestions for improvement

See the Contributing Guide for more information.

​

Maintainer Opportunity

NapCat is currently looking for a new primary maintainer. If you’re interested in taking on this responsibility, please contact [email protected].

​

Projects Using NapCat

​

Official Integrations

AstrBot - An LLM Bot framework that perfectly integrates with NapCat

• https://github.com/AstrBotDevs/AstrBot

MaiBot - A cyber companion Bot framework

• https://github.com/MaiM-with-u/MaiBot

qq-chat-exporter - A message export tool based on NapCat

• https://github.com/shuakami/qq-chat-exporter/

​

Compatible Frameworks

NapCat implements the OneBot 11 protocol and works with:

• Nonebot2 - Python bot framework
• Koishi - Cross-platform bot framework
• go-cqhttp compatible applications - Most apps supporting OneBot 11
• And many more!

​

Share Your Project

Built something cool with NapCat? Share it in the community groups! We love seeing what you create.

​

Language Support

​

Documentation Languages

Documentation is available in multiple languages:

• English - README.md
• 简体中文 (Simplified Chinese) - README_zh-CN.md
• 繁體中文 (Traditional Chinese) - README_zh-TW.md
• 日本語 (Japanese) - README_ja.md
• 한국어 (Korean) - README_ko.md
• Русский (Russian) - README_ru.md
• العربية (Arabic) - README_ar.md

Help translate the documentation! See Contributing Guide.

​

Community Languages

The primary community language is Chinese, but English speakers are welcome! Use translation tools if needed.

​

Stay Updated

​

GitHub Releases

Watch the GitHub repository to get notified of new releases:

1. Go to NapCatQQ on GitHub
2. Click “Watch” → “Custom” → “Releases”
3. Get notified of new versions

​

Community Announcements

Important announcements are posted in:

• QQ community groups
• GitHub releases
• Project README

​

Getting Help

​

Self-Help Resources

1. Documentation - Read the docs thoroughly
2. FAQ - Check frequently asked questions
3. Troubleshooting - Review the troubleshooting guide
4. GitHub Issues - Search existing issues
5. Search engines - Google your error messages

​

Community Support

If you can’t find an answer:

1. Join a community group (see above)
2. Describe your issue clearly
3. Include all relevant information
4. Be patient and respectful
5. Thank those who help you!

​

Commercial Support

NapCat is a non-profit open-source project. There is no official commercial support. All support comes from the volunteer community.

​

Acknowledgments

NapCat would not be possible without:

​

Referenced Projects

Lagrange - Great support for this project; some code was referenced (with permission)

• https://github.com/LagrangeDev/Lagrange.Core

​

The Community

And most importantly, thank you — the person reading this right now! Your interest and contributions make NapCat better for everyone.

​

Contact

​

Project Maintainer

Email: [email protected] Contact for:

• Becoming a maintainer
• Authorization requests
• Code of Conduct violations
• Security issues

​

General Questions

For general questions:

• Join the community QQ groups
• Open a GitHub issue
• Search existing documentation

​

Legal and Compliance

​

License

NapCat is open-sourced under a hybrid license:

• Third-party library code follows their original licenses
• Authorized projects have special permissions
• Remaining code is governed by the repository license

See LICENSE for details.

​

Usage Restrictions

Important: Developing any project based on NapCat code without prior authorization from the repository’s main author is prohibited.

​

Legal Compliance

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.

​

Dispute Avoidance

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 groups or submit a PR.

​

Join Us!

Ready to join the NapCat community?

1. Install NapCat - Getting Started Guide
2. Join a QQ group - Get the password from WebUI
3. Introduce yourself - Tell us what you’re building
4. Start developing - Build something awesome
5. Give back - Help others and contribute

Welcome to NapCat! We’re excited to see what you create.

---

​

Next Steps

• Installation Guide
• Configuration Guide
• API Reference
• Contributing Guide
• FAQ