diff --git a/README.md b/README.md new file mode 100644 index 0000000..40c60fd --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# bHaptics Bridge + +![GitHub Release](https://img.shields.io/github/v/release/bhaptics/bridge) +![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/bhaptics/bridge/total) + +bHaptics Bridge captures real-time game statuses and sends haptic feedback to TactSuit devices. It currently supports the following games: Fortnite and Rocket League. + +## How to Install + +1. Download and install your games on your PC. +2. Download and install the [bHaptics Player](https://sdk-apis.bhaptics.com/api/v1/release-files/download-latest-by-application-name?name=bHapticsPlayer) on your PC. +3. Download and install the latest release of [bHaptics Bridge](https://github.com/bhaptics/bridge/releases/latest/). + +## How to Run + +1. Launch bHaptics Bridge. + - It will automatically start bHaptics Player if it’s not already running. +3. Connect your TactSuit devices to bHaptics Player. +4. Launch a supported game. + - bHaptics Bridge will automatically detect the game a few seconds after it launches. + - Once connected successfully, you will see "Rocket League" or "Fortnite" listed in the connection settings of bHaptics Player. + - If random text appears instead of the game name, close the game, bHaptics Player, and bHaptics Bridge, then try again.