A server and prefab combo prioritizing practical usability and easy customization.
- In-game haptic configuration
- 350hz Motor Update Rate
- Cheap Hardware (~$50USD)
- One-Click Avi Install
- Unlimited Play Time*
- Comfort with custom fitted arrangement
- Eliminate Bhaptics bugs
- Automatic Netowork Discovery
(Support for any Bhaptics equipped avatar coming soon)
*Unlimited play time provided by fast charge USB power banks and low current haptics
I found SenseShift but was unsatisfied with the bugs present in the bhaptics system for VRC. I also found CaiVR's Project, (Youtube Video) but he has expressed disinterest in continuing development itterations. So I started designing a relatively simple Hardware, Firmware, Server, and Prefab stack based on his groundwork but with greatly expanded goals. The stack is in its basic stages but has proven (to me) reliable and simple enough in use.
Credit for initial hardware, firmware, and software development goes to CaiVR. His initial development spurred a lot of motivation that got this functional.
Please use the Issues tab for any issues with the software. I'll get a discord up eventually. If I dont respond to an issue or you would like to discuss something:
discord:@is_average
The Server Is Not Currently Quest Compatible
Prequisites:
- Any modern Python 3.x version: https://www.python.org/downloads/
- Make sure to check the "Add Python To PATH" box during isntallation
- This repository
- Green button -> "Download ZIP"
- or
git clone https://github.com/virtuallyaverage/VRC-Haptics-Host.git
Installation:
- Extract repository into desired install folder.
- Open a powershell and run:
cd "{Insert file path to unzipped folder}/VRC-Haptics-Host/Server" - Install requirements by running:
pip install -r "requirements.txt"
Finally, right-click on the Haptics Server SEND ME TO DESKTOP.lnk file and select the "SEND TO" menu and select "Desktop". This should put the file on the desktop which will start the server when ran. It should also be available from the windows search bar by searching "haptics" or something similar after a computer restart.
Hardware: No solid versions of hardware are available at this time. I am currently using a very rough alpha setup. Early Alpha Vest Version
Firmware: See the firmware page: (readme coming soon) VRC-Haptics-Firmware
The very quickly designed case used in the alpha: Onshape Link
Game Integration:
The Prefab Uses VRCFury to integrate configuration options into the base of the avatars menu. At any time this prefab can be disabled/deleted without permanantly modifying the avatar at any point. Radial Menu
In the Unity folder, the Haptics Prefab includes both a full PC and a quest version that only shows the collider placement. VRCFURY is used to integrate the menus and avatar placement. It should be as simple as importing vrcfury in VRC Creator Companian and dragging a prefab onto the base of the avatar and uploading.
- More App support
- Improved VRC Integration
- Live Server Configuration
- Better Error handling
- Working UI
- Automatic Unity Installer
- Modular Structure
- Custom/Easy Feedback Configurations
My time for this project is very limited at the moment since I work 60-70hrs a week and have medical issues. ANY little thing helps, even if it is just reordering what is already there. Anyone willing to write good(readable) documentation for the project is worth their weight in gold to me.
There are ALOT of areas that need improvement immediately. The current codebase is a wreck, there is no proper scope management, and I kind of scattered functions willy-nilly during initial developement.
- Major Refactoring
- split out functions to their own modules
- implement proper scope management
- document functions/objects
- Start project docs
- The goal is to have an actual wiki eventually
- Create Platform.io project
- Same documentation standards as the server.
- Streamline Setup
- auto start with vrc
- edit batch file to pull updates from github
- edit batch file to check configurations
Contribution is more than appreciated, but please keep it close/aligned with the projects over all goals:
- Robust
- not many "hacky" work arounds
- feel free to open a branch on your own fork if you would like to work in collaboration before merging to main
- Simple To set up
- users shouldn't have to spend half an hour downloading python dependencies, something similar to AUTOMATIC's Stable Diffusion is the goal.
- Follow common Python syntax, such as snake case variables
- Readable Code
- I would prefer having slightly less performant code if it is easily understandable.
- Please avoid ambigous variable naming (temp, i, j, etc.)
If the project takes off then rules and goals can change as needed.