OpenShock / ShockOSC

OSC Application to interact with games implementing OSC like VRChat and ChilloutVR
https://openshock.org
Other
11 stars 6 forks source link
electrostim open-sound-control openshock osc shock-collar shock-collars vrchat-osc
OpenShock Logo

ShockOSC

[![Release Version](https://img.shields.io/github/v/release/OpenShock/ShockOsc?style=for-the-badge&color=e14a6d)](https://github.com/OpenShock/ShockOsc/releases/latest) [![Downloads](https://img.shields.io/github/downloads/OpenShock/ShockOsc/total?style=for-the-badge&color=e14a6d)](https://github.com/OpenShock/ShockOsc/releases/latest) [![Discord](https://img.shields.io/discord/1078124408775901204?style=for-the-badge&color=e14a6d&label=OpenShock%20Discord&logo=discord)](https://openshock.net/discord) ![ShockOsc](https://sea.zlucplayz.com/f/72732636ab0743c6b365/?raw=1) Used as an interface for OpenShock to communicate with applications that support OSC and OscQuery like VRChat.

Setup

Wiki

Avatar contacts setup for VRC

  1. Add a new bool parameter to your avatars (animator & params file). Name template ShockOsc/{GroupName} e.g. ShockOsc/Leg
  2. Configure one or more contact receivers on your avatar
  3. Set it to constant and have it drive the designated parameter you have just created
  4. Upload
  5. Reset & Enable OSC

Avatar PhysBone setup for VRC

You can use physbones to trigger shocks with verifying intensity based on the distance the bone is stretched once it's released.

  1. Add a new parameter to a physbone component on your avatar with the same name as your shocker, e.g. ShockOsc/Leg
  2. Add a new float parameter called ShockOsc/{GroupName}_Stretch to your avatars animator & do NOT add to params file
  3. Add a new bool parameter called ShockOsc/{ShockerName}_IsGrabbed to your avatars animator & do NOT add to params file
  4. Edit IntensityRange in the configuration file to your liking

Visual parameters

You can add some optional parameters to your avatar to visualize when the shocker is active or on cooldown. Add these parameters to your avatars animator & params file.

Virtual Groups

You can use the virtual, or pseudo, shockers with the name _Any and _All for some limited actions. Read more below.

_Any
_All

This one can be used to make all shockers configured go off at the same time or with the same trigger.
This virtual shocker behaves just like another configured shockers, except it relays its actions to all others.

Instant Shocker Action

You may append _IShock to a shocker parameter if u want a shock to trigger instantly when this bool parameter jumps to true. This is useful when working with an animator setup or have contact receivers trigger immediately.

E.g. ShockOsc/_All_IShock

Credits

ShockOsc Contributors

Support

You can support the openshock dev team here: Sponsor OpenShock