https://github.com/code-game-project/go-client
The Go client library for CodeGame.
https://github.com/code-game-project/go-client
client go
Last synced: 5 months ago
JSON representation
The Go client library for CodeGame.
- Host: GitHub
- URL: https://github.com/code-game-project/go-client
- Owner: code-game-project
- License: mit
- Created: 2022-03-18T22:51:03.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-04-19T14:17:24.000Z (about 3 years ago)
- Last Synced: 2024-03-14T23:51:37.220Z (over 2 years ago)
- Topics: client, go
- Language: Go
- Homepage:
- Size: 161 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go-Client
[](https://pkg.go.dev/github.com/code-game-project/go-client)
The Go client library for [CodeGame](https://code-game.org).
## Installation
```sh
go get github.com/code-game-project/go-client/cg
```
## Usage
```go
socket, err := cg.Connect(gameURL, gameID, playerID, playerSecret)
if err != nil {
log.Fatalf("error: %s", err)
}
// Register an event listener for the `test` event.
socket.On(TestEvent, func(event cg.Event) {
// TODO: do something with event
})
// Send a `hello_world` command.
socket.Send(HelloWorldCmd, HelloWorldCmdData{
Message: "Hello, World!",
})
// Start listening for events. Blocks until the connection is closed.
err = socket.RunEventLoop()
if err != nil {
log.Fatalf("error: %s", err)
}
// ======= ALTERNATIVELY =======
// manual event loop
for {
// NextEvent returns the next event in the queue or ok = false if there is none.
// Registered event listeners will be triggered.
// event -> The polled event. Only valid if ok == true.
// ok -> Whether there was an event in the queue
// err -> cg.ErrClosed if closed.
event, ok, err := socket.NextEvent()
if err != nil {
if err != cg.ErrClosed {
log.Fatalf("error: %s", err)
}
break
}
if ok {
// do something with event
}
}
```
## License
MIT License
Copyright (c) 2022-2023 Julian Hofmann
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.