https://github.com/CyanLaser/CyanEmu

CyanEmu is a VRChat client emulator in Unity. Includes a player controller with interact system. Works with SDK2 and SDK3.
https://github.com/CyanLaser/CyanEmu

unity vrchat

Last synced: 4 months ago
JSON representation

CyanEmu is a VRChat client emulator in Unity. Includes a player controller with interact system. Works with SDK2 and SDK3.

• Host: GitHub
• URL: https://github.com/CyanLaser/CyanEmu
• Owner: CyanLaser
• License: mit
• Created: 2020-05-26T21:10:04.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-03-22T21:54:07.000Z (over 2 years ago)
• Last Synced: 2024-01-16T05:38:57.213Z (5 months ago)
• Topics: unity, vrchat
• Language: C#
• Homepage:
• Size: 6.51 MB
• Stars: 353
• Watchers: 9
• Forks: 13
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Lists

• awesome-vrchat - CyanEmu - VRChat client emulator in Unity, works with SDK2 and SDK3 (Tutorials / Tools)
• awesome-stars - CyanEmu

README

        
# CyanEmu is being replaced by ClientSim: https://github.com/vrchat-community/ClientSim

CyanEmu will no longer receive any updates or bug fixes. CyanEmu is currently the only way to test SDK2 worlds in editor. This repository will remain open until VRChat deprecates SDK2. At that point, this repo will be archived.

# CyanEmu

## A VRChat client emulator in Unity for SDK2 and SDK3.

CyanEmu is a VRChat client emulator that enables you to test your VRChat worlds directly in Unity! One of the biggest problems with debugging VRChat worlds is not knowing exactly what the issue is. With CyanEmu, you can look at the state of all objects to verify things directly. CyanEmu comes with a basic player controller, allowing you to explore your worlds and use pickups and interacts. Works with both SDK2/Triggers and SDK3/Udon.

## Features

- Debug everything in Unity

- Desktop player controller

- Grab pickups and use interacts

- Execute VRC_Triggers directly

- Oversync detection for VRC_Trigger broadcasts

- Save and replay buffered events to test late joining

- Works with Udon

- Delete EditorOnly objects on Play

## Setup

### Requirements

- Unity 2019.4.31f1

- VRChat World [SDK2 or SDK3](https://vrchat.com/home/download)

- The latest [release](https://github.com/CyanLaser/CyanEmu/releases/latest) of CyanEmu

### Getting started

- Import the latest release into your Unity project

- Open your VRChat world scene

- Press play in Unity

- Test your world

Check out the wiki for how to use additional features of CyanEmu.

## Links

[![Trello](https://img.shields.io/badge/Trello-Cyan%20Emu-blueviolet?logo=trello)](https://trello.com/b/3jZENltQ/cyanemu) - View planned and in progress features

[![Discord](https://img.shields.io/badge/Discord-My%20Discord%20Server-blueviolet?logo=discord)](https://discord.gg/hEwb9eF) - For support and bug reports

[![Twitter Follow](https://img.shields.io/twitter/follow/CyanLaser)](https://twitter.com/CyanLaser) - Follow my progress on this and other VRChat projects

  -  Support the development of CyanEmu

[![Download CyanEmu](https://img.shields.io/github/downloads/CyanLaser/CyanEmu/total)](https://github.com/CyanLaser/CyanEmu/releases/latest) - Download the latest release of CyanEmu

## Copyright

Copyright (c) 2020-2022 CyanLaser

Licensed under the [MIT license](LICENSE.md).