Files
vcbot-napcat/README.md
2025-07-05 18:33:27 +08:00

72 lines
2.4 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 🤖 vcbot-napcat 基于 NapCat 的 Velocity QQ 机器人
---
一款基于 NapCat 构建的 QQ 机器人,对接 Velocity 服务器。支持在线查询、玩家绑定、全服喊话等功能
[QQ交流群](https://qm.qq.com/q/ngLB6lVX3i)
## 🚀 主要功能
- ✅ 入群欢迎消息
- 🚪 退群提醒
- 🤝 自动添加好友
- 📡 列出服务器在线人数
- 🔍 查询指定玩家是否在线
- 🔐 绑定游戏账户
- 📢 全服广播喊话
\[开发中功能\]
- 使用/find @用户 查找玩家知否在线
- 智能问答
## 🛠️ 部署指南
### 环境要求
安装python > 3.9
### 安装步骤
1. 下载本项目最新源码:
```
git clone https://github.com/xyit2025/vcbot-napcat.git
```
2. 安装依赖库
3. 运行 main.py
vc插件请见 [GitHub - xyit2025/vcapi](https://github.com/xyit2025/VelocityAPI)
## 配置
配置文件:
```toml
#napcat配置
bot_qq = 123456 #机器人q号
root_qq = 1234567 # 管理员q号
ws_uri = "ws://localhost:3001" # ws 地址, 可自定义端口, 默认 3001
webui_uri = "http://localhost:6099" # webui 地址, 可自定义端口, 默认 6099
webui_token = "napcat" # webui 令牌, 默认 napcat
ws_token = "" # ws_uri 令牌, 默认留空
ws_listen_ip = "localhost" # ws_uri 监听 ip, 默认 localhost 监听本机,监听全部则配置 0.0.0.0
remote_mode = false # 是否远程模式, 即 NapCat 服务不在本机运行 psncatbot官方已废弃该参数
# 功能配置
allowed_groups = "all" # 授权群聊all为全部eg[123456789, 987654321]
allowed_users = "all" # 授权用户all为全部eg[123456789, 987654321]
velocity_ip = "127.0.0.1" # velocity ip
velocity_port = 8080 # velocity port
velocity_token = "your velocity_token" #`velocity token
friend_auto = true # 好友自动同意
group_auto = true # 无作用
group_welcome = true # 入群欢迎
group_welcome_message = "!at 欢迎加入本群,使用@bot /help获取此bot帮助" # 入群消息 !at 为@加群用户
group_leave = true # 退群提醒
group_leave_message = "用户{userid}退群了" # 退群消息 {userid}为退群用户id
```
## 参与开发
由于部分原因我们的代码均在私有git开发。
如希望参与开发请联系我们