mirror of
https://github.com/diamondburned/arikawa.git
synced 2024-09-17 15:38:46 +00:00
99 lines
4.3 KiB
Markdown
99 lines
4.3 KiB
Markdown
# arikawa
|
|
|
|
[![ Pipeline Status ][pipeline_img ]][pipeline ]
|
|
[![ Coverage ][coverage_img ]][pipeline ]
|
|
[![ Report Card ][goreportcard_img]][goreportcard]
|
|
[![ Godoc Reference ][pkg.go.dev_img ]][pkg.go.dev ]
|
|
[![ Examples ][examples_img ]][examples ]
|
|
[![ Discord Gophers ][dgophers_img ]][dgophers ]
|
|
[![ Hime Arikawa ][himeArikawa_img ]][himeArikawa ]
|
|
|
|
A Golang library for the Discord API.
|
|
|
|
[dgophers]: https://discord.gg/7jSf85J
|
|
[dgophers_img]: https://img.shields.io/badge/Discord%20Gophers-%23arikawa-%237289da?style=flat-square
|
|
|
|
[examples]: https://github.com/diamondburned/arikawa/tree/v2/_example
|
|
[examples_img]: https://img.shields.io/badge/Example-__example%2F-blueviolet?style=flat-square
|
|
|
|
[pipeline]: https://gitlab.com/diamondburned/arikawa/pipelines
|
|
[pipeline_img]: https://gitlab.com/diamondburned/arikawa/badges/v2/pipeline.svg?style=flat-square
|
|
[coverage_img]: https://gitlab.com/diamondburned/arikawa/badges/v2/coverage.svg?style=flat-square
|
|
|
|
[pkg.go.dev]: https://pkg.go.dev/github.com/diamondburned/arikawa/v2
|
|
[pkg.go.dev_img]: https://pkg.go.dev/badge/github.com/diamondburned/arikawa/v2
|
|
|
|
[himeArikawa]: https://hime-goto.fandom.com/wiki/Hime_Arikawa
|
|
[himeArikawa_img]: https://img.shields.io/badge/Hime-Arikawa-ea75a2?style=flat-square
|
|
|
|
[goreportcard]: https://goreportcard.com/report/github.com/diamondburned/arikawa
|
|
[goreportcard_img]: https://goreportcard.com/badge/github.com/diamondburned/arikawa?style=flat-square
|
|
|
|
|
|
## 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
|
|
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](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 the state library.
|
|
PreHandler calls all handlers that are registered (separately from the session),
|
|
calling them before the state is updated.
|
|
|
|
### [Advanced Bot](https://github.com/diamondburned/arikawa/tree/master/_example/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](https://pkg.go.dev/github.com/diamondburned/arikawa/bot).
|
|
|
|
|
|
## 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:
|
|
|
|
```sh
|
|
export BOT_TOKEN="<BOT_TOKEN>"
|
|
go test -tags integration -race ./...
|
|
```
|