Interface ClientToServer

data: {
    uuid: string;
}

• uuid: string

data: AutomatchPreferences

data: {}

tf: boolean

data: {
    challenge_id: number;
    game_id: number;
}

• challenge_id: number

• game_id: number

data: {
    channel: string;
}

• channel: string

  Channel to join

data: {
    channel: string;
}

• channel: string

  Channel to leave

data: {
    message: string;
    player_id: number;
    uid: string;
    username: string;
}

• message: string

  Message text

• player_id: number

  Player ID of the recipient

• uid: string

  UUID for the message

• username: string

  Username of the recipient

data: {
    player_id: number;
}

• player_id: number

data: {
    player_id: number;
}

• player_id: number

data: {
    enable: boolean;
    player_id: number;
    username: string;
}

• enable: boolean

  Set to true if you want the modal to be unclosable, false if you want the modal to be closable again

• player_id: number

• username: string

  Username of the recipient

data: {
    uuid: string;
}

• uuid: string

data: {
    player_id: number;
}

• player_id: number

  Player id to remove all messages for

data: {
    channel: string;
    message: string;
    uuid: string;
}

• channel: string

  Channel to send the message to

• message: string

  Message text

• uuid: string

  ID for the message

data: {
    channel: string;
    topic: string;
}

• channel: string

• topic: string

data: {
    game_id: number;
}

• game_id: number

  The game id

data: {
    game_id: number;
}

• game_id: number

  The game id

data: {
    body: string | GameChatTranslatedMessage | GameChatAnalysisMessage | GameChatReviewMessage;
    game_id: number;
    move_number: number;
    type: "main" | "malkovich" | "moderator" | "hidden" | "personal";
}

• body: string | GameChatTranslatedMessage | GameChatAnalysisMessage | GameChatReviewMessage

  The chat message

• game_id: number

  The game id

• move_number: number

  The move number currently being viewed

• type: "main" | "malkovich" | "moderator" | "hidden" | "personal"

  The type of chat message being sent

data: {
    channel: string;
    chat_id: string;
    game_id: number;
}

• channel: string

• chat_id: string

• game_id: number

data: {
    game_id: number;
}

• game_id: number

  The game id

data: {
    conditional_moves: ConditionalMoveResponse;
    game_id: number;
    move_number: number;
}

• conditional_moves: ConditionalMoveResponse

  The conditional moves. The top level should be an array that looks like [null, { ... }] where the second element contains the responses to the opponent's move.

• game_id: number

  The game id

• move_number: number

  The move number from which the condtional moves are rooted in

data: {
    chat?: boolean;
    game_id: number;
}

• Optional chat?: boolean

  If true, the client will receive the game chat log and new chat events

• game_id: number

  The game id to connect to

data: {
    game_id: number;
}

• game_id: number

  The game id

data: {
    game_id: number;
}

• game_id: number

data: {
    game_id: number;
    latency: number;
}

• game_id: number

  The game id

• latency: number

  Network latency, measured in milliseconds. See net/ping to measure this.

data: {
    game_id: number;
}

• game_id: number

data: {
    blur?: number;
    clock?: JGOFPlayerClock;
    game_id: number;
    move: string;
}

• Optional blur?: number

  Maximum number of milliseconds the client was out of focus between the last move and this move

• Optional clock?: JGOFPlayerClock

  Clock according to the client. If this is within the margin of error of the server's clock, the server will accept the new clock value. If not provided, the server clock will be used.

• game_id: number

  The game id

• move: string

  The move number to play at

data: {
    game_id: number;
}

• game_id: number

  The game id

data: {
    game_id: number;
    stones: string;
    strict_seki_mode: boolean;
}

• game_id: number

  The game id

• stones: string

  All of the stones that are accepted as removed, and all intersections marked as dame

• strict_seki_mode: boolean

  Japanese rules technically have some special scoring rules about whether territory in seki should be counted or not. This is supported by the backend but clients should always set this to false in this era of the game, the official client no longer displays this as an option to the user as it was very largely unused and was a large source of confusion.

data: {
    game_id: number;
}

• game_id: number

  The game id

data: {
    game_id: number;
    removed: boolean;
    stones: string;
    strict_seki_mode?: boolean;
}

• game_id: number

  The game id

• removed: boolean

  True if the stones should be marked as removed (or intersections marked as dame if there is no stone there), false if they should be marked as not removed / open area.

• stones: string

  String encoded list of intersections

• Optional strict_seki_mode?: boolean

  Japanese rules technically have some special scoring rules about whether territory in seki should be counted or not. This is supported by the backend but the official client no longer displays this as an option to the user as it was very largely unused and was a large source of confusion. This field is deprecated and will likely be removed in the future.

data: {
    game_id: number;
}

• game_id: number

  The game id

data: {
    game_id: number;
}

• game_id: number

  The game id

data: {
    game_id: number;
}

• game_id: number

  The game id

data: {
    game_id: number;
    move_number: number;
}

• game_id: number

  The game id

• move_number: number

  The current move number

data: {
    game_id: number;
    move_number: number;
}

• game_id: number

  The game id

• move_number: number

  The current move number

data: {
    game_id: number;
    move_number: number;
}

• game_id: number

  The game id

• move_number: number

  The current move number

data: {
    channel?: string;
}

• Optional channel?: string

  The group or tournament channel to subscribe to. If no channel is provided, the global server counts will be sent

data: {
    channel?: string;
}

• Optional channel?: string

  The group or tournament channel to unsubscribe from. If no channel is provided, the global server counts will be unsubscribed from

data: {
    channel?: string;
    from: number;
    limit: number;
    list: "live" | "corr" | "kidsgo";
    sort_by: "rank";
    where: GameListWhere;
}

• Optional channel?: string

  The group or tournament channel to query

• from: number

  The number of games to skip before returning results

• limit: number

  Number of games to return, between 1 and 300

• list: "live" | "corr" | "kidsgo"

• sort_by: "rank"

• where: GameListWhere

  Filtering options

data: {}

data: {
    data: any;
    event: string;
}

• data: any

  User defined data

• event: string

  User defined event string

data: {
    notification_id: number;
}

• notification_id: number

data: {
    key: string;
    replication: RemoteStorageReplication;
}

• key: string

• replication: RemoteStorageReplication

data: {
    key: string;
    replication: RemoteStorageReplication;
    value: any;
}

• key: string

• replication: RemoteStorageReplication

• value: any

data: {
    since: string;
}

• since: string

  ISO 8601 timestamp. Updates made after this timestamp will be sent to the client.

data: ReviewMessage

data: {
    body: string;
    from: number;
    moves: string;
    review_id: number;
}

• body: string

  The chat message

• from: number

  The root of the branch the user is viewing

• moves: string

  The analysis branch the user is viewing

• review_id: number

  The review id

data: {
    channel: string;
    chat_id: string;
    review_id: number;
}

• channel: string

• chat_id: string

• review_id: number

data: {
    review_id: number;
}

• review_id: number

  The review id

data: {
    review_id: number;
}

• review_id: number

  The review id

data: {
    channel: "global";
}

• channel: "global"

data: {
    channel: "global";
}

• channel: "global"

data: {
    interval: number;
}

• interval: number

  Interval in seconds

data: {
    channel: string;
}

• channel: string

data: {
    channel: string;
}

• channel: string

data: {
    user_ids: number[];
}

• user_ids: number[]