ogsgamenotifier's Introduction

OGSGameNotifier

System tray application that notifies you when high rated ranked dan games on https://www.online-go.com/ occurs. Created because I like to watch high quality games of Go and develop applications in Go.

Features

Example notification under Linux Mint 20.1 Cinnamon:

Systemtray app with adjustable min median dan rating
OS native notifications
Prebuilt binaries for Windows and Linux

TODO

Unit tests
Blacklist players from notifications
Remove the websocket dependency and rewrite using the stdlib
- Tracability for message and socket errors
- Has built in ping message that we don't need, we have our own don't need 2
- Alive-method seems to be bugged at times (mutex locked)

Install

Prebuilt binaries for Windows and Linux are found under releases.

Build from source

Built and tested with go version go1.17 linux/amd64 on Linux Mint 20.1 Cinnamon, anything else is untested and may require additional steps from the dependency list below.

Requirements

Go (version>=1.17) https://golang.org/doc/install
systray deps: sudo apt-get install gcc libgtk-3-dev libappindicator3-dev libxapp-dev

Steps

> git clone https://github.com/vidfamn/OGSGameNotifier.git
> cd OGSGameNotifier
> make build

On success, binaries will be found in the bin-directory.

Dependencies

Helpful resources

Since OGS does not have any proper documentation, I had to reverse engineer some parts. Could probably be done in a better way but without API documentation it's hard to know what's possible and how it works. I found the following resources helpful:

License

OGSGameNotifier by Sonny Vidfamn is licensed under a Creative Commons Attribution 4.0 International License.
Based on a work at https://www.github.com/vidfamn/OGSGameNotifier.

ogsgamenotifier's People

vidfamn / ogsgamenotifier Goto Github PK