Default template for PDM package
Project description
📖 介绍
和朋友们来一场紧张刺激的狼人杀游戏
💿 安装
使用 nb-cli 安装
在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装nb plugin install nonebot-plugin-werewolf
使用包管理器安装
在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令pip
pip install nonebot-plugin-werewolf
pdm
pdm add nonebot-plugin-werewolf
poetry
poetry add nonebot-plugin-werewolf
conda
conda install nonebot-plugin-werewolf
打开 nonebot2 项目根目录下的 pyproject.toml
文件, 在 [tool.nonebot]
部分追加写入
plugins = ["nonebot_plugin_werewolf"]
⚙️ 配置
在 nonebot2 项目的.env
文件中添加下表中的必填配置
配置项 | 必填 | 默认值 | 说明 |
---|---|---|---|
werewolf__enable_poke |
否 | True |
是否使用戳一戳简化操作流程 仅在 OneBot V11 适配器下生效 |
werewolf__override_preset |
否 | - | 覆写插件内置的职业预设 |
🎉 使用
[!note]
插件通过群聊+私聊进行游戏交互
使用前请确保机器人有权限发起相应对话。
举例
众所周知, QQ 官方机器人对主动消息有次数限制 (参考)
因此,本插件可能无法在 adapter-qq
下正常运行
而对于野生机器人,现有协议端通常不支持或不建议使用临时私聊消息。
在使用本插件前,应当确保机器人可以正常向玩家发送私聊消息。
指令表
指令 | 权限 | 需要@ | 范围 | 说明 |
---|---|---|---|---|
werewolf /狼人杀 |
群员 | 是 | 群聊 | 发起游戏 (进入准备阶段) |
开始游戏 |
游戏发起者 | 是 | 群聊 | [准备阶段] 游戏发起者开始游戏 |
结束游戏 |
游戏发起者 | 是 | 群聊 | [准备阶段] 游戏发起者结束游戏 |
当前玩家 |
群员 | 是 | 群聊 | [准备阶段] 列出参与游戏的玩家列表 |
加入游戏 |
群员 | 是 | 群聊 | [准备阶段] 玩家加入游戏 |
退出游戏 |
群员 | 是 | 群聊 | [准备阶段] 玩家退出游戏 |
其他交互参考游戏内提示
对于 OneBot V11
适配器, 启用配置项 werewolf__enable_poke
后, 可以使用戳一戳代替 准备阶段 的 加入游戏
操作 和 游戏内的 /stop
命令
游戏内容
[!note]
插件的游戏规则参考了网络上的相关资料
如有疑问欢迎提出
插件中保存了一份 职业预设, 内容如下
总人数 | 狼人 | 神职 | 平民 |
---|---|---|---|
6 | 1 | 2 | 3 |
7 | 2 | 2 | 3 |
8 | 2 | 3 | 3 |
9 | 2 | 4 | 3 |
10 | 3 | 4 | 3 |
11 | 3 | 5 | 3 |
12 | 4 | 5 | 3 |
职业预设可以通过配置项 werewolf__override_preset
修改
示例
配置项 werewolf__override_preset
werewolf__override_preset='
[
[6, 1, 3, 2],
[7, 2, 3, 2]
]
'
上述配置中,[6, 1, 3, 2]
表示当总人数为 6 时,狼人、神职、平民的数量分别为 1、3、2
对于狼人
和神职
的职业分配,有如下优先级:
狼人
:狼人
,狼人
,狼王
,狼人
神职
:预言家
,女巫
,猎人
,守卫
,白痴
📝 更新日志
更新日志
-
2024.09.03 v1.0.6
- 修复预言家查验狼王返回好人的 bug
-
2024.09.03 v1.0.5
- 优化玩家交互体验
- 添加游戏结束后死亡报告
-
2024.08.31 v1.0.1
- 允许通过配置项修改职业预设
-
2024.08.31 v1.0.0
- 插件开源
鸣谢
nonebot/nonebot2
: 跨平台 Python 异步机器人框架nonebot/plugin-alconna
: 跨平台的消息处理接口noneplugin/nonebot-plugin-userinfo
: 用户信息获取RF-Tar-Railt/nonebot-plugin-waiter
: 灵活获取用户输入
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
Built Distribution
Hashes for nonebot_plugin_werewolf-1.0.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8dc9343e95e7b64dce6ac9e15d1f6bf58e34b3bccc716a60ea78c8ef015b44c4 |
|
MD5 | dfb5eb98f3fd3d5b62ef2095cd013d8d |
|
BLAKE2b-256 | 2d5a694865c60828a95dc0e64d780c08241c9b32f5f9aec3d979e21513d8880e |
Hashes for nonebot_plugin_werewolf-1.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | db3292b15e999f6773139af08b598db6bc3862f9eb09e491eb7c75136a86d34a |
|
MD5 | 703e7bf34540203472605025ec95c103 |
|
BLAKE2b-256 | 58ddccf8e2c6370883f3b79261893c90f8c8465db8fda11db16b7cd2808ceda2 |