Skip to content

About

基于Nonebot2的插件,目的是搭建Q群求生之路2小帮手

Topics

Resources

Stars

65 stars

Watchers

1 watching

Forks

Repository files navigation

AgnesDigitalLogo

NoneBotPluginText

nonebot_plugin_l4d2_server 1.4.0

✨Nonebot & Left 4 Dead 2 server 操作 ✨

文档   ·   指令列表   ·   常见问题

python l4logo NoneBot python
ruff black NoneBot GitHub issues pypi download
QQ Chat Group

功能

  • l4d2帮助 帮助指令

自定义服务器

  • 在 json 文件设置的前缀指令,例如设置"云",则指令 云 输出组服务器,云 1 输出 1 号服务器

SourceBans++

  • 通过 SourceBans++ 获取服务器的 ban 信息,自动导入ip

配置管理

  • l4 图片开启/关闭 超管指令 可以修改输出单图是否为图片输出
  • l4 查找用户 在已知服务器中查找
  • l4 工坊下载 提供创意工坊 id 下载到服务器和群聊

自定义服务器列表背景图片

/云 等组查询输出的服务器列表(HTML)图支持自定义背景。/云1 这类具体服查询不受影响,固定使用深蓝灰纯色背景。

<l4_path>/custom_backgrounds/   ← 放任意张图即可;插件会随机抽一张

<l4_path> 默认为 data/L4D2(即 <l4_path>/custom_backgrounds/ = data/L4D2/custom_backgrounds/);如要换位置,在 .env 里改:

L4_PATH=/path/to/your/data

使用步骤:

  1. 找到 <l4_path>/custom_backgrounds/(默认 data/L4D2/custom_backgrounds/,与 云.json 等组文件同级);
  2. 把你想要的背景图放入该目录,支持 .jpg / .jpeg / .png 格式,可放多张;
  3. 完成。下一次查询即会使用新背景。

目录会在插件启动时自动创建,无需手动建。

