VRChat Shocker Link

This simple python program connects a VRChat avatar parameter with your PiShock or OpenShock device
It has chat message support, curve for intensity and a few more settings you can easily change in the UI
Report Bug or Request Feature

demo.mp4

Table of Contents

1. Getting Started
   • Prerequisites
   • Installation
2. Roadmap
3. Contributing
4. License
5. Contact

Getting Started

How to setup this project

Prerequisites

Make sure to download this program before you continue:

• Python

Installation

1. Scroll up to the top of the page
2. Click on Code and then Download ZIP
   • Alternatively you can clone this repository using git
3. Extract the ZIP anywhere on your computer
4. Open config.yml
5. Change the SHOCK_PARAMETER to the parameter you created on your VRChat avatar and set USE_PISHOCK to false, if using a OpenShock device
6. Run RunShockerLink.bat
   • If using an OpenShock and the shocker doesn't react, change the OPENSHOCK_SHOCKER_ID in config.yml to the one you set on the website

Usage

1. Most stuff is self explanatory
2. You can right click to manually input a number in the curve
3. Temporary mode pauses changes and will return to last saved state once it is disabled again
4. Presets:

• Left click to load
• Right click to rename
• Middle click to default

Roadmap

• Use OSC Query instead of normal OSC
• Rewrite with OOP in mind
• Get shocker ID automatically from OpenShock devices
• Rework UI

See the open issues for a full list of proposed features (and known issues).

Contributing

If you have a suggestion that would make this tool better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Top contributors:

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Poprox24 - @poprox422 - poprox24.roxy@gmail.com

Project Link: https://github.com/poprox24/VRChat-Shocker-Link

(back to top)