Skip to content
V1perN3st edited this page Apr 7, 2024 · 2 revisions

Welcome to the Wiki for the bHaptics Firebot Startup Script

What is bHaptics?

bHaptics is a set of tactile suit with vibro-tactile motors and has lag-free wireless connectivity to bring the best possible haptics experience. This includes a vest (both 16 and 40), gloves, arm, feed, and face (for VR). It can be used for VR or Flat Screen games. If the game has support be bHaptics, events in the game will trigger the bHaptics suit to give a real feeling for what happened (ie. someone hits you, the motors will play a patter mimicking the hit). Also, the vest can be used in Audio mode so you can really feel the beat.

What is the Startup Script used for?

This startup script is used to allow Firebot to trigger bHaptics Suites. This means you can have events that Firebot can control or monitor, trigger the bHaptics items to play a pattern.

How do you get bHaptics Patterns (called TACT files)?

If you have someone who uses bHaptics, they might already have TACT files that can be used. The other option is to create them yourself. They can be created using bHaptics Studio (https://studio.bhaptics.com/). It requires a login, but that is free. This will output a TACT file that can be imported into the script, or you can copy the content (which is just a JSON string) into the RAW section of the script.

What is needed for this to work?

You will need Firebot (obviously), this script, bHaptics Player (free; https://www.bhaptics.com/software/player), and bHaptics Suit (https://www.bhaptics.com/tactsuit).

What is the status of the Startup Script?

I am still working on parts of the script, but the basics of the system is working (in that it will Register TACT Files, Submit Registered Keys, Stop Active Keys, and Stop All Keys). Events for Connection, Disconnection, and Active Key are also working. I am still working on more Events, Submit Dots, Submit Path, Variables, and anything else that could be helpful. I am limited in what can be done due to a lack of API documents and my learning knowledge of TypeScript, Firebot Scripting, Github, and Visual Studio (basically, I am new to all of them), but I will do what I can to get the reset of the items completed, resolve any bugs that pop up, and maintain the script. Below is a status list, new items will be added as they come up.

Status Item
✔️ Register TACT File (File or RAW)
✔️ Submit Registrated Key
✔️ Submit Scaled Registrated Key
✔️ Submit Rotation Registrated Key
Submit Dot
Submit Path
✔️ Stop Active Registrated
✔️ Stop All Active
✔️ Connection Event
✔️ Disconnect Event
Position Connection Event
✔️ Submitted Registration Event
Active Registration Event