A Golang library and framework for the Discord API.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
diamondburned 16a408bf30 wsutil: Refactored and decoupled structures for better thread safety 9 months ago
_example *: Linting and typo fixes (#134) 1 year ago
api API: fix errors in message pagination and streamline changes with other pagination methods (#150) 10 months ago
bot Bot: Fixed trailing backticks causing out of bound panic 11 months ago
discord Discord: add Mention method to mentionable Snowflakes 10 months ago
gateway {Voice,}Gateway: Fixed various race conditions 9 months ago
internal {Voice,}Gateway: Fixed various race conditions 9 months ago
session Session: Fixed a potential race condition on Close 9 months ago
state State: fix case where Role would return nil error, even though no role was found 10 months ago
utils wsutil: Refactored and decoupled structures for better thread safety 9 months ago
voice {Voice,}Gateway: Fixed various race conditions 9 months ago
webhook Webhook: fix incorrect order of parameters 1 year ago
.editorconfig Minor fixes, undocumented things, and editorconfig 2 years ago
.gitlab-ci.yml CI: Increased time limit to account for slow integration tests 1 year ago
LICENSE Changed LICENSE. 1 year ago
README.md *: Linting and typo fixes (#134) 1 year ago
arikawa.go Added a root package to allow go get 1 year ago
go.mod Utils/API: Replaced semaphore-mutex API 1 year ago
go.sum {Voice,}Gateway: Fixed various race conditions 9 months ago

README.md

arikawa

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

A Golang library for the Discord API.

Examples

Simple

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

Undeleter

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.

Testing

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

export BOT_TOKEN="<BOT_TOKEN>"
go test -tags integration ./...