NcatBot 文档

外观

项目配置

约 568 字大约 2 分钟

2025-01-23

项目结构介绍

项目整体文件架构如下：

  • config.yaml: 用于配置机器人的运行参数，包括WebSocket、HTTP、AI以及QQ账号等信息。
  • main.py: 主程序入口，定义了群聊消息的处理函数。
  • ncatbot目录: 包含了机器人的各种功能模块和处理逻辑，具体文件如下：
    • api.py: 定义了与NapCat进行交互的API接口。
    • bot.py: 定义了对接口进行扩展形成的ncatbot专属接口。
    • client.py: 实现了机器人的客户端逻辑，包括与NapCat的连接和消息处理。
    • gateway.py: 实现了消息网关的逻辑。
    • http.py: 实现了HTTP服务器的逻辑。
    • message.py: 定义了消息的处理逻辑和数据结构。
    • setting.py: 实现了配置文件的读取和解析。
    • status.py: 定义了机器人的状态管理逻辑。
    • user.py: 实现了与管理员和管理员指令相关的逻辑

以上就是项目的整体文件架构，希望对你了解项目有所帮助。

配置文件

首先打开config.yaml文件，根据下面的提示进行配置：

ws:
  protocol: ws       # 必填
  ip: 127.0.0.1      # 必填
  port: 3001         # 必填
  token:             # 选填

http:
  protocol: http     # 同理
  ip: 127.0.0.1
  port: 3000
  token:

ai:# 此部分选填，已经适配了openaiAPI，可以接入讯飞，kimi，质谱等大量ai模型
  base_url: 
  api_key: 
  model: # ai模型
  personality: # ai人格

qq:# 此部分必填
  bot: # 机器人账号
  user: # 管理员账号

nap_cat: 你的NapCat.Shell文件夹的路径地址，当然如果你没有下载的话，可以填入NapCat.Shell文件的下载地址，他将会自行下载，不过github需要国外网络环境，所以填入网址运行，请提前准备网络环境，否则会下载安装失败。

相关信息

如果你选择手动自行运行napcat，nap_cat这栏可以不用填写，如果你想要项目自启动napcat，你需要填写你的NapCat.Shell的文件夹地址，我在这里举个例子:nap_cat: C:\Users\yourpath\NapCat.Shell，当然，如果你电脑本地没有Napcat，那么你可以在nap_cat这一栏填入Napcat 的下载地址，例如：nap_cat: https://github.com/NapNeko/NapCatQQ/releases/download/v4.4.4/NapCat.Shell.zip，这样当项目运行后，napcat将会进行自动下载安装以及配置。

© 2025 NcatBot