Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Z4urce authored Jan 28, 2024
1 parent a6791f6 commit 2759cf8
Showing 1 changed file with 6 additions and 44 deletions.
50 changes: 6 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,61 +3,23 @@ A dirt cheap solution to enable haptic feedback on the vive (and other OpenVR co

![Promo picture that demonstrates how it works](Images/promo.png)

## Contact
# Contact

Please join our Discord for updates and any questions.
Curious about the development? Have any questions? Join the discord!

[![Discord](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/gd4dsbdX)

# Prerequisites

1. Access to a 3D printer (or a 3D printer service)
2. A vibration motor for each tracker. I recommend [this one.](https://www.aliexpress.com/item/1005004653448729.html "Link to Aliexpres")

# Guide
1. Let's 3D print the pancake! (It's the STL file from the [Releases](https://github.com/Z4urce/VRC-Haptic-Pancake/releases) page) You can use any material, but using a TPU will grand an extra dampening effect what can improve your tracking.
2. Put the motor inside. If it feels lose, use a bit of duct tape on the side.

![Promo picture that demonstrates how it works](Images/pancake.png)

3. Attach the cables accoring to the image. Push the pogo pins a bit down with one finger and snap the cable inside its locking mechanism.

![Promo picture that demonstrates how it works](Images/cable.png)

4. Screw back the tracker on the strap

![Promo picture that demonstrates how it works](Images/sandwitch.png)

5. Prepare your avatar by adding a VRC Contact Receiver component to each bone you wear your tracker on.
* Ensure that it has been positioned properly and only "Allow Others" is enabled in the Filtering settings.
* Feel free to define which collision tags will trigger your haptics by adding the specific collision tags.
* Set the Receiver Type to Proximity (This is the only supported type for now in the bridge app)
* Come up with a good unique name for the parameter. For example 'LeftFootTouched' if you want to trigger the haptics in the tracker on your left foot. The name itself can be whatever and it does not really matter as long as you get it right everywhere.

![Promo picture that demonstrates how it works](Images/unity.png)

6. Add the parameters you've assigned to the Contact Receivers in the previous step to your Avatar's parameters. It should be a Float with 0 as default value. Do not check the Saved and Synced checkmarks!

![Promo picture that demonstrates how it works](Images/params.png)

8. Upload your avatar
9. If you are updating an existing avatar, be sure to clear your `AppData\LocalLow\VRChat\VRChat\OSC\` directory or else VRChat won't recognise the new parameter.

![Promo picture that demonstrates how it works](Images/bridgeapp.png)

10. Run the bridge app, (It's the EXE file from [Releases](https://github.com/Z4urce/VRC-Haptic-Pancake/releases) page) match the trackers with the declared parameters. You can press the 'Test' button to send them a short vibration. Note that the app requires SteamVR running in the background.
11. Enjoy and have fun!
# How to make
[> Check out the Wiki for a full guide! <](https://github.com/Z4urce/VRC-Haptic-Pancake/wiki)

# Planned Features
- Per tracker intensity setting
- Haptic Feedback cooldown and trigger patterns
- Support for DIY haptic devices through serial connection

# Frequently Asked Questions
- Will this affect my tracking?
- Continous vibration will drift tracking, but it will readjust itself as soon as the vibration stops. A solution for this is to vibrate the trackers in patterns instead of constantly. This solution will be implemented in the next release.
- Since I implemented the vibration pattern system, it barely affects the tracking. But it still depends on the selected pattern. For example You should experience minor to no drifting with the 'Linear' one.
- Can I put the tracker elsewhere after setting up my avatar?
- None of the trackers are permanently linked to any parts of your avatar. In fact you can even hotswap them. Just ensure you are using the right parameters in the bridge app.
- Yes. None of the trackers are permanently linked to any parts of your avatar. In fact you can even hotswap them. Just ensure you are using the right parameters in the bridge app.

# Special Thanks
- @BubblegumFoxxo (For helping in the testing and debugging)
Expand Down

0 comments on commit 2759cf8

Please sign in to comment.