Realtime
Provides real-time updates from the Key/Value Store via WebSockets. Ideal for live data synchronization between game clients and backend services.
Last updated
Was this helpful?
Provides real-time updates from the Key/Value Store via WebSockets. Ideal for live data synchronization between game clients and backend services.
Last updated
Was this helpful?
Creates a websocket connection to the realtime service, sending messages to the realtime service will subscribe you to different resources allowing you to listen to document updates in realtime. When subscribing if a resource doesn't exist yet a listener will be created and will be triggered when the resource is created. If the resource is deleted the listener will still exist so make sure to unsubscribe when you no longer need the resource.
When connecting via a html websocket you will need to parse all of your headers in through Sec-WebSocket-Protocol
which is an optional header that takes in a string. Format for the string needs to be a list of headers split by \n and
key value split by : and then encoded into base58
Example format
x-m2-organization:testOrg x-m2-project:testProj
Example messages for subscribing to the resources available in the realtime service -
KVStore:
{
"action": "subscribe",
"resource": {
"type": "kvStore",
"id": "World:kvstoreClient:testKey"
}
}
Collections:
{
"action": "subscribe",
"resource": {
"type": "collection",
"id": "public"
}
}
Liveconfig:
{
"action": "subscribe",
"resource": {
"type": “liveConfig",
"id": “game"
}
}
Using the same format, you can also unsubscribe from the resources by changing the action to "unsubscribe" and sending the same resource.
Example response formats below.
{
"userId": "fakeUserId",
"resource": {
"type": "collection",
"id": "private"
},
"data": {
"userId": "fakeUserId",
"datasourceId": "fakeDatasourceId",
"userCollection": []
},
"version": "2024-01-30T15:50:35.742Z"
}
{
"warning": "resource_not_found",
"message": "KVStore resource doesn't currently exist, subscription was still made successfully"
}
{
"error": "Invalid message format"
}
The ID of an organization
The ID of a project
The ID of a world
Provides information about the service status.