Usage

Estimated reading: 3 minutes 194 views

The Synesthesia Console makes creating the haptics configuration for game integration super easy. Download and run the installer to get started creating a haptics config.

Run SynesthesiaStop.exe to stop any existing background or haptic consoles

Run the Synesthesia Console for the interactive prompt

Enter option 1 and press Enter to listen for incoming commands

Launch your game that uses PlayAnimation or SetEvent directly to trigger haptic commands.

When the application launches and initializes Chroma, the command to load the haptic configuration file is sent. When the application receives Chroma focus, the active command is sent. When PlayAnimation or SetEvent is called, the play command is sent.

				
					Command Received : "load;C++ Game Sample Application"
Command Received : "active;C++ Game Sample Application"
Command Received : "play;Effect1"

Play through all the game triggers to send any possible commands the game might use. This will be useful for generating the haptic configuration next.

Enter option 2 and press Enter to generate the haptics configuration

Enter option 0 and press Enter to use the detected application name used by the Chroma initialization

Enter option 0 and press Enter to use activate the new haptic configuration file. Now when the game triggers haptic events, the configured haptic events will play.

The haptic.config and haps default haptics effects were generated in the HapticFolders by the console.

The haptic.config contains default targeting for the generated entries for each detected command.

				
					{
    "ExternalCommands": [
        {
            "External_Command_ID": "Effect1",
            "Haptic_Events": [
                {
                    "Haptic_Effect": "Effect1",
                    "Loop": 1,
                    "Mixing": "Override",
                    "Targeting": [
                        {
                            "Gain": 1.0,
                            "Spatialization": "Global",
                            "Target": "All"
                        }
                    ]
                }
            ]
        },
		...
	]
}

Example: Hogwarts Legacy

Install the Steam version of Hogwarts Legacy.
Plug in the Razer Sensa haptic devices.
Launch the Synesthesia app (as Administrator). The Hogwarts Legacy haptic folder is already inside the package and will intercept the Chroma Events sent by the game to play the corresponding haptics. The following messages can be seen on the Synesthesia with Console app. When Hogwarts Legacy receives Chroma focus, Synesthesia.exe receives the active command, loads the config, which you can see 24 haps files that are loaded with the config.
Launch the Hogwarts Legacy game.
Stupefy!*

*Hogwarts Legacy uses a Chroma animation for each spell cast. It is using the default Chroma event forwarding. When PlayAnimation is invoked, the path to the animation is sent to SetEventName. To be more efficent, UseForwardChromaEvents could have been set to false and SetEventName can be set directly. When SetEventName is called, Synesthesia.exe receives the command id.