rei

QCK Prism Cloth Javascript interface

Description

what

Rei is a javascript interface between the Gamesense Engine and any other app through a server listening for notification messages.

why

To control QCK Prism Cloth XL to receive external visual notifications from other apps via plugins.

research

GameSense notifications flow

The GameSense engine receives POST calls on the server port (references on GameSense server and port).

execute steelseries engine and check the port`

cat /Library/Application\ Support/SteelSeries\ Engine\ 3/coreProps.json

Let's say we are going to bind a new game called JOBSTATUS with a HEALTH event to send HEALTH notifications to the Prism Cloth

Bind Game event

POST 127.0.0.1:49494/bind_game_event

{
    "game": "JOBSTATUS",
    "event": "HEALTH",
    "min_value": 0,
    "max_value": 100,
    "handlers": [
        {
        "device-type": "indicator",
        "zone": "one",
        "color": {
            "red": 255,
            "green": 247,
            "blue": 0
        },
        "mode": "color"
        }
    ]
}

And then we are ready to send Game Events to the JOBSTATUS game

POST 127.0.0.1:49494/game_event

{
    "game": "JOBSTATUS",
    "event": "HEALTH",
    "data": {
        "value": 75
    }
}

Remember to send a heatbeat (color event lasts 15s adn then returns to the previous color loop it was before the event)

POST 127.0.0.1:49494/game_heartbeat
```
{
    "game": "JOBSTATUS"
}
```

Project plan

Mindmap

Roadmap

References

Gamesense Engine SDK

https://github.com/SteelSeries/gamesense-sdk/blob/master/doc/api/sending-game-events.md

ozipi/rei

rei