A Golang library and framework for the Discord API.
Go to file
diamondburned 16a408bf30 wsutil: Refactored and decoupled structures for better thread safety 2020-10-28 10:19:22 -07:00
_example *: Linting and typo fixes (#134) 2020-07-29 16:58:33 -07:00
api API: fix errors in message pagination and streamline changes with other pagination methods (#150) 2020-10-19 07:47:43 -07:00
bot Bot: Fixed trailing backticks causing out of bound panic 2020-08-29 22:09:58 -07:00
discord Discord: add Mention method to mentionable Snowflakes 2020-09-24 11:54:45 -07:00
gateway {Voice,}Gateway: Fixed various race conditions 2020-10-22 10:47:27 -07:00
internal {Voice,}Gateway: Fixed various race conditions 2020-10-22 10:47:27 -07:00
session Session: Fixed a potential race condition on Close 2020-10-21 22:42:16 -07:00
state State: fix case where Role would return nil error, even though no role was found 2020-10-18 13:44:37 -07:00
utils wsutil: Refactored and decoupled structures for better thread safety 2020-10-28 10:19:22 -07:00
voice {Voice,}Gateway: Fixed various race conditions 2020-10-22 10:47:27 -07:00
webhook Webhook: fix incorrect order of parameters 2020-07-29 20:03:24 -07:00
.editorconfig Minor fixes, undocumented things, and editorconfig 2020-01-19 13:54:16 -08:00
.gitlab-ci.yml CI: Increased time limit to account for slow integration tests 2020-07-11 00:06:31 -07:00
LICENSE Changed LICENSE. 2020-04-13 19:09:24 -07:00
README.md *: Linting and typo fixes (#134) 2020-07-29 16:58:33 -07:00
arikawa.go Added a root package to allow go get 2020-04-27 11:41:28 -07:00
go.mod Cleaned up go.mod 2020-06-01 13:52:15 -07:00
go.sum {Voice,}Gateway: Fixed various race conditions 2020-10-22 10:47:27 -07:00



Pipeline status        Coverage     Report Card Godoc Reference        Examples Discord Gophers    Hime Arikawa

A Golang library for the Discord API.



Simple bot example without any state. All it does is logging messages sent into the console. Run with BOT_TOKEN="TOKEN" go run ..


A slightly more complicated example. This bot uses a local state to cache everything, including messages. It detects when someone deletes a message, logging the content into the console.

This example demonstrates the PreHandler feature of this library. PreHandler calls all handlers that are registered (separately from the session), calling them before the state is updated.

Advanced Bot

A pretty complicated example demonstrating the reflect-based command router that's built-in. The router turns exported struct methods into commands, its arguments into command arguments, and more.

The library has a pretty detailed documentation available in GoDoc Reference.

Comparison: Why not discordgo?

Discordgo is great. It's the first library that I used when I was learning Go. Though there are some things that I disagree on. Here are some ways that this library is different:

  • Better package structure: this library divides the Discord library up into smaller packages.
  • Cleaner API/Gateway structure separation: this library separates fields that would only appear in Gateway events, so to not cause confusion.
  • Automatic un-pagination: this library automatically un-paginates endpoints that would otherwise not return everything fully.
  • Flexible underlying abstractions: this library allows plugging in different JSON and Websocket implementations, as well as direct access to the HTTP client.
  • Flexible API abstractions: because packages are separated, the developer could choose to use a lower level package (such as gateway) or a higher level package (such as state).
  • Pre-handlers in the state: this allows the developers to access items from the state storage before they're removed.
  • Pluggable state storages: although only having a default state storage in the library, it is abstracted with an interface, making it possible to implement a custom remote or local state storage.
  • REST-updated state: this library will call the REST API if it can't find things in the state, which is useful for keeping it updated.
  • No code generation: just so the library is a lot easier to maintain.


The package includes integration tests that require $BOT_TOKEN. To run these tests, do:

go test -tags integration ./...