1
0
Fork 0
mirror of https://github.com/diamondburned/arikawa.git synced 2024-11-27 09:12:53 +00:00
A Golang library and framework for the Discord API.
Go to file
2020-12-18 23:47:47 -08:00
.github Fixed FUNDING.yml 2020-12-11 16:50:47 -08:00
_example Examples: Added Gateway intents and comments 2020-11-19 12:03:14 -08:00
api API: Fix integration test 2020-12-16 14:51:32 -08:00
bot Bot: Fixed unable to call Plumbed method by command 2020-12-18 15:00:21 -08:00
discord Discord: Revert "APIEmoji shouldn't be path-encoded" 2020-12-16 14:51:00 -08:00
gateway State: Add Ready Supplement handlers 2020-12-18 22:51:26 -08:00
internal Moreatomic: Cave in and use upgradable mutex over sync.Map 2020-12-18 23:47:47 -08:00
session Session: Added a handleloop abstraction 2020-11-17 12:15:05 -08:00
state State: Add Ready Supplement handlers 2020-12-18 22:51:26 -08:00
utils httputil: Fixed Multipart writer not closing 2020-12-16 14:08:31 -08:00
voice Voice: Remove state-keeping of sessions 2020-11-30 19:12:20 -08:00
.editorconfig Minor fixes, undocumented things, and editorconfig 2020-01-19 13:54:16 -08:00
.gitlab-ci.yml CI: Bumped Dismock 2020-12-16 15:18:05 -08:00
arikawa.go *: Migrated Go Modules to v2 2020-10-28 15:39:59 -07:00
go.mod Moreatomic: Cave in and use upgradable mutex over sync.Map 2020-12-18 23:47:47 -08:00
go.sum Moreatomic: Cave in and use upgradable mutex over sync.Map 2020-12-18 23:47:47 -08:00
LICENSE Changed LICENSE. 2020-04-13 19:09:24 -07:00
README.md Updated README 2020-11-19 12:00:14 -08:00

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 .. This example only demonstrates the most simple needs; in most cases, bots should use the state or the bot router.

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 the state library. PreHandler calls all handlers that are registered (separately from the session), calling them before the state is updated.

Advanced Bot

A complex 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 is documented in details in the package documentation.

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 -race ./...