介绍

VRC-Notifier 封面

VRC-Notifier是一个专门为VR chat玩家设计的后台监控工具，它可以持续地在后台监控您所指定的好友的状态变化，比如上线信息，下线信息，状态切换信息，和世界切换信息，并通过邮箱smtp服务或者Gotify等其他开源平台实时通知你。

功能

  • 智能好友监控 - 选择性监控指定好友，而非全部好友列表

  • 仅监控状态模式 - 无限制监控所有好友的在线状态，不监控世界变化

  • 邮件通知 - 支持自定义 SMTP 服务器，实时接收状态变化通知

  • Gotify 推送 - 支持开源推送平台 Gotify，手机实时接收通知

  • 世界轮询 - 智能轮询机制追踪好友所在世界变化（标准模式）

  • API 保护 - 多层限流保护机制，确保不触发官方 API 限制

  • 防抖动机制 - 避免服务器抖动导致的误判，确保通知准确性

  • 精美界面 - 现代化 Web UI，支持明暗主题切换

  • Docker 支持 - 一键部署，支持 Docker Compose

  • 国际化 支持 - 中英双语翻译

使用

  • 部署本项目，并启用本项目

    在终端会收到访问密钥输入生成的访问密钥即可登录VRchat官方账号（账号不会明文保存相关数据均已加密并保存在本地）

    进入好友列表，便会自动的刷新一次好友列表，后面工具将不会主动的自动刷新以降低API的请求频率

    刷新完后好友列表会进入六十秒等待期（不会调用任何API），以防止用户在此多次频繁的使用API导致限流问题

    用户可选择标准模式，和仅监控状态模式，标准模式会监控好友的世界信息，但最多只能监控五个好友

    仅监控状态模式下可以监控所有好友，但无法监控他们的世界变化信息，两种模式均在关于按钮中呈现

    接下来用户只要配置smtp服务或者gotify服务或者webhook服务就可以将好友状态及其变化推送到推送平台了

示例

安装

https://shany.cc/blog/VRC-Notifier

https://github.com/shanyaojinjn/vrc-notifier

快速开始

环境要求

  • Node.js 18.0 或更高版本
  • 支持的平台：Windows / macOS / Linux

安装步骤

方式一：直接运行

# 克隆仓库
git clone https://github.com/shanyaojinjn/vrc-notifier.git
cd vrc-notifier

# 安装依赖
npm install

# 启动服务
npm start

方式二：Docker 部署（推荐）

  1. 创建项目目录并进入
mkdir vrc-notifier && cd vrc-notifier
  1. 创建 docker-compose.yml 文件
version: '3.8'

services:
  vrc-notifier:
    image: shanyaojinjin/vrc-notifier:latest
    container_name: vrc-notifier
    restart: unless-stopped
    ports:
      - "5270:5270"
    volumes:
      # 数据持久化存储
      - ./data:/app/data
    environment:
      - TZ=Asia/Shanghai
    networks:
      - vrc-network

networks:
  vrc-network:
    driver: bridge
  1. 启动服务
docker-compose up -d
  1. 访问服务

打开浏览器访问 http://localhost:5270 即可使用。

注意事项：

  • 数据将保存在 ./data 目录中，请确保该目录有写入权限
  • 如需停止服务，运行 docker-compose down
  • 查看日志：docker-compose logs -f

机制与解答

简单来说我们有非常灵活的API调用机制

防API请求失误抖动机制纠错系统，有三次防抖动纠错。

自动保护账号机制触发限流之前底层自动保护

世界信息轮询系统，世界信息将会以一个轮盘的形式进行轮询以节省API使用

工具兼容有API冗余可以与其他工具并存vrcx

游戏并上线可能会使得本工具掉线原因是因为ip发生变动等其他原因再次登录即可

如果你先启动游戏再启动本工具即可规避这个问题（或保持IP统一）

如果出现无法加载的情况，请耐心等待或者更换网络环境（查看终端，看是否触发保护）

全局限流保护

