✨ BanG Dream！少女乐团派对 多功能 BOT ✨

Koishi

Koishi 是一个跨平台、可扩展、高性能的聊天机器人框架

本仓库根目录部分为 Koishi 前端插件, 插件基于 Koishi 内置指令系统开发, 原生支持跨平台使用.
插件可以在 Koishi 插件市场中安装.

得益于前后端分离的设计, 除了官方的 Koishi 插件外, 社区还提供了其余主流平台的插件支持

NoneBot

NoneBot2 是一个现代、跨平台、可扩展的 Python 聊天机器人框架

nonebot-plugin-tsugu-bangdream-bot 是由 WindowsSov8 维护的 NoneBot2 前端插件, 旨在于 NoneBot 上还原 koishi-plugin-tsugu-bangdream-bot 的行为.
基于 tsugu-api-python 实现后端的连接, 基于 NoneBot-Plugin-Alconna 和 nonebot-plugin-userinfo 实现跨平台支持.
插件可以在 NoneBot 插件商店中通过以下命令安装.

nb plugin install nonebot-plugin-tsugu-bangdream-bot

Entari

Entari 是 Arclet Project 下一个基于 Satori 协议的即时通信框架

entari-plugin-tsugu 是由 kumoSleeping 维护的 Entari 前端插件, 由 Python 编写,直接集成了 tsugu-b3, 基于 tsugu-api-python 实现后端的连接, 基于 Alconna 的命令匹配系统.
本插件同时为 QQ官方机器人 提供支持, 为适配平台限制与其造成的用户需求, 行为上与主分支版本稍有差异.
插件可以通过 Python 包管理器安装

pip install entari-plugin-tsugu

通常情况下, 如果您是分布式部署用户, Tsugu 后端不是必须部署的, 当您默认部署好前端插件时, 将会先使用公共API.
即使选择自建后端, 但我们仍然建议您使用在User服务部分使用公共API, 这样可以让用户体验到任何Tsugu客户端一次绑定, 多处使用的便利性.

Tsugu 后端位于本仓库的 backend 目录下.

git clone [email protected]:Yamamoto-2/tsugu-bangdream-bot.git
cd tsugu-bangdream-bot
cd backend

后端部署需要 NodeJS 18+ 环境以及 npm 等包管理工具

Tsugu 后端服务独立启动前需要进行 npm install 安装依赖项, 其中值得注意的是, 在安装过程中, 请保证您的终端可以正常拉取 Github Release 的资源, 否则会导致 pre-build 的包无法安装, 此时npm 会选择第二种方案: 编译安装

如果您选择让 npm 自动进行编译安装, 在部分环境下 skia-canvas 的编译耗时可能特别特别长, 如果您系统没有 rust 与基础的 C/C++ 编译环境, 也会直接安装失败.

安装依赖

npm install --verbose

启动后端

npm start

部署完成后会默认开在 3000 端口, 根据选择的前端插件的配置方式, 将后端地址指向您自部署的后端地址即可.

使用 PM2 进行管理

npm install -g pm2
pm2 start ecosystem.config.js

• 后端 API
• ...