package omgwords_service

Get desktop application:
View/edit binary Protocol Buffers messages

GameEventService will handle our game event API. We can connect bots to this API, or use it for sandbox mode, or for live annotations, etc.

• rpc CreateAnnotatedGame (CreateAnnotatedGameRequest, CreateAnnotatedGameResponse)

  omgwords.proto:138

  CreateAnnotatedGame creates a standalone annotated game in the editor.

  message CreateAnnotatedGameRequest

  omgwords.proto:13

  • repeated ipc.PlayerInfo players_info = 1

    PlayerInfo for annotated games do not need to be tied to a Woogles UUID. These games are meant for sandbox/annotation of a typically IRL game. The order that the players are sent in must be the order in which they play.

  • string lexicon = 2

    The lexicon is a string such as NWL20, CSW21. It must be supported by Woogles.

  • optional ipc.GameRules rules = 3

  • ipc.ChallengeRule challenge_rule = 4

  • bool public = 5

    public will make this game public upon creation - i.e., findable within the interface. Otherwise, a game ID is required. (Not yet implemented)

  message CreateAnnotatedGameResponse

  omgwords.proto:29

  • string game_id = 1

• rpc DeleteAnnotatedGame (DeleteAnnotatedGameRequest, DeleteAnnotatedGameResponse)

  omgwords.proto:141

  DeleteAnnotatedGame deletes a standalone annotated game (not part of a broadcast).

  message DeleteAnnotatedGameRequest

  omgwords.proto:96

  • string game_id = 1

  message DeleteAnnotatedGameResponse

  omgwords.proto:98

  (message has no fields)

• rpc GetCGP (GetCGPRequest, CGPResponse)

  omgwords.proto:164

  message GetCGPRequest

  omgwords.proto:104

  • string game_id = 1

  message CGPResponse

  omgwords.proto:106

  • string cgp = 1

• rpc GetGameDocument (GetGameDocumentRequest, ipc.GameDocument)

  omgwords.proto:159

  GetGameDocument fetches the latest GameDocument for the passed-in ID.

  message GetGameDocumentRequest

  omgwords.proto:94

  • string game_id = 1

• rpc GetGameOwner (GetGameOwnerRequest, GetGameOwnerResponse)

  omgwords.proto:168

  GetGameOwner returns the creator information for an annotated game

  message GetGameOwnerRequest

  omgwords.proto:108

  • string game_id = 1

  message GetGameOwnerResponse

  omgwords.proto:110

  • string creator_id = 1

  • string creator_username = 2

  • bool found = 3

• rpc GetGamesForEditor (GetGamesForEditorRequest, AnnotatedGamesResponse)

  omgwords.proto:153

  message GetGamesForEditorRequest

  omgwords.proto:42

  • string user_id = 1

  • uint32 limit = 2

  • uint32 offset = 3

  • bool unfinished = 4

• rpc GetMyUnfinishedGames (GetMyUnfinishedGamesRequest, AnnotatedGamesResponse)

  omgwords.proto:155

  message GetMyUnfinishedGamesRequest

  omgwords.proto:58

  Assume we can never have so many unfinished games that we'd need limits and offsets. Ideally we should only have one unfinished game per authed player at a time.

  (message has no fields)

• rpc GetRecentAnnotatedGames (GetRecentAnnotatedGamesRequest, AnnotatedGamesResponse)

  omgwords.proto:161

  message GetRecentAnnotatedGamesRequest

  omgwords.proto:49

  • uint32 limit = 1

  • uint32 offset = 2

  • bool unfinished = 3

• rpc ImportGCG (ImportGCGRequest, ImportGCGResponse)

  omgwords.proto:165

  message ImportGCGRequest

  omgwords.proto:31

  • string gcg = 1

  • string lexicon = 2

  • optional ipc.GameRules rules = 3

  • ipc.ChallengeRule challenge_rule = 4

  message ImportGCGResponse

  omgwords.proto:38

  • string game_id = 1

• rpc PatchGameDocument (PatchDocumentRequest, GameEventResponse)

  omgwords.proto:150

  PatchGameDocument merges in the passed-in GameDocument with what's on the server. The passed-in GameDocument should be a partial document

  message PatchDocumentRequest

  omgwords.proto:102

  • optional ipc.GameDocument document = 1

• rpc ReplaceGameDocument (ReplaceDocumentRequest, GameEventResponse)

  omgwords.proto:147

  message ReplaceDocumentRequest

  omgwords.proto:100

  • optional ipc.GameDocument document = 1

• rpc SendGameEvent (AnnotatedGameEvent, GameEventResponse)

  omgwords.proto:144

  SendGameEvent is how one sends game events to the Woogles API.

  message AnnotatedGameEvent

  omgwords.proto:74

  • optional ipc.ClientGameplayEvent event = 1

    event is the client gameplay event that represents a player's move. A move can be a tile placement, a pass, an exchange, a challenge, or a resign. Maybe other types in the future. This event is validated, processed, and turned into one or more ipc.GameEvents, for storage in a GameDocument.

  • string user_id = 2

    The user_id for this gameplay event.

  • uint32 event_number = 3

    The event_number is ignored unless the amendment flag is on.

  • bool amendment = 4

    Amendment is true if we are amending a previous, already played move. In that case, the event number is the index of the event that we wish to edit. Note: not every ClientGameplayEvent maps 1-to-1 with internal event indexes. In order to be sure you are editing the right event, you should fetch the latest version of the GameDocument first (use the GetGameDocument call).

• rpc SetAnnotatedGamePrivacy (AnnotatedGamePrivacy, GameEventResponse)

  omgwords.proto:151

  message AnnotatedGamePrivacy

  omgwords.proto:40

  • bool public = 1

• rpc SetRacks (SetRacksEvent, GameEventResponse)

  omgwords.proto:146

  SetRacks sets the rack for the players of the game.

  message SetRacksEvent

  omgwords.proto:117

  SetRacksEvent is the event used for sending player racks.

  • string game_id = 1

  • repeated bytes racks = 2

    racks are sent as byte arrays, in the same order as the players. If you only have partial or unknown rack info, send a partial or empty rack for that user. Note: internally, every letter is represented by a single byte. The letters A-Z map to 1-26, and the blank (?) maps to 0, for the English letter distribution. For other letter distributions, the mapping orders can be found in the letter distribution files in this repo.

  • uint32 event_number = 3

    The event_number is ignored unless the `amendment` flag is set.

  • bool amendment = 4

    `amendment` should be true if we are amending a previous, already played rack. In that case, the event number is the index of the event whose rack we wish to edit.

Used as response type in: GameEventService.GetGamesForEditor, GameEventService.GetMyUnfinishedGames, GameEventService.GetRecentAnnotatedGames

• repeated AnnotatedGamesResponse.AnnotatedGame games = 1

Used in: AnnotatedGamesResponse

• string game_id = 1

• string creator_id = 2

• bool private = 3

• bool finished = 4

• repeated ipc.PlayerInfo players_info = 5

• string lexicon = 6

• optional google.protobuf.Timestamp created_at = 7

• string creator_username = 8

• int32 points_gained = 1

GameEventResponse doesn't need to have any extra data. The GameEvent API will still use sockets to broadcast game information.

Used as response type in: GameEventService.PatchGameDocument, GameEventService.ReplaceGameDocument, GameEventService.SendGameEvent, GameEventService.SetAnnotatedGamePrivacy, GameEventService.SetRacks

(message has no fields)

• int32 points_lost = 1