NoneBotPluginLogo

NoneBotPluginText

nonebot-plugin-steam-game-status

✨ 在群内播报 Steam 游戏状态的 Nonebot 插件 ✨

license pypi python

📖 介绍

在群内播报群友的 Steam 游戏状态

💿 安装

使用 nb-cli 安装 在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装 
nb plugin install nonebot-plugin-steam-game-status
使用包管理器安装 在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
pip 
pip install nonebot-plugin-steam-game-status
pdm 
pdm add nonebot-plugin-steam-game-status
poetry 
poetry add nonebot-plugin-steam-game-status
conda 
conda install nonebot-plugin-steam-game-status
uv 
uv add nonebot-plugin-steam-game-status
更新 
pip install nonebot-plugin-steam-game-status --upgrade

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

plugins = [
    "nonebot_plugin_steam_game_status"
    ]

⚙️ 配置

获取 steam_web_key

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

基础配置

配置项 必填 默认值 类型 说明
steam_web_key 是 无 str 或 list Steam Web API Key
steam_isthereanydeal_key 否 无 str 或 list IsThereAnyDeal API Key，用于查询史低
steam_command_priority 否 5 int 事件处理函数优先级
steam_plugin_enabled 否 true bool 插件全局开关
steam_tail_tone 否 "" str bot尾音
steam_pretty_stop_duration 否 true bool 停止游戏播报时是否把分钟数格式化为天/小时/分钟，例如 70 分钟 显示为 1小时10分钟
steam_proxy 否 None str 代理
steam_api_proxy 否 None str Steam API 反代域名
steam_store_proxy 否 None str Steam Store 反代域名
steam_subscribe_time 否 ["08:00"] str/List[str] 喜加一和折扣订阅检索推送时间

Steam 查询与 API 并发

配置项 必填 默认值 类型 说明
steam_interval 否 1 int 游戏状态查询间隔，单位分钟
steam_status_query_concurrency 否 6 int 游戏状态查询并发上限。开始/切换/结束播报漏报或日志出现超时、420时可调低
steam_owned_game_interval 否 60 int 入库播报查询间隔，单位分钟
steam_owned_game_query_concurrency 否 5 int 入库播报轮询并发上限
steam_owned_game_baseline_concurrency 否 5 int 开启入库播报时建立游戏库基准的并发上限

链接识别

配置项 必填 默认值 类型 说明
steam_link_enabled 否 true bool 链接识别全局开关
steam_area_game 否 false bool/list 识别其它区游戏。可填 bool 或群号列表
steam_link_r18_game 否 false bool/list 识别 R18 游戏。可填 bool 或群号列表

图片与动态卡片

配置项 必填 默认值 类型 说明
steam_dynamic_avatar_card 否 false bool 尝试使用 Steam 动态头像资源生成动态 GIF 卡片。默认关闭
steam_dynamic_card_cache 否 true bool 动态 GIF 卡片缓存开关
steam_dynamic_card_preserve_avatar_gif_timing 否 true bool 生成动态卡片时尽量保留原头像 GIF 的帧数和播放速度
steam_dynamic_card_max_avatar_frames 否 120 int 保留原头像 GIF 时序时的最大帧数。0 表示不限制，最接近原头像但生成更慢、文件更大
steam_dynamic_avatar_cache_ttl_minutes 否 60 int 动态头像地址缓存时间，单位分钟。0 表示不缓存
steam_dynamic_card_timeout_ms 否 15000 int 动态卡片渲染等待超时，单位毫秒
steam_dynamic_card_frame_count 否 50 int 回退采样模式的最低帧数
steam_dynamic_card_frame_duration_ms 否 80 int 回退手动模式的 GIF 帧间隔，单位毫秒
steam_dynamic_card_capture_interval_ms 否 80 int 回退采样模式的截图采样间隔，单位毫秒
steam_dynamic_card_capture_duration_ms 否 4000 int 回退采样模式的捕获总时长，单位毫秒。0 表示使用 frame_count + frame_duration_ms 手动模式

steam_tail_tone 示例

# .env.xxx
steam_tail_tone=" 喵"

steam_subscribe_time 示例

# .env.xxx
steam_subscribe_time="20:30"
# 或者多个时间
steam_subscribe_time=["08:00","20:30"]