当检测到限流触发时，系统会自动进入全局暂停模式：

  • 自动暂停所有 API 请求 60 秒

  • 向用户发送警告通知

  • 前端显示实时限流状态

实现了多层限流保护系统，严格遵循 VRChat 官方 API 规范：

分级限流策略（保守设计）

// 实际限流配置（严格低于官方限制，留有安全余量）
const API_RATE_LIMITS = {
  userProfile: { maxRequests: 1, windowMs: 60 * 1000 },   // 用户资料：≤1次/分钟
  friendStatus: { maxRequests: 2, windowMs: 60 * 1000 },  // 好友状态：≤2次/分钟（官方5次）
  worldInfo: { maxRequests: 6, windowMs: 60 * 1000 }      // 世界信息：≤6次/分钟（官方10次）
};

VRChat 官方建议频率 vs 我们的限制：

|API 类型|官方建议|我们的限制|安全余量| |---|---|---|---| |用户资料|≤1次/分钟|1次/分钟|100%合规| |好友状态|≤5次/分钟|2次/分钟|60%余量| |世界信息|≤10次/分钟|6次/分钟|40%余量|

全局限流保护

当检测到限流触发时，系统会自动进入全局暂停模式：

  • 自动暂停所有 API 请求 60 秒
  • 向用户发送警告通知
  • 前端显示实时限流状态

智能缓存策略

|缓存类型|缓存时间|说明| |---|---|---| |好友状态|30秒|减少频繁查询好友列表| |世界信息|10分钟|避免重复查询同一世界名称| |好友列表|1年|永久缓存，直到手动刷新|

防抖动机制

为了避免 VRChat 服务器偶尔返回不完整数据导致的误判，我们实现了防抖动机制：

  • 需要连续 3 次检测状态一致才确认变化
  • 避免单次 API 异常触发误报
  • 真实状态变化最多延迟 30 秒

数据安全

  1. 本地存储 - 所有数据（包括登录凭证）均存储在本地 SQLite 数据库
  2. 加密存储 - 敏感信息（如 SMTP 密码、Cookie 数据）使用 AES-256-CBC 加密
  3. Cookie管理 - 用户的 VRChat 登录会话独立管理
  4. 无数据上传 - 不会将任何数据上传到第三方服务器

"记住我"功能安全说明

  • Cookie 数据使用 AES-256-CBC 加密存储
  • 加密密钥存储在服务器环境变量中
  • 即使数据库文件被复制，也无法解密 Cookie
  • 密码永远不会被保存（保存的是加密后的会话令牌，而非密码本身）

单人使用设计

VRC-Notifier 是一个专为个人设计的工具，不支持多账户管理功能。

我们刻意不实现多账户管理功能，主要基于以下安全考量：

  1. 用户数据隐私 - VRChat 账户包含大量个人社交数据，不应被他人访问或控制
  2. 会话安全风险 - 多账户管理需要在服务器端存储多个用户的登录凭证，增加安全风险
  3. 责任边界明确 - 单人使用模式明确了安全责任的边界

与 VRChat 游戏的兼容性

⚠️ 重要提示：本工具可以与 VRChat 游戏客户端同时运行，但需要注意以下事项：

同一账号冲突风险：

  • VRChat 的安全机制不允许同一账号在同一网络/设备上同时保持登录状态
  • 如果本工具和游戏使用相同的账号并在同一台设备或同一网络上运行，会导致账号互相抢占登录状态

推荐部署方式：

  • 推荐：工具和游戏使用不同账号
  • 推荐：工具部署在不同设备上（如服务器、VPS、另一台电脑）
  • 推荐：工具和游戏使用不同网络（如工具用服务器网络，游戏用本地网络）
  • 避免：在同一台电脑上同时运行工具和登录游戏（相同账号）

开源协议

本项目基于 MIT 协议开源。

致谢

本人技术不精，我承认只是个玩具项目，可以适当体验，或者是作为参考

Made with ❤️ for VRChat Community