nonebot-plugin-cs2match 1.0.0__tar.gz

nonebot_plugin_cs2match-1.0.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: nonebot-plugin-cs2match
+Version: 1.0.0
+Summary: 实时追踪 Counter-Strike 2 职业赛事，开赛自动提醒、关键赛况与大比分异动推送。
+Keywords: nonebot,bot,counter-strike,cs2
+Author: StarsetNight
+Author-email: StarsetNight <starsetnight@outlook.com>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 5 - Production/Stable
+Requires-Dist: aiohttp>=3.13.5
+Requires-Dist: ayafileio>=1.4.6
+Requires-Dist: nonebot-adapter-onebot>=2.4.6
+Requires-Dist: nonebot-plugin-localstore>=0.7.4
+Requires-Dist: nonebot2>=2.4.4
+Requires-Dist: pydantic>=2.13.4
+Requires-Dist: python-dotenv>=1.2.1
+Requires-Dist: typst>=0.15.0
+Requires-Python: >=3.10, <4.0
+Project-URL: Homepage, https://github.com/StarsetNight/nonebot-plugin-cs2match
+Project-URL: Repository, https://github.com/StarsetNight/nonebot-plugin-cs2match
+Description-Content-Type: text/markdown
+
+# nonebot-plugin-cs2match
+
+_✨ CS2赛事查询 ✨_
+
+
+<a href="./LICENSE">
+    <img src="https://img.shields.io/github/license/StarsetNight/nonebot-plugin-cs2match.svg" alt="license">
+</a>
+<a href="https://pypi.python.org/pypi/nonebot-plugin-cs2match">
+    <img src="https://img.shields.io/pypi/v/nonebot-plugin-cs2match.svg" alt="pypi">
+</a>
+<img src="https://img.shields.io/badge/python-3.10+-blue.svg" alt="python">
+
+## 📖 介绍
+
+实时追踪 Counter-Strike 2 职业赛事，进行开赛自动提醒与大比分异动推送。
+
+## 💿 安装
+
+<details open>
+<summary>使用 nb-cli 安装</summary>
+在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
+
+    nb plugin install nonebot-plugin-cs2match
+
+</details>
+
+<details>
+<summary>使用包管理器安装</summary>
+在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
+
+<details>
+<summary>pip</summary>
+
+    pip install nonebot-plugin-cs2match
+</details>
+<details>
+<summary>pdm</summary>
+
+    pdm add nonebot-plugin-cs2match
+</details>
+<details>
+<summary>poetry</summary>
+
+    poetry add nonebot-plugin-cs2match
+</details>
+<details>
+<summary>conda</summary>
+
+    conda install nonebot-plugin-cs2match
+</details>
+
+打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入
+
+    plugins = ["nonebot_plugin_cs2match"]
+
+</details>
+
+## ⚙️ 配置
+
+在插件的`config.py`文件中修改下表中的配置
+
+|       配置项        | 必配置 | 默认值 |              说明               |
+|:----------------:|:---:|:---:|:-----------------------------:|
+| pandascore_token |  是  |  无  |     PandaScore提供商获取的Token     |
+|   serie_rules    |  否  | 见文件 |   按照优先级给赛事系列排序（同时也是赛事系列白名单）   |
+|  client_timeout  |  否  | 10  |      API调用客户端最大超时限制，单位为秒      |
+|    cache_ttl     |  否  | 60  | api请求临时缓存存活时间及比赛监视检测间隔时间，单位为秒 |
+|  cache_max_size  |  否  | 64  |        临时渲染缓存队列中最多存储数         |
+
+部分运行时配置（DynamicConfig）仅开放运行时修改，详情查阅[指令表](#指令表)
+
+## 🎉 使用
+### 指令表
+|                指令                 |      权限      | 需要@ | 范围 |                         说明                          |
+|:---------------------------------:|:------------:|:---:|:--:|:---------------------------------------------------:|
+|        `cs2help` / `cs2帮助`        |     所有人      |  否  | 任何 |                      获取插件命令用法                       |
+| `matches [past/running/upcoming]` |     所有人      |  否  | 任何 |             比赛列表获取。`matches`可用`比赛列表`代替。             |
+|           `match <id>`            |     所有人      |  否  | 任何 |              比赛大比分获取。`match`可用`比分`代替。               |
+|          `monitor <id>`           | 群管/SUPERUSER |  否  | 群聊 | 监视比赛开始、大比分变动、结束，参数为“cancel”时取消监听。`monitor`可用`监视`代替。 |
+|      `cs2whitelist <on/off>`      | 群管/SUPERUSER |  否  | 任何 |     设置比赛列表是否仅显示白名单赛事系列。`cs2whitelist`可用`白名单`代替。     |

nonebot_plugin_cs2match-1.0.0/README.md

@@ -0,0 +1,81 @@
+# nonebot-plugin-cs2match
+
+_✨ CS2赛事查询 ✨_
+
+
+<a href="./LICENSE">
+    <img src="https://img.shields.io/github/license/StarsetNight/nonebot-plugin-cs2match.svg" alt="license">
+</a>
+<a href="https://pypi.python.org/pypi/nonebot-plugin-cs2match">
+    <img src="https://img.shields.io/pypi/v/nonebot-plugin-cs2match.svg" alt="pypi">
+</a>
+<img src="https://img.shields.io/badge/python-3.10+-blue.svg" alt="python">
+
+## 📖 介绍
+
+实时追踪 Counter-Strike 2 职业赛事，进行开赛自动提醒与大比分异动推送。
+
+## 💿 安装
+
+<details open>
+<summary>使用 nb-cli 安装</summary>
+在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
+
+    nb plugin install nonebot-plugin-cs2match
+
+</details>
+
+<details>
+<summary>使用包管理器安装</summary>
+在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
+
+<details>
+<summary>pip</summary>
+
+    pip install nonebot-plugin-cs2match
+</details>
+<details>
+<summary>pdm</summary>
+
+    pdm add nonebot-plugin-cs2match
+</details>
+<details>
+<summary>poetry</summary>
+
+    poetry add nonebot-plugin-cs2match
+</details>
+<details>
+<summary>conda</summary>
+
+    conda install nonebot-plugin-cs2match
+</details>
+
+打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入
+
+    plugins = ["nonebot_plugin_cs2match"]
+
+</details>
+
+## ⚙️ 配置
+
+在插件的`config.py`文件中修改下表中的配置
+
+|       配置项        | 必配置 | 默认值 |              说明               |
+|:----------------:|:---:|:---:|:-----------------------------:|
+| pandascore_token |  是  |  无  |     PandaScore提供商获取的Token     |
+|   serie_rules    |  否  | 见文件 |   按照优先级给赛事系列排序（同时也是赛事系列白名单）   |
+|  client_timeout  |  否  | 10  |      API调用客户端最大超时限制，单位为秒      |
+|    cache_ttl     |  否  | 60  | api请求临时缓存存活时间及比赛监视检测间隔时间，单位为秒 |
+|  cache_max_size  |  否  | 64  |        临时渲染缓存队列中最多存储数         |
+
+部分运行时配置（DynamicConfig）仅开放运行时修改，详情查阅[指令表](#指令表)
+
+## 🎉 使用
+### 指令表
+|                指令                 |      权限      | 需要@ | 范围 |                         说明                          |
+|:---------------------------------:|:------------:|:---:|:--:|:---------------------------------------------------:|
+|        `cs2help` / `cs2帮助`        |     所有人      |  否  | 任何 |                      获取插件命令用法                       |
+| `matches [past/running/upcoming]` |     所有人      |  否  | 任何 |             比赛列表获取。`matches`可用`比赛列表`代替。             |
+|           `match <id>`            |     所有人      |  否  | 任何 |              比赛大比分获取。`match`可用`比分`代替。               |
+|          `monitor <id>`           | 群管/SUPERUSER |  否  | 群聊 | 监视比赛开始、大比分变动、结束，参数为“cancel”时取消监听。`monitor`可用`监视`代替。 |
+|      `cs2whitelist <on/off>`      | 群管/SUPERUSER |  否  | 任何 |     设置比赛列表是否仅显示白名单赛事系列。`cs2whitelist`可用`白名单`代替。     |

nonebot_plugin_cs2match-1.0.0/pyproject.toml

@@ -0,0 +1,39 @@
+[project]
+name = "nonebot-plugin-cs2match"
+version = "1.0.0"
+description = "实时追踪 Counter-Strike 2 职业赛事，开赛自动提醒、关键赛况与大比分异动推送。"
+license = "MIT"
+readme = "README.md"
+keywords = ["nonebot", "bot", "counter-strike", "cs2"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Development Status :: 5 - Production/Stable"
+]
+authors = [
+    { name = "StarsetNight", email = "starsetnight@outlook.com" }
+]
+requires-python = ">=3.10,<4.0"
+dependencies = [
+    "aiohttp>=3.13.5",
+    "ayafileio>=1.4.6",
+    "nonebot-adapter-onebot>=2.4.6",
+    "nonebot-plugin-localstore>=0.7.4",
+    "nonebot2>=2.4.4",
+    "pydantic>=2.13.4",
+    "python-dotenv>=1.2.1",
+    "typst>=0.15.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/StarsetNight/nonebot-plugin-cs2match"
+Repository = "https://github.com/StarsetNight/nonebot-plugin-cs2match"
+
+[[tool.uv.index]]
+url = "https://mirrors.huaweicloud.com/repository/pypi/simple/"
+default = true
+
+[build-system]
+requires = ["uv_build>=0.9.27,<0.10.0"]
+build-backend = "uv_build"

nonebot_plugin_cs2match-1.0.0/src/nonebot_plugin_cs2match/__init__.py

@@ -0,0 +1,197 @@
+# Copyright (c) 2026 StarsetNight, XuanRikka
+# SPDX-License-Identifier: MIT
+
+from typing import cast, Any
+
+from nonebot import logger, get_driver, get_plugin_config, on_command, require
+from nonebot.adapters.onebot.v11 import Message, GROUP_ADMIN, GROUP_OWNER, Bot, GroupMessageEvent
+from nonebot.params import CommandArg
+from nonebot.permission import SUPERUSER
+from nonebot.plugin import PluginMetadata
+
+from .config import Config
+from .tools import PandaScoreClient, MonitorClient, MatchParser, typst_render
+from .typst_template import help_text
+from .rule import is_enabled
+from .dynamic_config import DynamicConfigSystem, PriorityMode
+
+require("nonebot_plugin_localstore")
+from nonebot_plugin_localstore import get_plugin_data_file
+
+driver = get_driver()
+global_config = driver.config
+config = get_plugin_config(Config)  # 取自config.py中的静态配置
+
+panda_client: PandaScoreClient | None = None
+dynamic_config: DynamicConfigSystem | None = None  # 取自插件内编写的DynamicConfigSystem
+monitor_client: MonitorClient | None = None
+
+# 注册插件
+__plugin_meta__ = PluginMetadata(
+    name="CS2赛事助手",
+    description="实时追踪 Counter-Strike 2 职业赛事，开赛自动提醒、关键赛况与大比分异动推送",
+    usage=help_text,
+    config=Config,
+    extra={}
+)
+
+@driver.on_startup
+async def on_startup_check():
+    global panda_client, dynamic_config
+    if config.pandascore_token is None:
+        logger.warning("pandascore_token未设置，CS2数据查询功能将不可用或受限。")
+        logger.info("请前往PandaScore官网注册获取Token，并在插件目录config.py中配置："
+                    "pandascore_token: str | None = <你的Token>")
+        return
+    panda_client = PandaScoreClient(config.pandascore_token)
+
+    config_path = get_plugin_data_file("config.json")
+    if not config_path.exists():
+        dynamic_config = await DynamicConfigSystem.new(config_path)
+    else:
+        dynamic_config = await DynamicConfigSystem.from_path(config_path)
+
+
+get_help = on_command("cs2help", aliases={"cs2帮助"}, priority=10, block=True)
+list_matches = on_command("matches", aliases={"比赛列表"}, rule=is_enabled, priority=10, block=True)
+check_match = on_command("match", aliases={"比分"}, rule=is_enabled, priority=10, block=True)
+monitor_match = on_command("monitor", aliases={"监视"}, rule=is_enabled,
+                           permission=SUPERUSER | GROUP_OWNER | GROUP_ADMIN, priority=10, block=True)
+whitelist_config = on_command("cs2whitelist", aliases={"白名单"}, rule=is_enabled,
+                           permission=SUPERUSER | GROUP_OWNER | GROUP_ADMIN, priority=10, block=True)
+
+
+@get_help.handle()
+async def on_get_help():
+    await get_help.finish(await typst_render(help_text, "help"))
+
+
+@list_matches.handle()
+async def on_list_matches(args: Message = CommandArg()):
+    arg = args.extract_plain_text().strip()
+
+    client = cast(PandaScoreClient, panda_client)
+
+    func_map = {
+        "past": client.list_past_matches,
+        "running": client.list_running_matches,
+        "upcoming": client.list_upcoming_matches,
+    }
+
+    await list_matches.send("正在查询比赛列表，请稍候...")
+
+    func = func_map.get(arg, None)
+
+    if func is None:
+        func = client.list_matches
+        cache_key = "list_matches"
+    else:
+        cache_key = arg
+
+    try:
+        matches = await func()
+    except Exception as e:
+        await list_matches.finish(f"由于API调度故障，请求失败：{e}")
+        matches = []  # 哄类型检查器
+    _config = cast(DynamicConfigSystem, dynamic_config)
+
+    await list_matches.finish(
+        await typst_render(
+            MatchParser.prerender_list(matches, _config.config.priority_mode),
+            cache_key
+        )
+    )
+
+
+@check_match.handle()
+async def on_check_match(args: Message = CommandArg()):
+    slug = args.extract_plain_text().strip()
+
+    if not slug:
+        await check_match.finish("用法：match <slug>\n"
+                                 "slug可在查询比赛列表的单个比赛左下角中找到。")
+
+    client = cast(PandaScoreClient, panda_client)
+
+    await check_match.send(f"正在查询比赛({slug})\n请稍候...")
+
+    try:
+        matches = await client.list_running_matches() + await client.list_upcoming_matches()
+    except Exception as e:
+        await list_matches.finish(f"由于API调度故障，请求失败：{e}")
+        matches = []  # 哄类型检查器
+
+    match = next(
+        (m for m in matches if m.get("slug") == slug),
+        None,
+    )
+
+    if match is None:
+        await check_match.finish(f"未找到比赛：{slug}")
+
+    match = cast(dict[str, Any], match)
+
+    await check_match.finish(
+        await typst_render(
+            MatchParser.prerender_match(match),
+            "get_match",
+        )
+    )
+
+
+@monitor_match.handle()
+async def on_monitor_match(bot: Bot, event: GroupMessageEvent, args: Message = CommandArg()):
+    global monitor_client
+
+    slug = args.extract_plain_text().strip().lower()
+
+    if not slug:
+        await monitor_match.finish(
+            "用法：monitor <slug>\n"
+            "取消监视：monitor cancel"
+        )
+
+    client = cast(PandaScoreClient, panda_client)  # 获取API的HTTP客户端
+
+    if monitor_client is None:
+        monitor_client = MonitorClient(client=client, bot=bot)  #
+    assert monitor_client is not None
+
+    # 取消当前群比赛监视
+    if slug == "cancel":
+        monitor_client.remove_monitor(group_id=event.group_id)
+        await monitor_match.finish("已取消本群比赛监视。")
+
+    try:
+        matches = await client.list_matches()
+    except Exception as e:
+        await list_matches.finish(f"由于API调度故障，请求失败：{e}")
+        matches = []  # 哄类型检查器
+
+    match = next(
+        (m for m in matches if m.get("slug", "").lower() == slug),
+        None,
+    )
+
+    if match is None:
+        await monitor_match.finish(f"未找到比赛：{slug}")
+    match = cast(dict[str, Any], match)
+
+    if match.get("status", "unknown") in {"finished", "canceled"}:
+        await monitor_match.finish(f"比赛已结束/取消，不可监视：{slug}")
+
+    monitor_client.add_monitor(slug, event.group_id)
+    await monitor_match.finish(f"已开始监视比赛：{match.get('name', slug)}")
+
+
+@whitelist_config.handle()
+async def on_whitelist_config(args: Message = CommandArg()):
+    arg = args.extract_plain_text().strip().lower()
+    if arg not in ["on", "off"]:
+        await whitelist_config.finish("命令用法：whitelist <on/off>")
+    _config = cast(DynamicConfigSystem, dynamic_config)
+    _config.config.priority_mode = PriorityMode.WhitelistOnly if arg == "on" else PriorityMode.WhitelistFirst
+    await _config.save()
+    await whitelist_config.finish(f"仅白名单赛事模式被设置为{'开启' if arg == 'on' else '关闭'}。")
+
+

nonebot_plugin_cs2match-1.0.0/src/nonebot_plugin_cs2match/config.py

@@ -0,0 +1,21 @@
+# Copyright (c) 2023 StarsetNight
+# SPDX-License-Identifier: MIT
+
+from pydantic import BaseModel
+
+
+class Config(BaseModel):
+    """Plugin Config Here"""
+    pandascore_token: str | None = None
+    serie_rules: list[tuple[str, int, list[str]]] = [
+        ("major", 100, ["major"]),
+        ("blast", 90, ["blast"]),
+        ("iem", 80, ["iem"]),
+        ("esl", 80, ["esl"]),
+        ("pgl", 70, ["pgl"]),
+        ("cac", 60, ["cac"]),
+        ("pnl", 50, ["pnl"]),
+    ]  # 赛事系列，优先级，匹配赛事名称（小写）
+    client_timeout: int = 10
+    cache_ttl: float = 60
+    cache_max_size: int = 64

nonebot_plugin_cs2match-1.0.0/src/nonebot_plugin_cs2match/dynamic_config.py

@@ -0,0 +1,39 @@
+# Copyright (c) 2026 StarsetNight, XuanRikka
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
+from enum import Enum
+from pathlib import Path
+
+import ayafileio
+from pydantic import BaseModel
+
+class PriorityMode(str, Enum):
+    WhitelistOnly = "whitelist-only"
+    WhitelistFirst = "whitelist-first"
+
+class DynamicConfig(BaseModel):
+    priority_mode: PriorityMode = PriorityMode.WhitelistOnly
+
+class DynamicConfigSystem:
+    def __init__(self, config: DynamicConfig, path: Path):
+        self.config = config
+        self.path = path
+
+    @classmethod
+    async def from_path(cls, path: Path) -> DynamicConfigSystem:
+        async with ayafileio.open(path, "r", encoding="utf-8") as f:
+            data = await f.readall()
+        config = DynamicConfig.model_validate_json(data)
+        return DynamicConfigSystem(config, path)
+
+    @classmethod
+    async def new(cls, path: Path) -> DynamicConfigSystem:
+        config = DynamicConfig()
+        async with ayafileio.open(path, "w", encoding="utf-8") as f:
+            await f.write(config.model_dump_json())
+        return DynamicConfigSystem(config, path)
+
+    async def save(self):
+        async with ayafileio.open(self.path, "w", encoding="utf-8") as f:
+            await f.write(self.config.model_dump_json())

nonebot_plugin_cs2match-1.0.0/src/nonebot_plugin_cs2match/rule.py

@@ -0,0 +1,16 @@
+# Copyright (c) 2026 StarsetNight, XuanRikka
+# SPDX-License-Identifier: MIT
+
+import nonebot
+
+from .config import Config
+
+config = nonebot.get_plugin_config(Config)
+
+
+async def is_enabled():
+    """
+    :return: 插件是否被启用
+    """
+    return config.pandascore_token is not None
+