2020-01-02 05:39:52 +00:00
|
|
|
# arikawa
|
|
|
|
|
|
2020-04-27 01:21:25 +00:00
|
|
|
[](https://gitlab.com/diamondburned/arikawa/pipelines )
|
2020-01-31 18:14:18 +00:00
|
|
|
[](https://gitlab.com/diamondburned/arikawa/commits/master )
|
|
|
|
|
[](https://goreportcard.com/report/github.com/diamondburned/arikawa)
|
2020-07-29 23:29:01 +00:00
|
|
|
[](https://pkg.go.dev/github.com/diamondburned/arikawa )
|
2020-01-31 18:14:18 +00:00
|
|
|
[](https://github.com/diamondburned/arikawa/tree/master/_example )
|
|
|
|
|
[](https://discord.gg/7jSf85J )
|
|
|
|
|
[](https://hime-goto.fandom.com/wiki/Hime_Arikawa )
|
2020-01-16 05:04:08 +00:00
|
|
|
|
2020-01-02 05:39:52 +00:00
|
|
|
A Golang library for the Discord API.
|
2020-01-16 03:28:21 +00:00
|
|
|
|
2020-01-18 21:51:57 +00:00
|
|
|
## Examples
|
|
|
|
|
|
|
|
|
|
### [Simple](https://github.com/diamondburned/arikawa/tree/master/_example/simple)
|
|
|
|
|
|
|
|
|
|
Simple bot example without any state. All it does is logging messages sent into
|
2020-07-29 23:29:01 +00:00
|
|
|
the console. Run with `BOT_TOKEN="TOKEN" go run .`.
|
2020-01-18 21:51:57 +00:00
|
|
|
|
|
|
|
|
### [Undeleter](https://github.com/diamondburned/arikawa/tree/master/_example/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
|
2020-07-29 23:29:01 +00:00
|
|
|
calls all handlers that are registered (separately from the session), calling
|
|
|
|
|
them before the state is updated.
|
2020-01-18 21:51:57 +00:00
|
|
|
|
2020-01-20 03:45:11 +00:00
|
|
|
### [Advanced Bot](https://github.com/diamondburned/arikawa/tree/master/_example/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
|
2020-07-29 23:29:01 +00:00
|
|
|
Reference](https://pkg.go.dev/github.com/diamondburned/arikawa/bot).
|
2020-01-20 03:45:11 +00:00
|
|
|
|
2020-01-18 21:51:57 +00:00
|
|
|
## Comparison: Why not discordgo?
|
|
|
|
|
|
|
|
|
|
Discordgo is great. It's the first library that I used when I was learning Go.
|
2020-01-19 16:35:32 +00:00
|
|
|
Though there are some things that I disagree on. Here are some ways that this
|
|
|
|
|
library is different:
|
2020-01-18 21:51:57 +00:00
|
|
|
|
|
|
|
|
- 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.
|
2020-01-19 21:54:16 +00:00
|
|
|
- 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.
|
2020-01-18 21:51:57 +00:00
|
|
|
- No code generation: just so the library is a lot easier to maintain.
|
|
|
|
|
|
2020-01-16 03:28:21 +00:00
|
|
|
## Testing
|
|
|
|
|
|
|
|
|
|
The package includes integration tests that require `$BOT_TOKEN`. To run these
|
2020-07-29 23:29:01 +00:00
|
|
|
tests, do:
|
2020-01-16 03:28:21 +00:00
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
export BOT_TOKEN="<BOT_TOKEN>"
|
|
|
|
|
go test -tags integration ./...
|
|
|
|
|
```
|