steam_proxy 示例

# .env.xxx
steam_proxy="http://ip:port"

steam_api_proxy 和 steam_store_proxy 反代域名配置示例

# .env.xxx
# 用于替代 api.steampowered.com
steam_api_proxy="api.proxy.example.com"

# 用于替代 store.steampowered.com
steam_store_proxy="store.proxy.example.com"

Steam API 并发上限配置示例

# .env.xxx
# 常规游戏状态查询，影响开始/切换/结束游戏播报
steam_status_query_concurrency=6

# 入库播报轮询
steam_owned_game_query_concurrency=5

# 开启入库播报时建立游戏库基准
steam_owned_game_baseline_concurrency=5

如果日志中频繁出现 Steam API 420、连接超时，或结束游戏偶发漏播，优先降低 steam_status_query_concurrency，例如改为 4 或 5。

动态头像卡片配置示例

# .env.xxx
# 开启动态头像卡片
steam_dynamic_avatar_card=true

# 推荐：尽量保留原 Steam 动态头像 GIF 的帧数和播放速度
steam_dynamic_card_preserve_avatar_gif_timing=true
steam_dynamic_card_max_avatar_frames=120
steam_dynamic_card_cache=true
steam_dynamic_card_timeout_ms=15000

如果希望尽量完整复刻原头像，可以取消帧数限制，但生成会更慢、GIF 文件可能更大：

steam_dynamic_card_max_avatar_frames=0

当原 GIF 时序保留失败时，会回退到截图采样模式，可用以下配置控制回退效果：

steam_dynamic_card_frame_count=50
steam_dynamic_card_frame_duration_ms=80
steam_dynamic_card_capture_interval_ms=80
steam_dynamic_card_capture_duration_ms=4000

单个 steam key 配置示例 (steam_isthereanydeal_key 同理)

# .env.xxx
steam_web_key=123456789QWERTYUII123456789

# or 引号包裹
steam_web_key="123456789QWERTYUII123456789"

# 若字符串形式key绑定失败，请改写为以下多key配置

多个 steam key 配置示例 (steam_isthereanydeal_key 同理)

# .env.xxx
# 注意最后一行key后面不能有逗号
steam_web_key='[
    "123456789QWERTYUII123456789",
    "123456789",
    "987654321"
]'

# or 无引号包裹
steam_web_key=["123456789QWERTYUII123456789","123456789","987654321"]

steam_area_game 识别其它区游戏

# .env.xxx
# 使用布尔值开启或关闭
steam_area_game=false

# 使用群聊/私聊白名单列表
steam_area_game='["群号1","群号2"]'
# or 
steam_area_game='
[
    "群号1",
    "群号2"
]'

steam_link_r18_game 识别r18游戏

# .env.xxx
# 使用布尔值开启或关闭
steam_link_r18_game=false

# 使用群聊/私聊白名单列表
steam_link_r18_game='["群号1","群号2"]'
# or 
steam_link_r18_game='
[
    "群号1",
    "群号2"
]'

插件依赖于 客户端驱动器

请确保安装了客户端驱动器,如

# 使用官方命令
nb driver install aiohttp
# 或
pip install nonebot2[aiohttp]
# 或
pip install nonebot2[httpx]

并配置DRIVER=~aiohttp等

史低查询依赖于 IsThereAnyDeal

  1. 首先打开并登录 IsThereAnyDeal，可使用steam登录
  2. 访问 app页 并注册app
  3. 注册完成后，右侧会出现API Keys，点击key即可复制
  4. .env.xxx配置文件种添加steam_isthereanydeal_key

🎉 使用

获取SteamID64

Steam 桌面网站或桌面客户端：点开右上角昵称下拉菜单，点击账户明细，即可看到 Steam ID
Steam 应用：点击右上角头像，点击账户明细，即可看到 Steam ID

获取Steam好友代码

Steam 桌面网站或桌面客户端：点开导航栏 好友 选项卡，点击添加好友，即可看到 Steam 好友代码
Steam 应用：点击右上角头像，点击好友，点击添加好友，即可看到 Steam 好友代码

指令表

