Skip to content

IoriMaboroshi/VRCX-Cloud

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3,939 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VRCX-Cloud

GitHub release License: MIT Version

English | 简体中文 | 日本語

VRCX with cloud sync — 24/7 friend tracking, push notifications, analytics


About

VRCX-Cloud is a fork of VRCX that adds a 24/7 cloud server, enabling continuous VRChat friend activity tracking even when your local VRCX isn't running. It also integrates features from VRCX-jirai.

Features

  • ☁️ 24/7 Cloud Tracking — Deploy a lightweight Node.js server that polls VRChat API around the clock, recording friend online/offline events, location changes, and bio updates to SQLite.
  • 🔄 Real-Time Sync — Desktop client pulls data from the cloud server via REST API. Your friends' location history and activity timeline are always available.
  • 🔔 Push Notifications — Get alerted when VIP friends come online, go offline, or change location via Email, Telegram Bot, or QQ Bot (NapQQ).
  • 📝 Bio Change History — Automatically tracks bio changes with timestamps. Bio diff view for spotting what changed at a glance.
  • 📊 Status Distribution — Visualize friend status color distribution (online/join-me/ask-me/busy/offline) in a clean chart.
  • 👤 Self-Data Tracking — Records your own location and status changes over time, giving you a personal activity timeline.
  • ⏱️ Persistent Timer — Friend "time in instance" survives app restarts by restoring from cloud data.
  • 👥 Multi-Account Isolation — Uses a separate app.vrcx-cloud data directory so cloud-sync settings never conflict with your main VRCX installation.
  • 🌐 Cross-Platform — Cloud server runs on any Node.js 24+ environment (VPS, home server, Raspberry Pi). Desktop client runs wherever VRCX runs (Windows, Linux, macOS).

Architecture

┌─────────────────┐     HTTPS/REST      ┌──────────────────┐     HTTPS       ┌─────────────┐
│  VRCX Desktop   │ ◄──────────────────► │  VRCX-Cloud      │ ◄─────────────► │  VRChat API │
│  (Electron+Vue) │    Friends/Notifs   │  Server (Node.js) │   Polling/WS   │             │
│                 │    Push Cookie      │  + SQLite         │                │             │
└─────────────────┘                     └──────────────────┘                └─────────────┘
                                               │
                                        ┌──────┴──────┐
                                        │  Push Alerts │
                                        │ Email/TG/QQ │
                                        └─────────────┘

Quick Start

Cloud Server:

cd server
cp .env.example .env
# Edit .env with your API_KEY and ENCRYPTION_KEY
npm install
npm run dev

Desktop Client:

npm install
npm run dev                          # Terminal 1: Vite dev server
npm run start-electron -- --hot-reload   # Terminal 2: Electron

Then click the ☁️ icon on the login page to configure cloud sync.

Screenshots

Login

login 2fa

Feed

feed

Cloud Sync & Analytics

Acknowledgements

  • VRCX — The original VRChat companion application. Thanks to pypy and all 110+ contributors.
  • VRCX-jirai — Inspiration for Bio tracking, status distribution analytics, persistent timer, and enhanced quick search.

VRCX-Cloud is not endorsed by VRChat and does not reflect the views or opinions of VRChat or anyone officially involved in producing or managing VRChat properties. VRChat and all associated properties are trademarks or registered trademarks of VRChat Inc. VRChat © VRChat Inc.

About

Friendship management tool for VRChat but running on CLOUDSERVERS

Resources

License

Contributing

Stars

2 stars

Watchers

1 watching

Forks

Packages

 
 
 

Contributors

Languages

  • JavaScript 46.8%
  • Vue 36.1%
  • C# 13.4%
  • CSS 2.9%
  • TypeScript 0.7%
  • NSIS 0.1%