Skip to main content

nonebot2 机器人插件 - 在群里和大家一起玩郊狼吧!

Project description

DG-Lab-Play

nonebot2 机器人插件 - ⚡ 在群里和大家一起玩郊狼吧!⚡

📖 完整文档

CodeFactor Documentation Status Last Commit BSD 3-Clause Version

💡 特性

  • 兼容大部分 nonebot 适配器
    • OneBot v11, OneBot v12, Kaiheila, Telegram, Feishu, Red, DoDo
  • 支持多个郊狼玩家同时连接
  • DG-Lab App Socket 服务端可选择本地搭建或连接远程服务器
  • 命令和回复文本均可自定义
  • 支持以下功能:
    • 📲连接 DG-Lab App
    • 🕹️查看当前玩家
    • 🔺增加玩家通道强度
    • 🔻减小玩家通道强度
    • 🎲随机通道强度
    • ⤴️添加波形到循环
    • 🔄️重设为某波形
    • 🎲重设为随机波形
    • ...

🔨 安装

🔨 安装

关于 nonebot 的安装和使用:快速上手

在您已经完成 nonebot 项目的创建和 nb-cli 脚手架的安装的前提下,
在机器人项目下执行:

nb plugin install nonebot-plugin-dg-lab-play

⬆️ 更新

nb plugin update nonebot-plugin-dg-lab-play

⚙️ 配置

[!Warning] 首次使用,必须更改 WebSocket 服务端配置,否则用户将可能无法连接

[!Note] 更多配置内容参考 插件配置

nonebot 文档介绍:dotenv 配置文件

有两种配置 DG-Lab WebSocket 服务端的方法,分别为本地搭建和连接远程服务器,默认为本地搭建

📌(默认)采用本地搭建 WebSocket 服务端的方法

修改 nonebot 目录下的 .env 文件,参考如下:

🔗(可选)设置本地服务端监听主机号和端口

# 本地搭建的服务端 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

# 生成二维码时,使用的本地服务端 URI(需要郊狼用户能够连接,即本机的公网地址)
# 首次使用,该配置必须更改,默认为本地环回地址,用户的 App 无法连接
# 普通连接为 ws://,SSL 加密连接为 wss://
DG_LAB_PLAY__WS_SERVER__LOCAL_SERVER_PUBLISH_URI="ws://my-server.net:4567"

🔐(可选)设置 SSL 连接

# 是否启用 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 文件,参考如下:

# 是否连接到远程 WebSocket 服务端
DG_LAB_PLAY__WS_SERVER__REMOTE_SERVER=True
# 远程服务端 URI
DG_LAB_PLAY__WS_SERVER__REMOTE_SERVER_URI="ws://my-server.net:8080"

🎉 开始使用

默认情况下,向机器人发送 /郊狼玩法 以查看完整帮助信息

命令和回复文本均可自定义,具体可参考 CommandTextConfig, ReplyTextConfig

💡 更多

是如何实现的郊狼控制?

本插件使用 PyDGLab-WS 创建服务端和终端以实现对 DG-Lab App 的控制

更多郊狼玩法?

  • 专门适配郊狼的 buttplug 协议分支:buttplug-dg-lab
  • 恐怖游戏 DeppartPrototype Mod:HentaiPlayMode
    • 可搭配上面专门适配的分支软件使用

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nonebot_plugin_dg_lab_play-1.0.0.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

nonebot_plugin_dg_lab_play-1.0.0-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file nonebot_plugin_dg_lab_play-1.0.0.tar.gz.

File metadata

  • Download URL: nonebot_plugin_dg_lab_play-1.0.0.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1021-azure

File hashes

Hashes for nonebot_plugin_dg_lab_play-1.0.0.tar.gz
Algorithm Hash digest
SHA256 597575a9dc97bcd0d10466147b3a4d237e8fee813f28f082e4a909d8689be2f6
MD5 e3f2e9de7271a2bfdd0b239c7330a624
BLAKE2b-256 e29d5c90fda90ef991033d2930948f6d8c14dc4a67bb308d871a5c40eb7e0e15

See more details on using hashes here.

File details

Details for the file nonebot_plugin_dg_lab_play-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for nonebot_plugin_dg_lab_play-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2d6750a4b155f68a3070c272855562e461726fe26390f6feb0cbd22bb3c45533
MD5 d5e04f3bbd7025ec079f735c485a90d6
BLAKE2b-256 e55ef8ded368d2c58308cfee6b44eb3d085626456224db23509b1953e2ac6947

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page