關于 Tsugu V4.0 與 Koishi插件

????????2023年3月15日,BanG Dream!日服推出了大更新 (https://anniv-bang-dream.bushimo.jp/6th/update/),推出了很多例如5星,3d Live之類的很多內容。
????????與此同時,這次更新的內容太大,老版本的Tsugu已經(jīng)不能只是修修補補就追上新版本的進度了,之前版本的Tsugu在運行的時候會因為新舊版本API區(qū)別太大而無法運行。所以在這段時間,Tsugu進行了徹底的重寫,并且使用了Koishi框架 (https://koishi.chat/zh-CN/),提高兼容性。

? ? ? ? Koishi是一個跨平臺、可擴展、高性能的 node.js 機器人框架,可以在很多種設備,比如windows,android設備 或者 linux 與 MacOS?的系統(tǒng)上運行,有很多開發(fā)者提供各種插件和適配器。新版本的Tsugu是作為koishi的插件開發(fā)的,并且koishi插件和真正的后端是分離的。大家可以去在安裝koishi后安裝 tsugu-bangdream-bot 插件來使用Tsugu。Tsugu的功能可以與其他插件共存,以創(chuàng)造更多功能的機器人。

? ? ????如果只是安裝插件的話,默認的后端服務器設置的是Tsugu的公開服務器,bot會在需要繪圖的時候訪問Tsugu服務器進行繪制。這樣雖然方便,但是在Tsugu服務器宕機的時候,所有需要繪圖的功能都會失效。如果想要在Tsugu宕機的時候依然功能正常,可以試著自己部署繪圖后端,詳細內容會在后面提到。
????????同時因為使用了Koishi框架,大家可以把Tsugu部署在更多的平臺,比如微信,飛書,kook與discord等 (甚至可以與Tsugu互發(fā)郵件),但是目前還沒有在除了onebot適配器以外的其他平臺進行過測試。同時Koishi似乎做到兼容python框架 'nonebot',可以在Koishi框架中使用來自nonebot的插件。

? ????? 同時,新版本Tsugu徹底重新設計了界面,使用了參考BanG Dream! 6周年的設計語言,并且為多服務器支持優(yōu)化了界面。其中一些功能的背景圖片會隨著內容而變化,但是會降低圖片生成速度,是否使用華麗的背景在插件控制臺可以選擇開關。
????????新版本Tsugu完全兼容了5個服務器(國服,日服,臺服,韓服與國際服),可以使用 '設置默認服務器' 調整服務器列表 ('設置默認服務器 cn jp'指令會讓界面顯示國服與日服信息) 與'國服模式' ('日服模式'等類似指令同理) 來設置默認服務器,同時綁定玩家等功能也支持了所有類型的服務器。

????????這次Tsugu是徹底重寫,大部分功能都已經(jīng)被移植到了新版本,并且重新優(yōu)化了界面。但是因為Koishi對指令的要求比較嚴格,所以一些指令的使用方式發(fā)生了變化。最明顯的一點是,所有指令與參數(shù)之間必須添加空格 ('ycx100'將不可應,請使用'ycx 100',需要在ycx與100中間添加空格,才會被識別為指令。) 可以使用 'help'?指令來調出使用說明列表,help+對應的指令可以查詢指令的詳細說明與使用示例。其中< >中的為必選參數(shù),[ ]中的為可選參數(shù)。


????????最新版本的Tsugu是一個開源項目,大家可以才倉庫看到最新的更新進度,也歡迎大家來給新版本的Tsugu添磚加瓦!
使用說明
????????首先,請去koishi.chat下載你的設備對應的版本的koishi
????????在安裝完成之后,通過以下教程來連接到自己的qq號,只有這樣才能在qq部署機器人。如果不是在qq使用的話,請安裝對應平臺的adapter


????????在連接到qq或者其他adapter之后,請安裝tsugu-bangdream-bot插件,并且啟用該插件


后端部署教程
????????大家可能注意到設置的參數(shù)中有一個backendUrl選項,這個就是Tsugu需要的后端的地址。這個選項的默認地址是Tsugu的服務器的地址,運行在Tsugu服務器上供大家使用。但是Tsugu的服務器可能并不是在所有時間都穩(wěn)定,所以有條件的話推薦自己部署后端。同時有能力的話,你也可以把你的后端放到公網(wǎng),供其他人使用。

????????目前Tsugu還在不斷完善的階段,后端可能隨時會有更新,如果要自己部署的話,可以使用tsugu的倉庫來保持隨時更新。
????????首先,請確保你安裝了node.js v18,目前Tsugu開發(fā)時的環(huán)境為v18.16.0
????????在這個基礎上,請安裝ts-node,可以安裝pm2來保證穩(wěn)定性
????????后端在Tsugu倉庫的/backend目錄,請安裝對應的依賴
????????直接運行tsugu后端,或者使用命令行運行tsugu后端