dicergirl 3.4.0a3

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

DicerGirl

介绍

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

版本特性

使用Nonebot2 Onebot v11部署, 支持增删跑团模式.

此项目目前已支持自定义跑团模块, 详见开发.

该项目公测 QQ 群号：770386358

安装教程

Windows 快速部署

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

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

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

但值的注意的是, DGI 目前仅适用于 Windows 系统.

Linux/MacOS/Other

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

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

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

nb plugin install dicergirl

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

pip install nb-cli

并使用nb-cli创建项目:

nb create -t bootstrap

驱动器请选择FastAPi、HTTPX与websockets, 适配器请选择OneBot V11.

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

nb plugin install dicergirl
nb run --reload

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

使用教程

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

详细的使用方法见使用.

跑团模块系统

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

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

跨平台支持

DicerGirl 依赖于 Nonebot2, 这使得它可以跨平台工作. 除此之外, Onebot v11 以及 Nonebot2 支持的任何通讯平台都被支持.

nb adapter install nonebot-adapter-onebot
nb adapter install nonebot-adapter-qqguild

注意

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

漏洞或建议提交

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

特别鸣谢

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

骰娘公测群

公测 QQ 群号：770386358

版权声明

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