指令 需要@ 范围 权限 说明
steam绑定/steam添加/steam.add 否 群聊 群员 后加个人SteamID64或好友代码
steam解绑/steam删除/steam.del 否 群聊 群员 后加个人SteamID64
steam列表/steam绑定列表 否 群聊 群员 展示群内播报列表
steam屏蔽 否 群聊 群员 后加完整游戏名称
steam恢复 否 群聊 群员 后加完整游戏名称
steam排除列表 否 群聊 群员 展示屏蔽的游戏列表
steam播报开启/steam播报打开 否 群聊 群员 开启本群播报
steam播报关闭/steam播报停止 否 群聊 群员 关闭本群播报
steam图片播报开启/steam图片播报关闭 否 群聊 群员 设置开始/切换游戏是否使用图片播报，默认开启
steam图片背景开启/steam图片背景关闭 否 群聊 群员 设置开始/切换游戏卡片是否显示游戏背景图，默认开启
steam结束图片播报开启/steam结束图片播报关闭 否 群聊 群员 设置结束游戏是否使用图片播报，默认关闭
steam结束图片背景开启/steam结束图片背景关闭 否 群聊 群员 设置结束游戏卡片是否显示游戏背景图，默认关闭
steam结束头像黑白开启/steam结束头像黑白关闭 否 群聊 群员 设置结束游戏图片播报是否将用户头像显示为黑白，默认关闭
steam结束背景黑白开启/steam结束背景黑白关闭 否 群聊 群员 仅在结束图片背景开启后生效，设置结束游戏卡片背景图是否显示为黑白，默认关闭
steam入库播报开启/steam入库播报关闭 否 群聊 群员 设置是否定时检查公开游戏库新增游戏，开启时会先建立基准，默认关闭
steam喜加一 否 群聊 群员 主动获取喜加一资讯
steam喜加一订阅 否 群聊 群员 开启本群喜加一推送
steam喜加一退订 否 群聊 群员 关闭本群喜加一推送
steam折扣订阅 否 群聊 群员 后加游戏id，开启本群折扣推送
steam折扣退订 否 群聊 群员 后加游戏id，开启本群折扣推送
steam墙 否 群聊 群员 后加用户id，展示steam游玩时长拼图
steam失联群列表 否 群聊/私聊 超管 展示与bot失联群聊列表
steam失联群清理 否 群聊/私聊 超管 从存储中删除失联群聊相关绑定订阅(慎用)
任意steam商店链接 否 群聊/私聊 群员/好友 获取游戏信息

默认屏蔽游戏/工具名

["Wallpaper Engine：壁纸引擎","虚拟桌宠模拟器","OVR Toolkit","OVR Advanced Settings","OBS Studio","VTube Studio","Live2DViewerEX","Blender","LIV"]

目前建议手动添加 Dead Lock ，待发售完善后再移除，否则容易刷屏

创意来源

群友的 koishi bot 的该效果插件

注意事项

  1. 不支持播报非 Steam 游戏
  2. 不支持播报 Steam 隐身状态下进行的游戏
  3. 在屏蔽游戏间切换的非屏蔽游戏也不会播报
  4. 屏蔽游戏列表以群区分管理
  5. 0.2版本已知问题：多个同适配器bot（如多个OneBot）目前还存在选择错误而推送群消息失败的问题，后续修复

更新记录

2026.07.08 0.4.0

  1. 新增 Steam 状态图片卡片播报，支持按群开启/关闭图片播报；默认开始/切换游戏使用图片播报，保留原文字播报作为降级与可选方案。感谢 PR #33 对图片播报方案的贡献
  2. 新增结束游戏图片播报开关，默认关闭，并可开启头像黑白
  3. 新增动态头像卡片支持，新增动态卡片缓存
  4. 新增状态卡片游戏背景图群开关，开始/切换卡片默认开启，结束卡片默认关闭；结束卡片可独立开启背景黑白
  5. 新增游戏库入库播报功能，可按群开启，可设置检查间隔，注意api用量
  6. 优化停止游戏时长显示，默认将分钟数格式化为“天/小时/分钟”，可配置切换
  7. 新增内置帮助卡片命令 steam帮助
  8. 修复并优化群配置初始化逻辑，修复绑定串群bug
  9. 优化代码结构，补充相关轻量测试。

