Merge branch 'main' of github.com:Z4urce/VRC-Haptic-Pancake

README.md

@@ -1,15 +1,21 @@
-# VRChat Haptic Pancake (for trackers) [PAGE IS WIP]
-A dirt cheap solution to enable haptic feedback on the vive (and other OpenVR compatible) trackers
+# VRChat Haptic Pancake (for trackers)
+A dirt cheap solution to enable haptic feedback on the vive (and other OpenVR compatible) trackers in VRChat (Or other OSC compatible VR games)
 
 ![Promo picture that demonstrates how it works](Images/promo.png)
 
+## Contact
+
+Please join our Discord for updates and any questions.
+
+[![Discord](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/gd4dsbdX)
+
 # Prerequisites
 
-1. 3D printer (or access to a 3D printer service)
+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! You can use any material, but using a TPU will grand an extra dampening effect what can improve your tracking.
+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)
@@ -22,13 +28,37 @@ A dirt cheap solution to enable haptic feedback on the vive (and other OpenVR co
 
 ![Promo picture that demonstrates how it works](Images/sandwitch.png)
 
-5. Prepare your avatar by adding VRC Contact Receiver component to each bone you wear your tracker on.
+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 to the avatar's parameters
-7. Upload your avatar
+6. Add the parameters you've assigned to the Contact Receivers in the previous step to your Avatar's parameters.
+
+![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)
 
-8. Run the bridge app, match the trackers with the declared parameters
+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!
+
+# 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.
+- 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. 
+
+# Special Thanks
+- @BubblegumFoxxo (For helping in the testing and debugging)
+- @vulp_vibes (for giving me the idea)