Documentation index for AI agents

GS2-Gateway API Reference

WebSocket notification feature

GS2-Gateway provides a proxy function to access GS2 via WebSocket. By using GS2-Gateway to access GS2’s servers, you can communicate with them while staying connected at all times. This is expected to improve the communication speed with the server.

This will also allow for push notifications from the server side. With this push notification functionality, you will be able to receive notifications when a task in a GS2-Mission is completed, or when the number of participants in a GS2-Matchmaking Gathering increases or decreases.

If the device being notified is offline, the system also provides a mechanism for forwarding to mobile push notifications using Firebase (https://firebase.google.com/). With this feature, if a player is offline when matchmaking is completed, a mobile push notification can be sent out to entice the player to return to the game.

When building an always-on session with GS2-Gateway, you will need to authenticate with an access token issued by GS2-Auth to identify the game player, but you can also use the If a session already exists for the same user, access can be denied.


GS2-Gateway SDK for Game Engine API Reference

Specifications of models and API references for GS2-Gateway SDK for Game Engine

GS2-Gateway SDK API Reference

Specification of models and API references for GS2-Gateway SDK for various programming languages

GS2-Gateway Deploy/CDK Reference

The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK