NCATBOT

项目文档 & 插件社区

ncatbot 是基于 OneBot11 协议的 Python SDK，它提供了一套方便易用的 Python 接口，用于开发 QQ 机器人。

项目特性

• 快速上手：简洁的API设计，轻松构建机器人
• 高度扩展：支持插件系统，满足各种需求
• 功能丰富：支持群聊、私聊、消息转发等多种场景
• 安全可靠：完善的错误处理和权限控制
• 文档完善：详细的文档和丰富的示例

项目归属

本项目归属于 ncatbot项目组 所有

联系我们

1. 联系邮箱：ncatbot@qq.com
2. 技术交流：ncatBot官方群组
3. 娱乐交流：ncatBot娱乐群组

快速开始

安装

pip install ncatbot

基础使用

from ncatbot.core import BotClient, GroupMessage, PrivateMessage
from ncatbot.utils import ncatbot_config, get_log

_log = get_log()

# 配置机器人参数
ncatbot_config.set_bot_uin("123456")  # 设置 bot qq 号 (必填)
ncatbot_config.set_root("123456")  # 设置 bot 超级管理员账号 (建议填写)
ncatbot_config.set_ws_uri("ws://localhost:3001")  # 设置 napcat websocket server 地址
ncatbot_config.set_ws_token("napcat_ws")  # 设置 token (websocket 的 token)
ncatbot_config.set_webui_uri("http://localhost:6099")  # 设置 napcat webui 地址
ncatbot_config.set_webui_token("napcat_webui")  # 设置 token (webui 的 token)

bot = BotClient()

@bot.on_group_message()
async def on_group_message(msg: GroupMessage):
    _log.info(msg)
    if msg.raw_message == "测试":
        await msg.reply(text="NcatBot 测试成功喵~")

@bot.on_private_message()
def on_private_message(msg: PrivateMessage):
    _log.info(msg)
    if msg.raw_message == "测试":
        bot.api.post_private_msg_sync(msg.user_id, text="NcatBot 测试成功喵~")

if __name__ == "__main__":
    bot.run()

如何使用

• 认真阅读本项目文档
• 使用 Docker 部署

获取帮助

遇到任何困难时，请先按照以下顺序尝试解决：

1. 仔细阅读文档
2. 询问 Gemini, Kimi 等人工智能
3. 搜索本项目的 Issue 列表

如果以上方法都无法解决你的问题，那么：

1. 在 Issue 列表 发 Issue 求助
2. 加入我们的官方QQ群提问

使用限制

1. 严禁将本项目以任何形式用于传播淫秽、反动或暴力等信息。
2. 未经授权，禁止将本项目以任何形式用于盈利。

致谢

感谢 NapCat 提供底层接口 | IppClub 的宣传支持 | Fcatbot 提供代码和灵感

感谢 林枫云 提供服务器支持

参与贡献

如果在你使用过程中遇到问题，或有任何建议，欢迎在 GitHub Issues 中反馈。欢迎给本 Repo 贡献代码！请先阅读 贡献指南。感谢你的支持！

---