Skip to main content

CS2 Bridge plugin for NoneBot2

Project description

NoneBotPluginLogo

NoneBotPluginText

nonebot-plugin-cs2bridge

✨ CS2 服务器与 QQ 群桥接插件(事件推送、玩家查询、状态轮询) ✨

license pypi python

CS2-Bridge

基于 NoneBot 的与 CS2 Server 互通消息插件

  • 支持 QQ 群(OneBot V11适配器)
  • 支持服务器与多个群聊的互通

🔧 服务端对接

CS2服务器端插件/Mod:CS2-Bridge

快速开始
  1. 安装插件并在 NoneBot2 中加载。
  2. .env 中配置 CS2_QQ_GROUP_IDSCS2_SERVER_HOSTCS2_WEBHOOK_SECRET 等配置项。
  3. 通过 CS2 服务端向 webhook 地址发送事件,或在群里发送 !players 查询玩家列表。

[!NOTE] 本插件在搭配 CS2-Bridge 的情况下将实现功能最大化 可以实现 CS2 服务器事件的自动推送到 QQ 群,极大提升了服务器管理的便利性和玩家互动体验。

📖 介绍

nonebot-plugin-cs2bridge 提供以下能力:

  • 接收 CS2 事件 Webhook(玩家加入/离开、地图切换等)并推送至多个 QQ 群。
  • 支持基于密钥的 webhook 校验(X-Webhook-Secret)。
  • 支持短时间重复事件抑制,避免刷屏。
  • 支持群内指令 !players 查询在线玩家(通过 A2S 查询)。
  • 后台轮询服务器状态,仅在在线/离线状态变化时通知群聊。

💿 安装

使用 nb-cli 安装 在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
nb plugin install nonebot-plugin-cs2bridge
使用包管理器安装 在 nonebot2 项目的插件目录下, 打开命令行, 输入相应的安装命令
pip install nonebot-plugin-cs2bridge

打开 nonebot2 项目根目录下的 pyproject.toml 文件, 在 [tool.nonebot.plugins] 部分追加写入

nonebot-plugin-cs2bridge = ["nonebot_plugin_cs2bridge"]

⚙️ 配置

在 nonebot2 项目的 .env 文件中添加下表配置:

配置项 必填 默认值 说明
CS2_QQ_GROUP_IDS [] 接收推送的群号列表,例如 [123456789,987654321]
CS2_WEBHOOK_SECRET Webhook 密钥,需与请求头 X-Webhook-Secret 一致
CS2_WEBHOOK_PATH /cs2/event Webhook 路径
CS2_SERVER_HOST CS2 服务器地址,用于在线玩家查询与状态轮询
CS2_QUERY_PORT 27015 A2S 查询端口
CS2_STATUS_INTERVAL 45 状态轮询间隔,范围 30-60 秒
CS2_RCON_HOST RCON 主机地址
CS2_RCON_PORT 27015 RCON 端口
CS2_RCON_PASSWORD RCON 密码

🎉 使用

指令表

指令 权限 需要@ 范围 说明
!players 群员 指定群聊 查询 CS2 服务器在线玩家并按队伍展示

Webhook 事件

  • 请求方式:POST
  • Header:X-Webhook-Secret: <密钥>
  • 默认路径:/cs2/event

请求体示例:

{
    "event": "player_connect",
    "data": {
        "player_name": "Akiyy",
        "steamid": "76561198000000000",
        "player_count": 8,
        "max_players": 20
    }
}

支持事件包括:testplayer_connectplayer_disconnectplayer_kickmap_changed

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_cs2bridge-1.1.3.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nonebot_plugin_cs2bridge-1.1.3-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

Details for the file nonebot_plugin_cs2bridge-1.1.3.tar.gz.

File metadata

  • Download URL: nonebot_plugin_cs2bridge-1.1.3.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.26.7 CPython/3.12.3 Linux/6.17.0-1008-azure

File hashes

Hashes for nonebot_plugin_cs2bridge-1.1.3.tar.gz
Algorithm Hash digest
SHA256 0083417f416b7a11a7065afb826610ab5f2b2fd1864d8ba4f1b290caab8a064b
MD5 d5e9f8d224a792d8d1433bbc5c3d8f10
BLAKE2b-256 24cb919653f22f26556b7bc2960bdb6e6a16f5a3ddbf9e7fbe1cd7612020babf

See more details on using hashes here.

File details

Details for the file nonebot_plugin_cs2bridge-1.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for nonebot_plugin_cs2bridge-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 45c729141370f1eaf19fd3e553d0c314d59dff20f650bcb4fd6099662b54b61b
MD5 8ba0cf4518c5951aca8e8446392494a8
BLAKE2b-256 25842eb71f7da2be275661e01f34727acdda5b934a8e2e31d19a722bf3d5ea2a

See more details on using hashes here.

Supported by

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