🤖 W1ndysBotFrame

W1ndysBotFrame，一款基于 NapCat 和 Python 开发的机器人程序。

本项目已发布 3.0 版本，经过了彻底重构，欢迎使用！如有任何问题，请提交 issue 或联系作者

食用/部署（⚙️ 配置说明）

在 app/.env.example 中配置系统变量，完成配置后，删除.example后缀，app/config.py文件会从这里读取环境变量:

配置项说明

• OWNER_ID: 机器人管理员 QQ 号
• WS_URL: WebSocket 连接地址
• TOKEN: 认证 token(可选)
• FEISHU_BOT_URL: 飞书机器人 URL(可选)
• FEISHU_BOT_SECRET: 飞书机器人 Secret(可选)

配置后，运行app/main.py

✨ 功能说明

• ❤️ 每次心跳检测机器人是否在线
• 📢 支持掉线后自动发送通知到飞书
• 🔌 模块动态加载，无需侵入式修改代码
• 🔒 每个群可以单独控制功能的开启/关闭
• 🔐 每个私聊功能可以单独控制功能的开启/关闭
• ⏰ 支持定时任务
• 🔄 支持自动撤回自己发送的消息
• 📨 支持私聊转达到OWNER管理员
• 📝 支持日志记录，自动清理 7 天前的日志(可以在 app/utils/clean_logs.py 中修改)
• 🧩 提供了示例模块，功能模块可以独立开发和管理

🛠️ 开发说明

新功能开发请参考 app/modules/Template 目录的示例，如需为社区提供功能，请在你自己的仓库中创建一个模块，命名为W1ndysBotFrame-Module-<功能名>，以便于框架用户可以快速搜索到你的模块，如需基于本框架完全开发，则可以直接 fork 本项目所有文件基于示例模块开发即可，开源协议为 GPL-3.0，请注意遵守开源协议，禁止将本项目用于非法用途，本项目仅用于学习交流。

• 数据存储请在 app/data 下创建对应目录，使用os.path.join("data", "其他目录", "文件名") 获取路径
• 如需定时撤回消息，请在发送消息 API 的note参数中传入del_msg=秒数，例如del_msg=10
• 获取 rkey 的实现在app/core/nc_get_rkey.py中，框架会每 10 分钟请求一次，获取 rkey 并保存到app/data/Core/nc_get_rkey.json中
• 同步 for 循环操作中，for 循环数量较大时，建议添加异步等待，或分批处理，可以使用asyncio.sleep(秒数)来等待以暂时交出控制权，不要使用time.sleep(秒数)，否则会导致阻塞，

更新方法

克隆新版本，覆盖原文件，重新运行即可

（注意备份好数据、日志、配置文件、自己开发的功能等，建议使用 git 管理，或复制新目录再覆盖）

git clone https://github.com/W1ndys/W1ndysBotFrame.git

🌟 星标历史