https://github.com/ljzd-pro/nonebot-plugin-dg-lab-play
nonebot2 机器人插件 - ⚡在群里和大家一起玩郊狼吧！⚡
https://github.com/ljzd-pro/nonebot-plugin-dg-lab-play
chatbot dg-lab dg-lab-v3 dodo feishu kaiheila nonebot nonebot2 onebot onebot11 onebot12 red telegram
Last synced: 15 days ago
JSON representation
nonebot2 机器人插件 - ⚡在群里和大家一起玩郊狼吧！⚡
- Host: GitHub
- URL: https://github.com/ljzd-pro/nonebot-plugin-dg-lab-play
- Owner: Ljzd-PRO
- License: bsd-3-clause
- Created: 2024-05-21T17:34:30.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2025-04-03T19:27:11.000Z (22 days ago)
- Last Synced: 2025-04-03T20:29:50.846Z (22 days ago)
- Topics: chatbot, dg-lab, dg-lab-v3, dodo, feishu, kaiheila, nonebot, nonebot2, onebot, onebot11, onebot12, red, telegram
- Language: Python
- Homepage: https://dg-lab-play.readthedocs.io
- Size: 1.01 MB
- Stars: 30
- Watchers: 1
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
DG-Lab-Play
nonebot2 机器人插件 - ⚡ 在群里和大家一起玩郊狼吧！⚡
### 预发行版本说明
下列版本尚未进行充分测试，但其中有一些未发布的新功能，欢迎体验
- [v1.1.0-beta.1](https://github.com/Ljzd-PRO/nonebot-plugin-dg-lab-play/releases/tag/v1.1.0-beta.1)
新增骰子玩法
## 💡 特性
- 兼容大部分 nonebot 适配器
- OneBot v11, OneBot v12, Kaiheila, Telegram, Feishu, Red, DoDo
- 支持多个郊狼玩家同时连接
- DG-Lab App Socket 服务端可选择本地搭建或连接远程服务器
- 命令和回复文本均可自定义
- 支持以下功能：
- 📲连接 DG-Lab App
- 🕹️查看当前玩家
- 🔺增加玩家通道强度
- 🔻减小玩家通道强度
- 🎲随机通道强度
- ⤴️添加波形到循环
- 🔄️重设为某波形
- 🎲重设为随机波形
- ...
## 🔨 安装
### 🔨 安装
> 关于 nonebot 的安装和使用：[快速上手](https://nonebot.dev/docs/2.3.0/quick-start)
在您已经完成 nonebot 项目的创建和 nb-cli 脚手架的安装的前提下，\
在机器人项目下执行：
```bash
nb plugin install nonebot-plugin-dg-lab-play
```
### ⬆️ 更新
```bash
nb plugin update nonebot-plugin-dg-lab-play
```
## ⚙️ 配置
> [!Warning]
> 首次使用，必须更改 WebSocket 服务端配置，否则用户将可能无法连接
> [!Note]
> 更多配置内容参考 [插件配置](https://dg-lab-play.readthedocs.io/zh-cn/latest/config/guide/)
> nonebot 文档介绍：[dotenv 配置文件](https://nonebot.dev/docs/2.3.0/appendices/config#dotenv-%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6)
有两种配置 DG-Lab WebSocket 服务端的方法，分别为本地搭建和连接远程服务器，默认为本地搭建
### 📌（默认）采用本地搭建 WebSocket 服务端的方法
修改 nonebot 目录下的 `.env` 文件，参考如下：
#### 🔗（可选）设置本地服务端监听主机号和端口
```dotenv
# 本地搭建的服务端 host，默认为 0.0.0.0
DG_LAB_PLAY__WS_SERVER__LOCAL_SERVER_HOST=0.0.0.0
# 本地搭建的服务端监听端口，默认为 4567
DG_LAB_PLAY__WS_SERVER__LOCAL_SERVER_PORT=4567
```
#### ❗（必需）设置供 DG-Lab App 连接的本地 WebSocket 服务端 URI
```dotenv
# 生成二维码时，使用的本地服务端 URI（需要郊狼用户能够连接，即本机的公网地址）
# 首次使用，该配置必须更改，默认为本地环回地址，用户的 App 无法连接
# 普通连接为 ws://，SSL 加密连接为 wss://
DG_LAB_PLAY__WS_SERVER__LOCAL_SERVER_PUBLISH_URI="ws://my-server.net:4567"
```
#### 🔐（可选）设置 SSL 连接
```dotenv
# 是否启用 SSL 连接
DG_LAB_PLAY__WS_SERVER__LOCAL_SERVER_SECURE=True
# SSL 证书文件路径
# 若使用相对路径，起始位置为机器人项目目录
DG_LAB_PLAY__WS_SERVER__LOCAL_SERVER_SSL_CERT="/path/to/证书文件"
# SSL 私钥路径
# 若使用相对路径，起始位置为机器人项目目录
DG_LAB_PLAY__WS_SERVER__LOCAL_SERVER_SSL_KEY="/path/to/私钥文件"
# SSL 私钥密码
DG_LAB_PLAY__WS_SERVER__LOCAL_SERVER_SSL_PASSWORD=123456
```
📡 最后，记得完成对公网的端口转发等配置，确保用户能够连接本地搭建的 WebSocket 服务端。
### 📌（备选）采用连接远程 WebSocket 服务端的方法
修改 nonebot 目录下的 `.env` 文件，参考如下：
```dotenv
# 是否连接到远程 WebSocket 服务端
DG_LAB_PLAY__WS_SERVER__REMOTE_SERVER=True
# 远程服务端 URI
DG_LAB_PLAY__WS_SERVER__REMOTE_SERVER_URI="ws://my-server.net:8080"
```
## 🎉 开始使用
默认情况下，向机器人发送 `/郊狼玩法` 以查看完整帮助信息
命令和回复文本均可自定义，具体可参考
[`CommandTextConfig`](https://dg-lab-play.readthedocs.io/zh-cn/latest/config/command-text/#nonebot_plugin_dg_lab_play.config.CommandTextConfig),
[`ReplyTextConfig`](https://dg-lab-play.readthedocs.io/zh-cn/latest/config/reply-text/#nonebot_plugin_dg_lab_play.config.ReplyTextConfig)
## 💡 更多
PyPI: https://pypi.org/project/nonebot-plugin-dg-lab-play/
### 是如何实现的郊狼控制？
本插件使用 [PyDGLab-WS](https://github.com/Ljzd-PRO/PyDGLab-WS) 创建服务端和终端以实现对 DG-Lab App 的控制
### 更多郊狼玩法？
- 专门适配郊狼的 buttplug 协议分支：[buttplug-dg-lab](https://github.com/Ljzd-PRO/buttplug-dg-lab)
- 恐怖游戏 DeppartPrototype Mod：[HentaiPlayMode](https://github.com/Ljzd-PRO/DeppartPrototypeHentaiPlayMod)
- 可搭配上面专门适配的分支软件使用