dicergirl 3.5.1rc1

新一代跨平台开源 TRPG 骰娘框架

DicerGirl

介绍

Noctisynth DicerGirl 是新一代跨平台开源 TRPG 骰娘框架, 公测 QQ 群号：770386358.

安装

Nonebot2原生安装

所有支持 Python3 的操作系统(包括 Windows)均可以安装 DicerGirl.

在使用原始方法安装DicerGirl, 请先确保你已经安装了Python3并正确配置环境变量.

如果你已有Nonebot2项目, 请在Nonebot2项目中使用指令:

nb plugin install dicergirl

如果你尚未创建Nonebot2项目, 请先确保你已正确安装nb-cli:

pip install nb-cli

并使用nb-cli创建项目:

nb create -t bootstrap

适配器与驱动器的选择参考你希望使用的适配器，例如OneBot V11的驱动器请选择FastAPI、HTTPX与websockets, QQ适配器请选择HTTPX、websockets与AIOHTTP.

创建完成后, 在生成的项目目录中执行:

nb plugin install dicergirl
nb run --reload --reload-delay 2

Nonebot2 的项目创建与插件增删详见Nonebot CLI.

Windows 快速部署

下载最新版的Dicergirl Installer安装包, 安装完成后 DGI 会自动部署 DicerGirl, 你可以在终端中提示的https://127.0.0.1:{port}/go-cqhttp/中配置 QQ 账号.

其中, {port}为随机的端口号.

网页版go-cqhttp基于nonebot-plugin-gocqhttp.

但值的注意的是, DGI 目前仅适用于 Windows 系统, 且它目前正在加急适配QQ协议中.

使用教程

你可以在部署完成后, 在相应的平台中发送消息.help或/help(QQ 协议)来查看使用方法.

详细的使用方法见使用.

跑团模块系统

支持的跑团模式

COC	DND	SCP
dicergirl-plugin-coc	dicergirl-plugin-dnd	dicergirl-plugin-scp
✅	✅	✅

DicerGirl作为Nonebot2插件存在, 如果你熟悉Nonebot2, 你可以使用如下方法直接安装:

pip install nb-cli
nb create -t bootstrap
nb plugin install dicergirl

你可以选择安装其它 DicerGirl 跑团模块:

pip install dicergirl-plugin-scp
pip install dicergirl-plugin-coc
pip install dicergirl-plugin-dnd
pip install dicergirl-plugin-hsr

你同样可以安装第三方插件, 但 Noctisynth 不对其稳定性和安全性负责.

跨平台支持

DicerGirl 依赖于Nonebot2, 这使得它可以跨平台工作. 除此之外,Nonebot2支持的大多平台都 DicerGirl 被支持.

nb adapter install nonebot-adapter-onebot  # 使用Onebot协议
nb adapter install nonebot-adapter-qqguild  # 使用QQ协议

注意

在 Nonebot2 中使用 DicerGirl 建议不要使用nonebot-plugin-helper, 这可能使得.help指令与其冲突.

漏洞或建议提交

如果你对于 DicerGirl 有建议或发现漏洞, 请在issues中提交你的建议.

特别鸣谢

• Nonebot2 @yanyongyu
• go-cqhttp @Mrs4s
• nonebot-plugin-cocdicer @abrahum

骰娘公测群

公测 QQ 群号：770386358

发电作者

作者前几天刚弄的爱发电，如果你和作者一样穷困潦倒（x），就给这个项目送个 Star 吧！

版权声明

此项目以 Apache-2.0 协议开源, 使用代码时, 请注意遵照开源协议.