2025.11.30 0.3.0

  1. 添加steam游戏时长拼图获取
  2. 添加bot失联群管理(慎用)
  3. 添加游戏折扣订阅
  4. 添加多时间订阅能力
  5. 添加steam域名反代
  6. 修复部分问题

2025.09.18 0.2.6

  1. 兼容回 pydantic v1 版本
  2. 去除工具插件依赖，添加回 OneBot 依赖
  3. 修复新装插件处理文件bug

2025.09.15 0.2.3

  1. 添加喜加一及其订阅功能
  2. 增加游戏史低显示
  3. 修复屏蔽游戏指令对带空格的游戏名不生效的问题
  4. 修复OneBot适配器推送不在群聊的消息问题（多bot问题）

2025.09.04 0.2.1

  1. 修复部分预发布游戏没有标签导致识别失败
  2. 修复跨平台多适配器下消息推送失败
  3. 0.2版本已知问题：多个同适配器bot（如多个OneBot）目前还存在选择错误而推送群消息失败的问题，后续修复

2025.08.21 0.2.0

  1. 改用alconna插件实现，支持跨平台适配器
  2. 为链接识别增加白名单配置
  3. 使用驱动器实现，解决代理参数和依赖问题
  4. 小幅度优化数据存储，更新后会自动进行迁移

2025.07.27

  1. 修复onebot适配器故障导致无法推送消息
  2. 优化游戏链接识别显示效果
  3. 修复httpx 0.28.1版本代理参数

2024.10.21

  1. 修复用户id数据异常

2024.09.16

  1. 优化steam链接识别，降低失败可能性
  2. 增加steam列表展示当前游戏
  3. 优化重启后不再播报仍在继续的游戏

2024.06.30

  1. 优化游戏中文名获取

2024.06.27

  1. 修复添加新群时数据未保存的bug

2024.06.26

  1. 优化播报后数据同步优先级
  2. 添加链接识别功能
  3. 优化日志等级

2024.06.23

  1. 添加屏蔽游戏相关功能
  2. 修复steam列表问题

2024.04.28

  1. steam列表 合并消息优化

2024.02.29

  1. 新增游戏中文名播报，感谢 6DDUU6 的 PR
  2. 顺应 Nonebot 规范，缓存文件迁移至用户目录下，详见 plugin-localstore
  3. 调整数据结构，节省 key
  4. 变更原缓存记录从 每次读取文件 更改为 持续在内存中

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.4.2)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for nekous from gravatar.com nekous

Credits

Author: nek0us

License

GPL3

Requires

Python >=3.10

Report project as malware

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_steam_game_status-0.4.1.tar.gz (58.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_steam_game_status-0.4.1-py3-none-any.whl (59.3 kB view details)

Uploaded Python 3

File details

Details for the file nonebot_plugin_steam_game_status-0.4.1.tar.gz.

File metadata

File hashes

Hashes for nonebot_plugin_steam_game_status-0.4.1.tar.gz
Algorithm Hash digest
SHA256 1da1edd302cc20ff76c606e3b50c74e24a0766254c9879afec5c49abe66266d8
MD5 6e6a7fbb63868d715ef76ea55bfb3ad5
BLAKE2b-256 ada4a12643e635ed2c0329d5011c551dbc92f198ef010d72bd1f34c2fb80c39d

See more details on using hashes here.

File details

Details for the file nonebot_plugin_steam_game_status-0.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for nonebot_plugin_steam_game_status-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 200cf59168b07f118650df4ccf9cd25efb17ecc5f987182d9f340664b7fe76da
MD5 c1d766050a3a79a760f149667fd0365f
BLAKE2b-256 62fed0c64395ab3a07c909b158cfe3ed444c630109380a6202a3390e10bbf769

See more details on using hashes here.

Release history Release notifications | RSS feed

0.4.2

2 files

This release

0.4.1 This release

2 files

0.4.0

2 files

0.3.5

2 files

0.3.4

1 file

0.3.3

1 file

0.3.2

1 file

0.3.1

1 file

0.3.0

1 file

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.14

2 files

0.1.13

2 files

0.1.12

2 files

0.1.11

2 files

0.1.10

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.10

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.2

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page