diff --git a/README.md b/README.md index 4c0ca42..1f1abd9 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ [![Github All Releases](https://img.shields.io/github/downloads/SutekhVRC/VOR/total.svg)]() +Example setup of bHaptics and VRCFaceTracking with VOR [here](). + Questions and help: [SutekhVRC Discord](https://discord.gg/g6kUFtMtpw) ### Beta: Report bugs! diff --git a/docs/example.md b/docs/example.md new file mode 100644 index 0000000..01f7550 --- /dev/null +++ b/docs/example.md @@ -0,0 +1,46 @@ +# Example setup with VOR + +The general idea of VOR is to send OSC data to multiple applications because VRChat cannot be configured to send to multiple ports. +An example setup using VOR with two other OSC applications that receive data from VRChat. + +## Example setup + +### Applications + +In this example we will be setting VOR up with two commonly used applications: +- (bHaptics OSC application)[https://github.com/bhaptics/VRChatOSC] +- (VRCFaceTracking OSC application)[https://github.com/benaclejames/VRCFaceTracking] + +### TLDR; + +1. Add two apps in VOR with different app ports. (9100 & 9200) + +2. In each app you are using, change their bind/listen/receive port to the respective app ports you set in the VOR application. + +3. You are done `:)` + +### Add your apps in VOR + +1. Create an app for the bHaptics and VRCFaceTracking application. + +#### bHaptics VOR + +![Add bHaptics app to VOR](../images/bhapticsexampleapp.png) + +#### VRCFaceTracking VOR + +![Add VRCFaceTracking app to VOR](../images/vrcftexampleapp.png) + +2. Set the bind/listen/receive port in each OSC application. + +#### bHaptics Bind Port + +![Change bHaptics bind port](../images/bhapticsbindport.png) + +#### VRCFaceTracking Bind Port + +![Change VRCFT bind port](../images/vrcftbindport.png) + +3. Make sure all your configuration changes are saved in all apps. + +4. Start your apps and VOR. \ No newline at end of file diff --git a/images/bhapticsbindport.png b/images/bhapticsbindport.png new file mode 100644 index 0000000..6bff4af Binary files /dev/null and b/images/bhapticsbindport.png differ diff --git a/images/bhapticsexampleapp.png b/images/bhapticsexampleapp.png new file mode 100644 index 0000000..024ddad Binary files /dev/null and b/images/bhapticsexampleapp.png differ diff --git a/images/vrcftbindport.png b/images/vrcftbindport.png new file mode 100644 index 0000000..c617be8 Binary files /dev/null and b/images/vrcftbindport.png differ diff --git a/images/vrcftexampleapp.png b/images/vrcftexampleapp.png new file mode 100644 index 0000000..c0b39aa Binary files /dev/null and b/images/vrcftexampleapp.png differ