https://github.com/daenney/gdq

A Go library for Games Done Quick
https://github.com/daenney/gdq

Last synced: 3 months ago
JSON representation

A Go library for Games Done Quick

• Host: GitHub
• URL: https://github.com/daenney/gdq
• Owner: daenney
• License: mit
• Created: 2020-11-25T16:13:48.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-17T11:24:11.000Z (4 months ago)
• Last Synced: 2024-10-09T10:46:49.687Z (3 months ago)
• Language: Go
• Homepage:
• Size: 85.9 KB
• Stars: 3
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


🏃 GDQ 🎮



A Go library and CLI for Games Done Quick



    

    

    

    

    



[Games Done Quick (GDQ)](https://gamesdonequick.com/) is a regular

speedrunning event that collects money for charity. The event is incredibly

fun, especially if you enjoy seeing your favourite games torn to shreds by

amazing runners and supported with great commentary and prizes to win.

This repo contains a Go library and CLI for working with the GDQ schedule. It uses the

[Tracker API](https://github.com/GamesDoneQuick/donation-tracker) to retrieve

the data.

There is also a companion [Matrix](https://matrix.org) bot over at

[GDQBot](https://github.com/daenney/gdqbot).

## Installation

### CLI

There are prebuilt binaries available for every release from v1.0.0 onwards. You

can find them [over here](https://github.com/daenney/gdq/releases).

|Platform|Architecture|Binary|

|---|---|---|

|Windows|amd64|✅|

|macOS|amd64|✅|

|macOS|arm64 (Apple Silicon)|✅|

|Linux|amd64|✅|

|Linux|arm64|✅|

### Library

```sh

$ go get github.com/daenney/gdq/v2

```

## Building

You can `go get` the library, or `git clone` and then run a `go build` followed

by a `go test ./...` to ensure everything is OK.

You can build the CLI using `go build -trimpath -o gdqctl cmd/gdqcli/*.go` or

install it directly using `go install github.com/daenney/gdq/v2/cmd/gdqcli`. See

`go help install` for where the binaries will end up.

To embed the version, commit and date at build time you'll need to add

`-X main.version=VERSION -X main.commit=SHA -X main.date=DATE` and compute

the right values yourself.

## Contributing

PRs welcome! Fork+clone the repo and send me a patch. Please ensure that:

* Make small commits that encapsulate one functional change at a time

  (implementation change, the associated tests and any doc changes)

* Every commit explains what it's trying to achieve and why

* The tests pass