查找顺序:

  • /云(服务器列表):从 <l4_path>/custom_backgrounds/ 所有图片中随机抽一张;目录为空时回退到内置 background.jpg
  • /云1(单服务器卡):固定使用深蓝灰纯色背景(#496D89),不加载任何图片

选择规则:

  • 目录中有多张图时,每次查询随机抽取一张;
  • 想只用某张图,把其余图片删掉或移走;
  • 替换同名图片会按文件修改时间自动重新加载,无需重启;
  • 建议尺寸:宽幅横图(如 1920×1080),列表图会按高度铺满并横向平铺。

安装

以下提到的方法 任选其一 即可

[推荐] 使用 nb-cli 安装 在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装
nb plugin install nonebot-plugin-l4d2-server
使用包管理器安装 在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令
pip
pip install nonebot-plugin-l4d2-server
pdm
pdm add nonebot-plugin-l4d2-server
poetry
poetry add nonebot-plugin-l4d2-server
conda
conda install nonebot-plugin-l4d2-server

出图依赖:nonebot-plugin-htmlkit

出图走 nonebot-plugin-htmlkit → litehtml, 纯 C++ 本地渲染,不再需要 Chromium / Playwright,也不用 playwright install, Windows / Linux 都有预编译 wheel,装上即用(比原来的 Playwright 方案省几百 MB 内存和一次浏览器冷启动)。

代价是 litehtml 的 CSS 支持比 Chromium 少:display:flex、display:grid、 calc()、position:absolute 这类都不支持,模板必须用块级 / 表格 / 浮动布局。 render/templates/ 下的模板已按这个约束重写。

另外两个限制值得注意:

  • 不渲染 SVG。litehtml 的图片解码走位图,<img src="x.svg"> 会直接空白, 所以平台图标与 GitHub 图标都改成了同目录下的 .png(由原 .svg 按 52px 栅格化,页面上仍按 13px 显示)。以后加图标请一并提供 PNG。
  • 不支持 backdrop-filter。原方案靠 blur(2px) 压住背景图上的文字, 现在改用提高白色底的不透明度(.outer-frame 0.72、.server-card 0.85)来 保证对比度。

如果从旧版本升级过来,可以把 playwright 卸载、~/.cache/ms-playwright 目录删掉,省 300 MB+ 空间。

主要功能

  • 求生服务器-本地多路径操作(传地图等)
  • 批量查询指定 ip 服务器状态和玩家
  • 组查询(如 云)默认只列有人的服务器,云全 列出全部(含没人 / 不在线);上百台自动拆成多张图
  • connect 指令直接呼出服务器信息
  • 根据用户名,在已知服务器搜索玩家信息
  • 服务器订阅 / 收藏 + 定时推送(v1.4.0):上线 / 离线 / 玩家数突变时自动通知群
  • 单服 CRUD 指令(v1.4.0):不用手动编辑 JSON
  • 创意工坊批量并发下载(v1.4.0):流式写入 + 进度回报

新指令速览(v1.4.0)

指令 别名 权限 用途
l4收藏 <组> <id> l4fav、l4_favorite — 在群聊触发,自动记住本群为推送目标
l4取关 <组> <id> l4unfav、l4_unfavorite — 取消本群订阅(不影响其他群)
l4收藏列表 l4favlist、l4_list_favorites — 列出本群订阅
l4通知目标 <组> <id> <群号> l4notifytarget SUPERUSER 把订阅的推送目标改成别的群
l4添加服务器 <组> host:port l4_add_server、l4addserver SUPERUSER 新增单服到指定组
l4删除服务器 <组> <id或ip> l4_del_server、l4delserver SUPERUSER 删除组内单服
l4修改服务器 <组> <id> <新ip> l4_edit_server、l4editserver SUPERUSER 改单服 ip
l4查看组 <组> l4showgroup、l4列服务器 SUPERUSER 列组成员 + 在线状态
l4创意工坊 id1,id2 id3 — l4_permission_set 批量并发下载(逗号/空格/换行分隔)

数据目录

数据目录固定为 <cwd>/data/nonebot_plugin_l4d2_server/,由 services/path_resolver.py 直接拼接,不依赖 nonebot-plugin-localstore (LOCALSTORE_USE_CWD 设成什么都不影响)。这样做的原因是 localstore 的 get_plugin_data_dir() 会按调用栈反推插件名,本插件以子模块加载时会被算到 .../services/ 子目录下,与用户预期的 cwd 相对路径不一致。

首次启动时若目标目录为空,会自动从旧位置复制一次(旧目录保留, 供手动确认后删除):插件根自带的 data/L4D2/、 <cwd>/data/nonebot_plugin_l4d2_server/services/。

.env 里可调的性能 / 行为字段:

# A2S 性能
L4_A2S_CONCURRENCY=8             # 同时最多几台服务器在查(信号量上限)
L4_A2S_TIMEOUT=2.5               # 单次 ainfo / aplayers 超时秒
L4_A2S_CACHE_TTL=15              # 结果缓存秒;0=不缓存

# 订阅 / 巡检
L4_FAVORITE_CHECK_INTERVAL=300   # 收藏巡检间隔秒;0=关闭后台巡检,只在查服指令时请求
L4_FAVORITE_PLAYER_DELTA=5       # 玩家数变化超过此值才推送
L4_HISTORY_INTERVAL=300          # 历史记录周期秒;0=关闭(同上,热力图会没有数据)

# 工坊
L4_WORKSHOP_CONCURRENCY=3        # 批量下载并发上限(1~8)

# 出图
L4_IMAGE_PAGE_SIZE=30            # 组查询每张图最多几台服,超出自动分多张发送(1~200)
L4_RENDER_TIMEOUT=15             # 单页出图超时秒;超时 / 渲染失败时改用简易图
L4_JPEG_QUALITY=82               # 列表 JPEG 质量(40~95);调低可减小体积、加快上传
L4_RENDER_CACHE_TTL=0            # 出图结果缓存秒;0=不缓存。开启后相同 HTML 直接复用图片,
                                 # 配合 L4_A2S_CACHE_TTL 可让短时间内的重复查询几乎零耗时
L4_PLAYERS=4                     # 卡片里最多显示几名玩家;减少可缩短卡片、加快出图
L4_NAME_STRIP_PATTERN='^Anne云服#\d+'  # 列表里去掉的服务器名前缀(正则),默认只匹配 Anne 云服:Anne云服#57[普通药役] → [普通药役];留空不处理

# 屏蔽
L4_BLOCK_KEYWORDS='["广告", "外挂|cheat"]'  # 关键词正则列表(不区分大小写),见下文「屏蔽与关键词」
L4_BLOCK_BUILTIN_WORDS=false     # 启用内置中文敏感词库(约 2100 词,命中的词打码成 *,默认关闭)

屏蔽与关键词

关键词过滤(已实现)

在 .env 里用 JSON 列表配置正则,不区分大小写:

L4_BLOCK_KEYWORDS='["广告", "外挂|cheat"]'
  • 服务器名命中:整台服务器不出现在 云 / 云全 / l4全服 / l4查找 / l4查人 / tj / zl / kl 的结果里;云5、connect <ip> 这类单服查询只回「该服务器已被屏蔽」。
  • 玩家名命中:只隐藏这个玩家(列表卡片、单服查询、查人),服务器照常显示,人数仍按 A2S 上报;tj / zl / kl 的判断仍按真实玩家列表。
  • 非法正则会记一条警告并跳过,不影响其它关键词。收藏推送和历史记录不受影响。

过滤在 services/blocklist.py,接在 A2S 结果和输出之间。

敏感词库(打码)

和上面的关键词不同,敏感词库只打码不隐藏:服务器名、玩家名里命中的词替换成 *(如 出售按摩棒 → 出售***),服务器和玩家照常显示。几千到几万个词的词表难免混着常用词,打码比整台隐藏温和。

  • 内置词库:.env 设 L4_BLOCK_BUILTIN_WORDS=true 打开。收录 konsheng/Sensitive-lexicon(MIT)的政治、反动、暴恐、涉枪涉爆、色情、贪腐等 8 个分类,约 2100 个词,已删掉和 L4D2 用语、常见昵称冲突的词;来源、删改和没收录的分类见 nonebot_plugin_l4d2_server/block_words/README.md。
  • 自定义词表:把 .txt 放到 <data_dir>/block_words/(启动时自动创建),每行一个词,# 开头是注释,发 l4刷新 生效。不管内置词库开没开都会加载。
  • 少于 2 个字的词不加载;中文按子串匹配,纯字母数字的词(如 xjp)按整词匹配,不会误伤 SirPlease 这种英文名;全角字符按半角算。不在线服的占位名「服务器无响应」不打码。

同一仓库的 GFW补充词库、零时-Tencent 等大词表包含手枪、冲锋枪、炸弹、电击器、燃烧瓶、嗑药、服务器等 L4D2 常用词,直接放进 block_words/ 会把正常的服务器名和玩家名打码,建议先删掉这些词再用。

其它思路(未实现)

  1. SourceBans 自动同步:定时拉 SourceBans banlist 落到本地 <data_dir>/blocklist.json。注意 A2S 只返回玩家名,拿不到 SteamID, 只能按名字匹配被封玩家。
  2. 本地 JSON 黑名单:管理员 l4黑名单 add <ip> 写入 <data_dir>/blocklist.json;查询结果按黑名单过滤。
  3. SourceMod HTTP 聊天镜像:服务器装 SM 插件暴露 HTTP 接口, 机器人拉聊天记录后正则匹配违规词,命中后通过 RCON 自动 kick。

这几种如要实现,可以复用 services/blocklist.py 的过滤入口; consts.BLOCKLIST_FILENAME 已预留给本地黑名单文件。

服务器组文件存放位置:<data_dir>/<组名>.json。 <data_dir> 固定为 <cwd>/data/nonebot_plugin_l4d2_server/(见上文「数据目录」)。 旧版 <data_dir>/l4d2/ 子目录与 <data_dir>/l4d2.json 单文件 都会在启动时自动迁移。

收藏相关数据:

  • <data_dir>/favorites.json — 收藏条目列表
  • <data_dir>/notify_state.json — 上次推送状态(避免抖动刷屏)

env 设置

    l4_enable = True
    """是否全局启用求生功能"""
    l4_image = False
    """是否启用图片"""
    l4_connect = True
    """是否在查服命令后加入connect ip"""
    l4_players = 4
    """查询总图的时候展示的用户数量"""
    l4_style = "default"
    """图片风格,可选包括以下
    - 简洁
    l4_a2s_concurrency = 8
    """A2S 并发上限(信号量)"""
    l4_a2s_timeout = 2.5
    """A2S 单次超时秒"""
    l4_a2s_cache_ttl = 15
    """A2S 结果缓存秒;0=不缓存"""
    l4_favorite_check_interval = 300
    """收藏巡检间隔秒;0=不注册后台巡检,只在查服指令时请求"""
    l4_favorite_player_delta = 5
    """玩家数变化超过此值才推送"""
    l4_workshop_concurrency = 3
    """创意工坊批量下载并发上限"""

和 0.x.x 更改部分

  • 服务器组指令(云、云1 等)规则层拒绝非数字后缀:之前输入 云云 会被解析为「组 云 + args=云」然后静默退出,现在直接在 nonebot 规则层拒绝,不会进入 handler,也不会被本插件拦截后续处理。云1 / 云12 仍正常触发单服查询;
  • 单服务器查询(云1)合并图片与 connect host:port 文本:图片和 connect host:port 文本作为一条合并消息发出(受 l4_connect 配置控制),方便直接点链接加入服务器;
  • 单服务器卡(云1)长内容自动换行:服务器名、地图名、connect IP 等超出 380px 卡片宽度时,会按像素宽度自动换行展示,图片高度随行数自动撑高;
  • 服务器列表(云)地图名溢出处理:.map-name CSS 增加 text-overflow: ellipsis,超长地图名以省略号截断,不再撑破卡片;
  • 查服背景图按渲染类型拆分目录(后续调整):/云(服务器列表)从 <l4_path>/custom_backgrounds/ 根目录的所有图片中随机抽一张,目录为空时回退到内置 background.jpg;/云1(单服务器卡)固定使用深蓝灰纯色,不加载任何图片。详见「自定义服务器列表背景图片」;
  • 数据路径统一由 services/path_resolver.py 决定:组文件、sb_pages、自定义背景图、迁移脚本都从 <cwd>/data/nonebot_plugin_l4d2_server/ 派生,不再各自写死相对路径。l4_path 配置项已移除(设了也不生效)。

v1.4.0 相对 v1.3.x 的变化

  • 数据目录:固定为 <cwd>/data/nonebot_plugin_l4d2_server/,由 services/path_resolver.py 直接拼接,不依赖 nonebot-plugin-localstore (v1.4.0 曾有 L4_USE_LOCALSTORE / L4_LOCALSTORE_SUBDIR,现已移除)。
  • A2S 性能:批量查询加 asyncio.Semaphore 上限 (l4_a2s_concurrency),单次超时可配(l4_a2s_timeout), 结果缓存 l4_a2s_cache_ttl 秒(deepcopy 防止下游 mutate); SourceBans refresh_all_pages 改并发。
  • 收藏 / 订阅:新增 l4收藏 / l4取关 / l4收藏列表 / l4通知目标;scheduler 周期巡检(l4_favorite_check_interval), 上线 / 离线 / 玩家数突变时按群推送。
  • 单服 CRUD:新增 l4添加服务器 / l4删除服务器 / l4修改服务器 / l4查看组,ID 稳定不再重排。
  • 创意工坊批量:l4创意工坊 123,456 789 并发下载 (l4_workshop_concurrency),流式写入 + 进度回报。
  • tj / zl / kl 注册时序 bug:改为在 _on_startup 内调用 register_picker_handlers(),避免导入时 registry.commands 还没填。
  • 统一异常类型:services/errors.py 提供 L4Error / L4ServerUnreachableError / L4TimeoutError / L4InvalidInputError / L4NotFoundError / L4HTTPError, 后续 handler 收敛 except L4Error。
  • http_helpers.save_url_to_file dead code 修复; 新增 stream_download 流式下载接口。
  • http_helpers.STREAM_CHUNK_SIZE / STREAM_TIMEOUT 新常量。

其他

  • anne 部分,已移植到这里,通过 core 插件调用
  • 如果您有发现 BUG 或者更好的建议,欢迎提 Issue & Pr
  • 如果本插件对你有帮助,不要忘了点个 Star~
  • 本项目仅供学习使用,请勿用于商业用途
  • 更新日志
  • GPL-3.0 License ©@Agnes4m

🌐 感谢

  • nonebot2- 聊天机器人的基础框架

  • 饼干 - 指导 nonebot2 框架的函数使用

  • wuyi - 指导 pil 作图

  • 感谢以下服主大力支持

    • Michaela's | 机器人功能测试反馈
    • 东 | 提供 docker 部署方法等建议 | 电信服 anne 游戏群
    • 迷茫 | 催命更新 byd
    • ArcPav | 积极反馈 bug,提供改进思路

About

基于Nonebot2的插件,目的是搭建Q群求生之路2小帮手

Topics

Resources

Stars

65 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages