go_boardgame_networking

Go-boardgame-networking

Go-boardgame-networking is a Go package that provides a websocket networking layer for games built with the go-boardgame package.

This project provides a lightweight http server out of the box to quickly start playing or prototyping games as well as an easy to use networking layer that can be added to a custom http server if extra configurability is desired.

Usage

Option 1 - Lightweight Server

Create and start a server

exampleBuilder := example.Builder{} // see https://github.com/quibbble/go-boardgame/blob/main/builder.go
server := NewServer(8080, GameNetworkOptions{
    Games: []bg.BoardGameBuilder{exampleBuilder}, // all game builders to add to the network
    GameExpiry: 3 * time.Hour,                    // how long to wait before cleaning an old game
})
server.ListenAndServe()

Create a new game

POST http://localhost:8080/game/create

With body:

{
    "GameKey": "ExampleKey",
    "GameID": "ExampleID",
    "Teams": ["TeamA", "TeamB"]
}

Join a game

GET ws://localhost:8080/game/join?GameKey=ExampleKey&GameID=ExampleID

On successful join:

{
    "GameID": "ExampleID",
    "Snapshot": {
        "Turn": "TeamA",
        "Teams": ["TeamA", "TeamB"],
        "Winners": [],
        "MoreData": {},
        "Actions": []
    }
}

Send a BoardGameAction message

{
    "Team": "TeamA",
    "ActionType": "DoSomething"
}

On successful processing of action receive:

{
    "GameID": "ExampleID",
    "Snapshot": {
        "Turn": "TeamA",
        "Teams": ["TeamA", "TeamB"],
        "Winners": [],
        "MoreData": {},
        "Actions": [
            {
                "Team": "TeamA",
                "ActionType": "DoSomething"
            }
        ]
    }
}

On error processing of action receive:

{
    "GameID": "ExampleID",
    "Error": "error message"
}

Option 2 - Networking Layer

Note that the pre-existing simple server implementation can be used as a reference point when integrating this networking into a custom server.

Create the networking layer

exampleBuilder := example.Builder{} // see https://github.com/quibbble/go-boardgame/blob/main/builder.go
network := NewGameNetwork(GameNetworkOptions{
    Games: []bg.BoardGameBuilder{exampleBuilder}, // all game builders to add to the network
    GameExpiry: 3 * time.Hour,                    // how long to wait before cleaning an old game
})

Create a new game

err := network.CreateGame(CreateGameOptions{
    GameKey: "ExampleKey",
    GameID: "ExampleID",
    BoardGameOptions: bg.BoardGameOptions{
        Teams: []string{"TeamA", "TeamB"},
        MoreOptions: nil, // custom game options
    },
})

Join a game

err := network.JoinGame(JoinGameOptions{
    GameKey: "ExampleKey",
    GameID: "ExampleID",
    Conn: WEBSOCKET_CONNECTION_HERE // websocket connection of the connecting player
})