An open API service indexing awesome lists of open source software.

https://github.com/vrcm-team/vrcm

A Multi-Platform friend "monitor" for VRChat.
https://github.com/vrcm-team/vrcm

android compose compose-multiplatform ios-app jetpack-compose kotlin kotlin-multiplatform vrchat

Last synced: 9 months ago
JSON representation

A Multi-Platform friend "monitor" for VRChat.

Awesome Lists containing this project

README

          

# logo VRCM

**🌐 Languages / 语言 / 言θͺž:**
[English](README.md) β€’ [δΈ­ζ–‡](README_ZH.md) β€’ [ζ—₯本θͺž](README_JP.md)

[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![GitHub release](https://img.shields.io/github/release/vrcm-team/VRCM.svg)](https://github.com/vrcm-team/VRCM/releases/latest)
[![Downloads](https://img.shields.io/github/downloads/vrcm-team/VRCM/total?color=6451f1)](https://github.com/vrcm-team/VRCM/releases/latest)
[![Kotlin](https://img.shields.io/badge/Kotlin-2.1-blue.svg?logo=kotlin)](https://kotlinlang.org)
[![Compose Multiplatform](https://img.shields.io/badge/Compose%20Multiplatform-1.8.2-blue)](https://www.jetbrains.com/lp/compose-multiplatform/)

## Multi-platform VRChat Friend "Monitoring" Application

A feature-rich cross-platform VRChat friend management application that lets you keep track of your friends' activities anytime, anywhere.

## ✨ Core Features

### πŸ” Account Management
- **Multi-account Support** - Quickly switch between different VRChat accounts
- **Login Authentication** - Support for email and 2FA login verification

### πŸ‘₯ Friend System
- **Friend List** - Real-time view of all friends' online status and activity information
- **Friend Location** - Track friends' current worlds and rooms
- **Friend Profile** - View detailed user information, status, and bio
- **Friend Management** - Complete operations including adding new friends and removing friends

### πŸ” Search Functionality
- **User Search** - Quickly find VRChat users by username
- **World Search** - Discover and search various worlds in VRChat

### 🌍 World Features
- **World Details** - View detailed world information, descriptions, tags, and preview images
- **World Favorites** - Favorite preferred worlds with support for multiple collection groups
- **World Browsing** - Browse popular and recommended worlds
- **Room Invitations** - Invite yourself to rooms

### πŸ”” Notification System
- **Real-time Notifications** - Receive friend requests, invitations, group notifications, and other types of notifications
- **Notification Management** - Display in chronological order with support for marking as read and deletion
- **Friend Requests** - Handle friend requests, accept or decline invitations

### 🎨 Interface Experience
- **Modern Design** - Follows Material Design principles
- **Multi-theme Support** - Switch between dark/light themes and various color themes
- **Internationalization** - Support for multiple language interfaces
- **Smooth Animations** - Shared element transitions and elegant interactive animations

### πŸ–ΌοΈ VRChat+ Gallery
- **Photo Browsing** - View all photos taken in-game
- **Photo Download** - Save favorite photos to local device
- **Zoom Preview** - Support for zooming and detailed photo viewing

Gallery-1
Gallery-2

## πŸ“± Platform Support

- βœ… **Android** - Full feature support
- βœ… **iOS** - Full feature support (requires [self-signing](self-signing.md))

## πŸ–₯️ Interface Preview

### Multi-platform Preview:

![MultiPlatformPreview.png](image/MultiPlatformPreview.png)

### UI Interface Preview:

![UIPreview.png](image/UIPreview.png)

## πŸ“‹ Development Roadmap

### Coming Soon:
- πŸ“· **Gallery Upload Functionality** - Support for uploading images from local devices through gallery or camera to VRChat+ gallery
- πŸ‘€ **User Profile Editing** - Support for users to modify their personal bio, avatar, and other profile information
- πŸ‘₯ **Group Features** - Complete group functionality including group profile viewing and group room viewing

### Future Possibilities?
- πŸ“± **Widescreen Adaptation** - Perfect adaptation for tablets and foldable devices with dual-screen layout and multi-window operations
- πŸ–₯️ **Complete Desktop Support** - Full platform support for Windows, macOS, and Linux
- πŸ“Š **Activity History Records** - Background persistent recording of friend activity history with long-term data storage and query support
- πŸ“’ **System Notifications** - Native system notification support
- πŸ€– **Smart Assistant** - AI-driven friend activity analysis

## πŸ› οΈ Technical Architecture

### Core Technology Stack
- **[Kotlin Multiplatform](https://kotlinlang.org/multiplatform/)** - Cross-platform development framework
- **[Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/)** - Modern UI framework
- **[Ktor](https://ktor.io/)** - Network requests and API communication
- **[kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization)** - JSON data serialization

### Architecture Components
- **[Koin](https://github.com/InsertKoinIO/koin)** - Dependency injection framework
- **[Voyager](https://github.com/adrielcafe/voyager)** - Navigation and state management
- **[Multiplatform-Settings](https://github.com/russhwolf/multiplatform-settings)** - Cross-platform configuration storage
- **[Coil](https://github.com/coil-kt/coil)** - High-performance image loading

### Development Environment
- **Kotlin API**: 2.1
- **Android SDK Target**: 35
- **Java SDK**: 21
- **Compose**: 1.8.2

## ⚠️ Disclaimer

- VRCM is not affiliated with VRChat Inc and does not represent the views or opinions of VRChat Inc
- VRCM does not store or collect any data outside of your device
- The application author is not responsible for any damage caused by this application
- VRCM does not modify or tamper with the game and does not violate [VRChat Terms of Service](https://hello.vrchat.com/legal)
- Please use this application responsibly and comply with relevant laws, regulations, and platform rules

## πŸ“„ License

This project is open source under the [MIT License](LICENSE).

## 🀝 Contributing

Contributions of code, bug reports, or feature suggestions are welcome! Please check our contribution guidelines for more information.

---

**If this project is helpful to you, please give us a ⭐**

[Download Latest Release](https://github.com/vrcm-team/VRCM/releases/latest) β€’ [Report Issues](https://github.com/vrcm-team/VRCM/issues) β€’ [Feature Requests](https://github.com/vrcm-team/VRCM/discussions)