shinxBot2

一个基于Lagrange.Onebot的(多)机器人管理框架，重构自shinxBot。

功能支持

• 恶臭数字论证器，来源：itorr

• 来点二次元。来源：dmoe

• 首字母缩写识别，来源：itorr

• 在群或私聊中生成一个假的转发信息

• 来点色图：随机色卡

• 赛博养猫（与 gpt3.5 共同创作）

• cat image for http code。来源httpcats

• 图片处理：对称、旋转、万花筒

• openai的 gpt-3.5-turbo API支持

• google的 gemini-pro[-vision] API支持，url

• 群友聊天截图保存功能（美图）

• 龙王提醒

• 群成员变动提醒

• 人云亦云（复读）

• 不同群聊，私聊的消息互相转发

• 灰名单管理

• 管理多个bot，并（以后）可以通过广播传递消息

文件结构

./src/functions		# 所有功能的代码
./src/inc			# 功能头文件
./src/interfaces	# 接口，所有功能继承这个类
./src/utils			# 一些工具
./lib/functions/	# bot功能的动态链接库目录
./lib/events/ 		# bot功能的动态链接库目录

运行Bot

本项目依赖以下软件包：

• libcurl
• openssl-dev / libssl-dev
• libjsoncpp
• libzip
• ImageMagick++ (version 7+)
• libmagick++-dev

除了使用docer运行，其他的运行方式请先安装依赖。具体安装方式可参考entrypoint.sh。

以下提供3种运行的方法：

1. 从Release中下载并解压，运行shinxbot

2. 克隆仓库，于根目录下执行docker compose up -d进行容器内自动配置并编译为可执行文件./shinxbot

   使用docker exec -it shinx-bot bash以进入容器终端，在容器内运行

3. 裸机编译后运行./shinxbot，详见下一节

运行前，请确保Onebot 11标准后端正在运行，运行shinxbot后port行请分别输入Onebot 11后端的上报端口及其API端口

可以使用start.sh以后台形式运行shinxbot

从源码编译

由于包含base64子模块，克隆仓库请启用--recursive

git clone --recursive [email protected]:Jayfeather233/shinxbot2.git

• Linux: 执行自动编译脚本build.sh （build.sh main构建所有（默认）；build.sh simple不重新构建libutils ）
• Windows: 需要更改TCP连接头文件，以及包括但不限于 sleep, file:/// 等操作系统层面差异（未经验证），推荐在容器中运行

注意：这仅仅只编译了bot的框架，具体功能还需编译 ./src/[functions|events] 中的代码：

如果需要编译所有功能，进入 ./src/[functions|events]，运行 python generate_cmake.py 对每个功能生成模版 CMakeLists.txt，再运行脚本 bash ./make_all.sh 来编译所有功能。

添加Bot

具体实现可以参考./src/bots中的mybot，是已经接好Onebot 11的类

• 所有bot需要继承./src/interfaces/bot.h中的bot类

• 在./config/port.txt中写入发送/接收端口

• 在./src/main.cpp的main()中加入add_new_bot(new yourbot(receive_port[id], send_port[id]));

添加功能

可参考一个最小开发集：shinxbot2_dev_module

如果在本仓库代码上开发，请确保已经用 ./build.sh 生成了 libutils.so。

以class mybot为例，functions传参仅为消息相关，events传入事件的JSON数据，在收到聊天消息的时候调用 functions 里的方法，在其他提示性消息的时候用 events 的方法。

1. ./src/functions 下新建目录并把代码放入，写一个类继承 ./src/interfaces/processable.h 中的类并实现virtual方法，并提供create方法得到功能processable*的指针（可以参考functions/getJapaneseImage/Anime_Img.cpp）

2. 继承的 virtual 方法里只要 check() 成功了就会执行 process() 方法

3. 在generate_cmake.py中有CMake模版，用其编译你的功能，自动生成动态链接库至./lib/functions/

4. 启动bot。如果bot正在运行可以使用管理员账号（op_list.json）发送bot.load [function|event] name 加载。

在运行bot之前，请确保 ./lib/functions | ./lib/events 里放入了功能的动态链接库，或者通过 generate_cmake.py & make_all.sh 来生成。

开发提示

1. 如果使用clang,根目录下.clang-format为你提供了自动格式化设置

2. dev_tools下的sender.sh可用于向shinxbot发送信息，inspector则截获shinxbot向Onebot11发送的数据。inspector不能与Onebot11同时运行。这两者在功能上等同于Onebot11，为无法运行Onebot11的开发环境提供了便利。（你可能需要更改inspector.cpp与sender.sh中的相关路径指向config文件） 例如：

bash sender.sh "bot.help"