1. Grab the prefab (OSCLeash.prefab) from releases and drop it into your Unity project.
2. Place the prefab on the root of your model. (NOT a child of armature) Don't break prefab!
3. Select the Leash Physbone object and assign the Root Transform of the Physbone to the first bone of your leash.
4. Select the Compass object and assign the source of the Position constraint to the first bone of your leash.
5. You can find Aim Needle as a child of compass. Assign the source of the Aim Constraint to the last bone of your leash.
6. (Optional) You can animate the compass object off for remote users using IsLocal.
7. (Optional) Cross Quest/PC support? You'll need to sync the Physbone's network ID. See FAQ.
8. Enable OSC in VRChat settings. (Or reset OSC if you updated an avatar!) ~ Tutorial
9. Run the OSCLeash app and get pulled about!
10. Visit Config and fine tune settings for your taste

This is a list of all the Physbones you're using with OSCLeash.

        "PhysboneParameters":
        [
            "Leash",
            "Leash2",
            "Leash3"
        ],

OSCLeash listens for the _IsGrabbed and _Stretch parameters for every listed leash.

This requires an understanding of Physbones Parameters, Animations, and Constraints.

• Add a new source to Compass and Aim Needle for each extra leash. 0 Weight by default
• Depending on which leash _IsGrabbed, animate the weights to match the Grabbed leash.

⚠️ Motion sickness warning ⚠️

If you want to enable this feature, set TurningEnabled to True.
Currently Supports North, East, South, & West

If you had a leash up front and you want to turn to match the direction it's pulled from (EG: a Collar with the leash on the front) Set set the parameter on your Leash Physbone and config to Leash_North.

        "PhysboneParameters":
        [
            "Leash_North"
        ],

We parse the direction to control turning so "Tail_South" would work.
Whenever this leash is grabbed and pulled past the deadzone it will begin to turn.
It will continue to turn until it is greater than the TurningDeadzone value.

if LeashDirection == "North" and Z_Positive < TurningGoal:
    TurningSpeed = ((X_Negative - X_Positive) * LeashStretch * TurningMultiplier)

How OSCLeash works

Step 1: Get Leash Physbone parameters

We receive the Leash_Stretch and Leash_Grabbed parameters.
If Leash_Grabbed becomes true, we begin reading Leash_Stretch

We'll use these values in this example:

Leash_IsGrabbed = True
Leash_Stretch = $0.95$

Step 2: Gather Directional Contact values

4 Contacts (Blue) surround a object with an aim constraint and a contact at the tip. (Yellow)

Based on where the constraint is aimed, it will give us 4 values.

If it was pointing South-South-West, we would get:

Leash_Z+ = $0.0$
Leash_Z- = $0.75$
Leash_X+ = $0.0$
Leash_X- = $0.25$

Step 3: Math

Math is fun. Add the negative and positive contacts & multiply by the stretch value.

(Z_Positive - Z_Negative) * Leash_Stretch = Vertical
(X_Positive - X_Negative) * Leash_Stretch = Horizontal

So our calculation for speed output would look like:

$(0.0 - 0.75) * 0.95 = -0.7125$ = Veritcal
$(0.0 - 0.25) * 0.95 = -0.2375$ = Horizontal

Step 4: Outputs

If either value is above the walking deadzone (default 0.15) we start outputting them instead of 0.
If either value is above the running deadzone (0.7) we tell the player to run (x2 speed)

All movement values are relative to the VRC world's movement speed limits.
So we'd be moving at $142.5$% speed south and $47.5$% speed to the West.

If the values are below the deadzones or _IsGrabbed is false, send 0s for the OSC values once to stop movement.

Q: OSCLeash.exe is removed by my antivirus.
A1: This is a false positive I can't really fix. You'll need to add an exclusion.
A2: Try out the MSI version if you're having trouble with the EXE or build it yourself.

Q: OSCLeash always says Started, awaiting input
A1: Manually Reset OSC by deleting the OSC and OSC.bak folders at C:\Users\(Your username)\AppData\LocalLow\VRChat\VRChat
A2: Did you do avatar setup correctly? Make sure your leash physbone matches your config.
A3: This could potentially be a firewall issue, but before that, double check your avatar, please.

Q: Missing scripts on prefab
A1: Your VRC SDK is likely out of date or your project has errors. Please update or fix.
A2: If using the Modular Avatar prefab, you'll need to have that installed too.

Q: OSCLeash says grabbed but I don't get moved
A1: This can happen if your leash physbone does not have any stretch.
A2: Make sure self interaction is enabled, it's needed for the direction calculation.

Q: The direction OSCLeash pulls is not accurate
A1: Is your physbone too angle limited or short? If it can't move it can't get an accurate location.
A2: If your scaling up very large, scale down the Compass object ~ contacts have a max size.

Q: Quest Support
A1: You'll need to sync the network IDs of your Leash physbone between Quest & PC.
You can use VRC's Network ID Utility or the ID Assigner tool made by the community.
A2: The OSCLeash app needs to be run on a PC. (OSC is over the network though)

Q: How can I run OSCLeash with my other OSC apps
A1: Enable OSCQuery by setting useOSCQuery to true in the config.
A2: Try out a OSC Router, like OSC Switch.

Q: My Question/Issue isn't answered above
A: Discord or Git Issue