Skip to content

rainbowwarmth/karin-plugin-gamepush

Repository files navigation

🎮 Karin GamePush Plugin

GamePush Karin License Node.js

🚀 游戏版本监控推送插件

实时监控游戏版本更新 | 自动推送预下载通知 | 支持多游戏平台


✨ 功能特色

🎯 支持游戏

  • 🌟 原神 (Genshin Impact)
  • 崩坏:星穹铁道 (Honkai: Star Rail)
  • 🔥 绝区零 (Zenless Zone Zero)
  • 崩坏 3 (Honkai Impact 3rd)
  • 🌊 鸣潮 (Wuthering Waves)

🛠️ 核心功能

  • 📱 版本监控 - 实时检测游戏版本更新
  • 🔔 自动推送 - 版本更新及预下载通知
  • ⚙️ 灵活配置 - 支持开启/关闭推送功能
  • 🕐 定时任务 - 自动定时检查更新
  • 💾 Redis 存储 - 高效的数据管理
  • 🎛️ Karin-Web 支持 - 可视化配置界面

📦 安装指南

前置要求

安装步骤

  1. 克隆插件
# 使用 Karin
pnpm add karin-plugin-gamepush
  1. 启动机器人
# 重启 Karin 即可自动加载插件

🎮 使用指南

基础命令

命令 功能 权限 特别说明
#原神版本监控 检查原神版本状态 Master
#原神开启版本推送 开启原神版本推送 Master
#原神关闭版本推送 关闭原神版本推送 Master
#原神当前版本 查看原神当前版本 所有用户
#原神版本数据 查看原神历史版本更新大小 所有用户
#星铁获取下载链接 查看星铁当前版本下载链接 所有用户 原神、崩坏3不支持获取
#星铁获取预下载链接 查看星铁当前版本预下载链接 所有用户 原神、崩坏3不支持获取

支持的游戏命令前缀

  • 🌟 原神: # / #原神 / #ys / #YS
  • ⭐ 星铁: * / #星铁 / #sr / #SR
  • 🔥 绝区零: % / #绝区零 / #zzz / #ZZZ
  • ⚡ 崩坏 3: ! / #崩三 / #bh3 / #BH3
  • 🌊 鸣潮: ~ / #鸣潮 / #ww / #WW

管理命令

命令 功能 权限
#[游戏]删除rediskey 删除游戏 Redis 键值 Master
#[游戏]删除预下载rediskey 删除预下载 Redis 键值 Master
#[游戏]设置rediskey 设置游戏 Redis 键值 Master
#[游戏]设置预下载rediskey 设置游戏预下载 Redis 键值 Master
#更新游戏版本数据 强制覆盖本地的游戏版本数据 Master

⚙️ 配置说明

定时任务配置

插件支持自定义定时任务,默认每 5 分钟检查一次:

// 默认配置
cron: "0 0/5 * * * *" // 每5分钟执行一次

Karin-web 可视化配置

插件支持 Karin-Web 的可视化配置界面,可以通过 Web 界面进行:

  • 🎛️ 推送开关设置
  • ⏰ 定时任务配置
  • 配置推送群组

🔧 开发说明

技术栈

  • 框架: Karin
  • 语言: JavaScript (ES6+)
  • 数据库: Redis
  • 任务调度: Cron
  • 配置管理: Karin-Web

核心特性

  • 🔄 模块化设计 - 每个游戏独立模块
  • 📡 API 监控 - 实时获取官方版本信息
  • 💾 数据持久化 - Redis 存储历史版本数据
  • 🎯 精准推送 - 避免重复通知
  • 高性能 - 异步处理,低资源占用

🤝 贡献指南

欢迎提交 Issue 和 Pull Request!

  1. Fork 本仓库
  2. 创建特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 开启 Pull Request

📄 许可证

本项目基于 MIT License 开源协议。


👨‍💻 作者

rainbowwarmth


🙏 致谢

感谢以下项目和开发者:

  • Karin - 强大的机器人框架

⭐ 如果这个项目对你有帮助,请给个 Star 支持一下!

Star History

About

自动监控游戏版本更新并推送通知

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •