nonebot-plugin-werewolf 1.0.6__tar.gz → 1.1.0__tar.gz

{nonebot_plugin_werewolf-1.0.6 → nonebot_plugin_werewolf-1.1.0}/PKG-INFO

@@ -1,16 +1,16 @@
 Metadata-Version: 2.1
 Name: nonebot-plugin-werewolf
-Version: 1.0.6
-Summary: Default template for PDM package
-Author-Email: wyf7685 <wyf7685@163.com>
+Version: 1.1.0
+Summary: 适用于 Nonebot2 的狼人杀插件
+Author-email: wyf7685 <wyf7685@163.com>
 License: MIT
 Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: nonebot2>=2.3.3
 Requires-Dist: nonebot-plugin-alconna>=0.52.1
 Requires-Dist: nonebot-plugin-userinfo>=0.2.6
 Requires-Dist: nonebot-plugin-waiter>=0.7.1
-Requires-Dist: StrEnum>=0.4.15
-Description-Content-Type: text/markdown
 
 <div align="center">
   <a href="https://v2.nonebot.dev/store">
@@ -28,12 +28,15 @@ _✨ 简单的狼人杀插件 ✨_
 [![pypi](https://img.shields.io/pypi/v/nonebot-plugin-werewolf?logo=python&logoColor=edb641)](https://pypi.python.org/pypi/nonebot-plugin-werewolf)
 [![python](https://img.shields.io/badge/python-3.10+-blue?logo=python&logoColor=edb641)](https://www.python.org/)
 
-[![pdm-managed](https://img.shields.io/endpoint?url=https%3A%2F%2Fcdn.jsdelivr.net%2Fgh%2Fpdm-project%2F.github%2Fbadge.json)](https://pdm-project.org)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 [![isort](https://img.shields.io/badge/%20imports-isort-%231674b1)](https://pycqa.github.io/isort/)
 [![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![pyright](https://img.shields.io/badge/types-pyright-797952.svg?logo=python&logoColor=edb641)](https://github.com/Microsoft/pyright)
 [![ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
+[![NoneBot Registry](https://img.shields.io/endpoint?url=https%3A%2F%2Fnbbdg.lgc2333.top%2Fplugin%2Fnonebot-plugin-werewolf)](https://registry.nonebot.dev/plugin/nonebot-plugin-werewolf:nonebot_plugin_werewolf)
+[![Supported Adapters](https://img.shields.io/endpoint?url=https%3A%2F%2Fnbbdg.lgc2333.top%2Fplugin-adapters%2Fnonebot-plugin-werewolf)](https://registry.nonebot.dev/plugin/nonebot-plugin-werewolf:nonebot_plugin_werewolf)
+
 </div>
 
 ## 📖 介绍
@@ -87,12 +90,17 @@ _✨ 简单的狼人杀插件 ✨_
 
 ## ⚙️ 配置
 
-在 nonebot2 项目的`.env`文件中添加下表中的必填配置
+在 nonebot2 项目的 `.env` 文件中添加如下配置
+
+|             配置项              | 必填 | 默认值 |                             说明                              |
+| :-----------------------------: | :--: | :----: | :-----------------------------------------------------------: |
+|     `werewolf__enable_poke`     |  否  | `True` | 是否使用戳一戳简化操作流程<br/>仅在 `OneBot V11` 适配器下生效 |
+|     `werewolf__role_preset`     |  否  |   -    |                    覆写插件内置的职业预设                     |
+|  `werewolf__werewolf_priority`  |  否  |   -    |                     自定义狼人职业优先级                      |
+| `werewolf__priesthood_proirity` |  否  |   -    |                     自定义神职职业优先级                      |
+|  `werewolf__joker_probability`  |  否  | `0.0`  |              小丑职业替换平民的概率, 范围`[0,1]`              |
 
-|           配置项            | 必填 | 默认值 |                             说明                              |
-| :-------------------------: | :--: | :----: | :-----------------------------------------------------------: |
-|   `werewolf__enable_poke`   |  否  | `True` | 是否使用戳一戳简化操作流程<br/>仅在 `OneBot V11` 适配器下生效 |
-| `werewolf__override_preset` |  否  |   -    |                    覆写插件内置的职业预设                     |
+`werewolf__role_preset`, `werewolf__werewolf_priority`, `werewolf__priesthood_proirity` 的配置格式请参考 [`游戏内容`](#游戏内容) 部分
 
 ## 🎉 使用
 
@@ -150,15 +158,15 @@ _其他交互参考游戏内提示_
 | 11     | 3    | 5    | 3    |
 | 12     | 4    | 5    | 3    |
 
-职业预设可以通过配置项 `werewolf__override_preset` 修改
+职业预设可以通过配置项 `werewolf__role_preset` 修改
 
 <details>
 <summary>示例</summary>
 
-配置项 `werewolf__override_preset`
+配置项 `werewolf__role_preset`
 
 ```env
-werewolf__override_preset='
+werewolf__role_preset='
 [
     [6, 1, 3, 2],
     [7, 2, 3, 2]
@@ -171,16 +179,70 @@ werewolf__override_preset='
 </details>
 <br/>
 
-对于`狼人`和`神职`的职业分配，有如下优先级:
+对于`狼人`和`神职`的职业分配，默认有如下优先级:
 
 - `狼人`: `狼人`, `狼人`, `狼王`, `狼人`
-- `神职`: `预言家`, `女巫`, `猎人`, `守卫`, `白痴`
+- `神职`: `女巫`, `预言家`, `猎人`, `守卫`, `白痴`
+
+职业分配优先级可以通过配置项 `werewolf__werewolf_priority` 和 `werewolf__priesthood_proirity` 修改
+
+<details>
+<summary>示例</summary>
+
+#### 配置项 `werewolf__werewolf_priority`
+
+```env
+werewolf__werewolf_priority=[1, 2, 1, 1]
+```
+
+上述配置中，`[1, 2, 1, 1]` 表示狼人的职业优先级为 `狼人`, `狼王`, `狼人`, `狼人`
+
+#### 配置项 `werewolf__priesthood_proirity`
+
+```env
+werewolf__priesthood_proirity=[11, 12, 13, 14, 15]
+```
+
+上述配置中，`[11, 12, 13, 14, 15]` 表示神职的职业优先级为 `预言家`, `女巫`, `猎人`, `守卫`, `白痴`
+
+#### 职业与数字的对应关系
+
+上述配置示例中有大量~~意义不明的~~数字, 其对应的是 [`这里`](./nonebot_plugin_werewolf/constant.py) 的枚举类 `Role` 的值
+
+以下列出目前的枚举值供参考
+
+| 职业     | 枚举值 |
+| -------- | ------ |
+| `狼人`   | `1`    |
+| `狼王`   | `2`    |
+| `预言家` | `11`   |
+| `女巫`   | `12`   |
+| `猎人`   | `13`   |
+| `守卫`   | `14`   |
+| `白痴`   | `15`   |
+| `平民`   | `0`    |
+
+</details>
 
 ## 📝 更新日志
 
 <details>
     <summary>更新日志</summary>
 
+<!-- CHANGELOG -->
+
+- 2024.09.09 v1.1.0
+
+  - 新增职业 `小丑`
+  - 修复守卫无法保护自己的 bug
+  - 添加部分特殊职业的说明
+  - 添加游戏过程中的日志输出
+
+- 2024.09.04 v1.0.7
+
+  - 优先使用群名片作为玩家名
+  - 支持通过配置项修改职业分配优先级
+
 - 2024.09.03 v1.0.6
 
   - 修复预言家查验狼王返回好人的 bug
@@ -192,7 +254,7 @@ werewolf__override_preset='
 
 - 2024.08.31 v1.0.1
 
-  - 允许通过配置项修改职业预设
+  - 支持通过配置项修改职业预设
 
 - 2024.08.31 v1.0.0
 
@@ -206,3 +268,4 @@ werewolf__override_preset='
 - [`nonebot/plugin-alconna`](https://github.com/nonebot/plugin-alconna): 跨平台的消息处理接口
 - [`noneplugin/nonebot-plugin-userinfo`](https://github.com/noneplugin/nonebot-plugin-userinfo): 用户信息获取
 - [`RF-Tar-Railt/nonebot-plugin-waiter`](https://github.com/RF-Tar-Railt/nonebot-plugin-waiter): 灵活获取用户输入
+- `热心群友`: 协助测试插件

{nonebot_plugin_werewolf-1.0.6 → nonebot_plugin_werewolf-1.1.0}/README.md

@@ -14,12 +14,15 @@ _✨ 简单的狼人杀插件 ✨_
 [![pypi](https://img.shields.io/pypi/v/nonebot-plugin-werewolf?logo=python&logoColor=edb641)](https://pypi.python.org/pypi/nonebot-plugin-werewolf)
 [![python](https://img.shields.io/badge/python-3.10+-blue?logo=python&logoColor=edb641)](https://www.python.org/)
 
-[![pdm-managed](https://img.shields.io/endpoint?url=https%3A%2F%2Fcdn.jsdelivr.net%2Fgh%2Fpdm-project%2F.github%2Fbadge.json)](https://pdm-project.org)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 [![isort](https://img.shields.io/badge/%20imports-isort-%231674b1)](https://pycqa.github.io/isort/)
 [![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![pyright](https://img.shields.io/badge/types-pyright-797952.svg?logo=python&logoColor=edb641)](https://github.com/Microsoft/pyright)
 [![ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
+[![NoneBot Registry](https://img.shields.io/endpoint?url=https%3A%2F%2Fnbbdg.lgc2333.top%2Fplugin%2Fnonebot-plugin-werewolf)](https://registry.nonebot.dev/plugin/nonebot-plugin-werewolf:nonebot_plugin_werewolf)
+[![Supported Adapters](https://img.shields.io/endpoint?url=https%3A%2F%2Fnbbdg.lgc2333.top%2Fplugin-adapters%2Fnonebot-plugin-werewolf)](https://registry.nonebot.dev/plugin/nonebot-plugin-werewolf:nonebot_plugin_werewolf)
+
 </div>
 
 ## 📖 介绍
@@ -73,12 +76,17 @@ _✨ 简单的狼人杀插件 ✨_
 
 ## ⚙️ 配置
 
-在 nonebot2 项目的`.env`文件中添加下表中的必填配置
+在 nonebot2 项目的 `.env` 文件中添加如下配置
+
+|             配置项              | 必填 | 默认值 |                             说明                              |
+| :-----------------------------: | :--: | :----: | :-----------------------------------------------------------: |
+|     `werewolf__enable_poke`     |  否  | `True` | 是否使用戳一戳简化操作流程<br/>仅在 `OneBot V11` 适配器下生效 |
+|     `werewolf__role_preset`     |  否  |   -    |                    覆写插件内置的职业预设                     |
+|  `werewolf__werewolf_priority`  |  否  |   -    |                     自定义狼人职业优先级                      |
+| `werewolf__priesthood_proirity` |  否  |   -    |                     自定义神职职业优先级                      |
+|  `werewolf__joker_probability`  |  否  | `0.0`  |              小丑职业替换平民的概率, 范围`[0,1]`              |
 
-|           配置项            | 必填 | 默认值 |                             说明                              |
-| :-------------------------: | :--: | :----: | :-----------------------------------------------------------: |
-|   `werewolf__enable_poke`   |  否  | `True` | 是否使用戳一戳简化操作流程<br/>仅在 `OneBot V11` 适配器下生效 |
-| `werewolf__override_preset` |  否  |   -    |                    覆写插件内置的职业预设                     |
+`werewolf__role_preset`, `werewolf__werewolf_priority`, `werewolf__priesthood_proirity` 的配置格式请参考 [`游戏内容`](#游戏内容) 部分
 
 ## 🎉 使用
 
@@ -136,15 +144,15 @@ _其他交互参考游戏内提示_
 | 11     | 3    | 5    | 3    |
 | 12     | 4    | 5    | 3    |
 
-职业预设可以通过配置项 `werewolf__override_preset` 修改
+职业预设可以通过配置项 `werewolf__role_preset` 修改
 
 <details>
 <summary>示例</summary>
 
-配置项 `werewolf__override_preset`
+配置项 `werewolf__role_preset`
 
 ```env
-werewolf__override_preset='
+werewolf__role_preset='
 [
     [6, 1, 3, 2],
     [7, 2, 3, 2]
@@ -157,16 +165,70 @@ werewolf__override_preset='
 </details>
 <br/>
 
-对于`狼人`和`神职`的职业分配，有如下优先级:
+对于`狼人`和`神职`的职业分配，默认有如下优先级:
 
 - `狼人`: `狼人`, `狼人`, `狼王`, `狼人`
-- `神职`: `预言家`, `女巫`, `猎人`, `守卫`, `白痴`
+- `神职`: `女巫`, `预言家`, `猎人`, `守卫`, `白痴`
+
+职业分配优先级可以通过配置项 `werewolf__werewolf_priority` 和 `werewolf__priesthood_proirity` 修改
+
+<details>
+<summary>示例</summary>
+
+#### 配置项 `werewolf__werewolf_priority`
+
+```env
+werewolf__werewolf_priority=[1, 2, 1, 1]
+```
+
+上述配置中，`[1, 2, 1, 1]` 表示狼人的职业优先级为 `狼人`, `狼王`, `狼人`, `狼人`
+
+#### 配置项 `werewolf__priesthood_proirity`
+
+```env
+werewolf__priesthood_proirity=[11, 12, 13, 14, 15]
+```
+
+上述配置中，`[11, 12, 13, 14, 15]` 表示神职的职业优先级为 `预言家`, `女巫`, `猎人`, `守卫`, `白痴`
+
+#### 职业与数字的对应关系
+
+上述配置示例中有大量~~意义不明的~~数字, 其对应的是 [`这里`](./nonebot_plugin_werewolf/constant.py) 的枚举类 `Role` 的值
+
+以下列出目前的枚举值供参考
+
+| 职业     | 枚举值 |
+| -------- | ------ |
+| `狼人`   | `1`    |
+| `狼王`   | `2`    |
+| `预言家` | `11`   |
+| `女巫`   | `12`   |
+| `猎人`   | `13`   |
+| `守卫`   | `14`   |
+| `白痴`   | `15`   |
+| `平民`   | `0`    |
+
+</details>
 
 ## 📝 更新日志
 
 <details>
     <summary>更新日志</summary>
 
+<!-- CHANGELOG -->
+
+- 2024.09.09 v1.1.0
+
+  - 新增职业 `小丑`
+  - 修复守卫无法保护自己的 bug
+  - 添加部分特殊职业的说明
+  - 添加游戏过程中的日志输出
+
+- 2024.09.04 v1.0.7
+
+  - 优先使用群名片作为玩家名
+  - 支持通过配置项修改职业分配优先级
+
 - 2024.09.03 v1.0.6
 
   - 修复预言家查验狼王返回好人的 bug
@@ -178,7 +240,7 @@ werewolf__override_preset='
 
 - 2024.08.31 v1.0.1
 
-  - 允许通过配置项修改职业预设
+  - 支持通过配置项修改职业预设
 
 - 2024.08.31 v1.0.0
 
@@ -192,3 +254,4 @@ werewolf__override_preset='
 - [`nonebot/plugin-alconna`](https://github.com/nonebot/plugin-alconna): 跨平台的消息处理接口
 - [`noneplugin/nonebot-plugin-userinfo`](https://github.com/noneplugin/nonebot-plugin-userinfo): 用户信息获取
 - [`RF-Tar-Railt/nonebot-plugin-waiter`](https://github.com/RF-Tar-Railt/nonebot-plugin-waiter): 灵活获取用户输入
+- `热心群友`: 协助测试插件

{nonebot_plugin_werewolf-1.0.6 → nonebot_plugin_werewolf-1.1.0}/nonebot_plugin_werewolf/__init__.py

@@ -8,7 +8,7 @@ require("nonebot_plugin_waiter")
 from . import matchers as matchers
 from .config import Config
 
-__version__ = "1.0.6"
+__version__ = "1.1.0"
 __plugin_meta__ = PluginMetadata(
     name="狼人杀",
     description="适用于 Nonebot2 的狼人杀插件",

nonebot_plugin_werewolf-1.1.0/nonebot_plugin_werewolf/config.py

@@ -0,0 +1,86 @@
+from typing import Literal, overload
+
+from nonebot import get_plugin_config, logger
+from nonebot.compat import PYDANTIC_V2
+from pydantic import BaseModel, Field
+from typing_extensions import Self
+
+from .constant import (
+    Role,
+    default_priesthood_proirity,
+    default_role_preset,
+    default_werewolf_priority,
+)
+
+if PYDANTIC_V2:
+    from pydantic import model_validator as model_validator
+else:
+    from pydantic import root_validator
+
+    @overload
+    def model_validator(*, mode: Literal["before"]): ...  # noqa: ANN201
+
+    @overload
+    def model_validator(*, mode: Literal["after"]): ...  # noqa: ANN201
+
+    def model_validator(*, mode: Literal["before", "after"]):
+        return root_validator(
+            pre=mode == "before",  # pyright: ignore[reportArgumentType]
+            allow_reuse=True,
+        )
+
+
+class PluginConfig(BaseModel):
+    enable_poke: bool = Field(default=True)
+    role_preset: list[tuple[int, int, int, int]] | dict[int, tuple[int, int, int]] = (
+        Field(default_factory=default_role_preset.copy)
+    )
+    werewolf_priority: list[Role] = Field(
+        default_factory=default_werewolf_priority.copy
+    )
+    priesthood_proirity: list[Role] = Field(
+        default_factory=default_priesthood_proirity.copy
+    )
+    joker_probability: float = Field(default=0.0, ge=0.0, le=1.0)
+
+    @model_validator(mode="after")
+    def _validate(self) -> Self:
+        if isinstance(self.role_preset, list):
+            for preset in self.role_preset:
+                if preset[0] != sum(preset[1:]):
+                    raise RuntimeError(
+                        "配置项 `role_preset` 错误: "
+                        f"预设总人数为 {preset[0]}, 实际总人数为 {sum(preset[1:])} "
+                        f"({', '.join(map(str, preset[1:]))})"
+                    )
+            self.role_preset = default_role_preset | {
+                i[0]: i[1:] for i in self.role_preset
+            }
+            logger.debug(f"覆写配置 role_preset: {self.role_preset}")
+
+        min_length = max(i[0] for i in self.role_preset.values())
+        if len(self.werewolf_priority) < min_length:
+            raise RuntimeError(
+                f"配置项 `werewolf_priority` 错误: 应至少为 {min_length} 项"
+            )
+
+        min_length = max(i[1] for i in self.role_preset.values())
+        if len(self.priesthood_proirity) < min_length:
+            raise RuntimeError(
+                f"配置项 `priesthood_proirity` 错误: 应至少为 {min_length} 项"
+            )
+
+        return self
+
+    def get_role_preset(self) -> dict[int, tuple[int, int, int]]:
+        if isinstance(self.role_preset, list):
+            self.role_preset = {i[0]: i[1:] for i in self.role_preset}
+        return self.role_preset
+
+
+class Config(BaseModel):
+    werewolf: PluginConfig = PluginConfig()
+
+
+config = get_plugin_config(Config).werewolf
+logger.debug(f"加载插件配置: {config}")

{nonebot_plugin_werewolf-1.0.6 → nonebot_plugin_werewolf-1.1.0}/nonebot_plugin_werewolf/constant.py

@@ -4,46 +4,47 @@ from dataclasses import dataclass
 from enum import Enum, auto
 from typing import TYPE_CHECKING
 
-from strenum import StrEnum
-
-from .config import config
-
 if TYPE_CHECKING:
     from .player import Player
 
 
-class Role(StrEnum):
+class Role(Enum):
     # 狼人
-    Werewolf = auto()
-    WolfKing = auto()
+    Werewolf = 1
+    WolfKing = 2
 
     # 神职
-    Prophet = auto()
-    Witch = auto()
-    Hunter = auto()
-    Guard = auto()
-    Idiot = auto()
+    Prophet = 11
+    Witch = 12
+    Hunter = 13
+    Guard = 14
+    Idiot = 15
+
+    # 其他
+    Joker = 51
 
     # 平民
-    Civilian = auto()
+    Civilian = 0
 
 
-class RoleGroup(StrEnum):
+class RoleGroup(Enum):
     Werewolf = auto()
     GoodGuy = auto()
+    Others = auto()
 
 
 class KillReason(Enum):
-    Kill = auto()
+    Werewolf = auto()
     Poison = auto()
     Shoot = auto()
     Vote = auto()
 
 
 class GameStatus(Enum):
-    Good = auto()
-    Bad = auto()
+    GoodGuy = auto()
+    Werewolf = auto()
     Unset = auto()
+    Joker = auto()
 
 
 @dataclass
@@ -55,7 +56,7 @@ class GameState:
     potion: tuple[Player | None, tuple[bool, bool]] = (None, (False, False))
 
 
-role_name_conv: dict[Role, str] = {
+role_name_conv: dict[Role | RoleGroup, str] = {
     Role.Werewolf: "狼人",
     Role.WolfKing: "狼王",
     Role.Prophet: "预言家",
@@ -63,16 +64,14 @@ role_name_conv: dict[Role, str] = {
     Role.Hunter: "猎人",
     Role.Guard: "守卫",
     Role.Idiot: "白痴",
+    Role.Joker: "小丑",
     Role.Civilian: "平民",
-}
-
-
-role_group_name_conv: dict[RoleGroup, str] = {
     RoleGroup.Werewolf: "狼人",
     RoleGroup.GoodGuy: "好人",
+    RoleGroup.Others: "其他",
 }
 
-player_preset: dict[int, tuple[int, int, int]] = {
+default_role_preset: dict[int, tuple[int, int, int]] = {
     # 总人数: (狼, 神, 民)
     6: (1, 2, 3),
     7: (2, 2, 3),
@@ -83,6 +82,16 @@ player_preset: dict[int, tuple[int, int, int]] = {
     12: (4, 5, 3),
 }
 
-if config.override_preset is not None:
-    player_preset |= {i[0]: i[1:] for i in config.override_preset}
-    player_preset |= {i[0]: i[1:] for i in config.override_preset}
+default_werewolf_priority: list[Role] = [
+    Role.Werewolf,
+    Role.Werewolf,
+    Role.WolfKing,
+    Role.Werewolf,
+]
+default_priesthood_proirity: list[Role] = [
+    Role.Witch,
+    Role.Prophet,
+    Role.Hunter,
+    Role.Guard,
+    Role.Idiot,
+]

nonebot_plugin_werewolf-1.1.0/nonebot_plugin_werewolf/exception.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .constant import GameStatus
+
+
+class Error(Exception):
+    """插件错误类型基类"""
+
+
+class GameFinishedError(Error):
+    """游戏结束时抛出，无视游戏进程进入结算"""
+
+    status: GameStatus
+
+    def __init__(self, status: GameStatus) -> None:
+        self.status = status