本项目 基于 koishi 开发,运行于 Node.js 环境。
Ruri机器人目前以下几个功能:
-
你问我答
-
音乐推送:每日10点推送随机网易云音乐歌曲(歌曲来源是自定义的用户喜欢列表),也可以使用指令触发随机推送或根据id推送音乐
-
图片推送
-
语音推送
更多功能请期待后续更新
运行项目前,需要自行安装和配置 Node.js ,CoolQ 和 CQHTTP, Mongodb环境。 其中CoolQ 和 CQHTTP的安装可以参考HoshinoBot部署指南
以上环境安装成功后,将 default_config
文件夹改名为config
文件夹。
然后修改start.config.js
中的字段,字段含义请参考koishi
到这里就可以尝试使用node start.js
来启动机器人,如在log中看到输出成功,那么恭喜你,机器人已经初步启动了
由于本机器人目前依赖于Mongodb做数据持久化,因此接下来需要安装启动mongodb
,相关方法请自行baidu。mongodb
启动成功后,到init/index.js
文件夹下修改以下代码
mongoose.connect('mongodb://localhost(:端口号,默认可以不用填)/你数据库名', {
useNewUrlParser: true,
useUnifiedTopology: true
})
此时重启机器人,如果log中出现MongoDB 连接成功,代表机器人已经可以正式运行了。
除此之外,机器人运行中有一些额外参数可以设置。这些设置都在config/running.config.js
下。相关字段含义已在文件中说明,请自行查看。
- 本机器人的功能全部基于qq群开发,请将机器人拉至同一群中再进行功能尝试。
- 本机器人使用了koishi的插件式开发,各个插件均可自行开关。
- 如要使用各个插件,需先至
plugins
文件夹下,将对应模块下的defaut.config.js
重命名为config.js
。并且自行配置各个字段。 - 语音推送插件原本是为了推送VTB兔田佩克拉的语音而写的,通过简单的修改也可推送其他语音文件。插件文件夹中附带了一份
voice.json
数据,该数据来源于peko-button,相关语音资源也可到该项目下查找。 - 音乐推荐中使用了NeteaseCloudMusicApi获取网易云音乐相关数据。
tools
文件夹下已经附带,无需另外安装。