mirror of
https://github.com/diamondburned/arikawa.git
synced 2024-11-16 03:44:26 +00:00
feb624758b
This commit rewrites some parts of the README. It removes the section about package bot, because we all should just forget that it ever existed. Thanks, Discord. It also removes a section that compared the library against Discordgo. The section was written 3 years ago so it was very outdated. Instead, it is replaced with a "Library Highlights" section, which provides much more insights on the library itself.
128 lines
4.5 KiB
Markdown
128 lines
4.5 KiB
Markdown
# arikawa
|
|
|
|
[![ Pipeline Status ][pipeline_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/v3/0-examples
|
|
[examples_img]: https://img.shields.io/badge/Example-__example%2F-blueviolet?style=flat-square
|
|
|
|
[pipeline]: https://builds.sr.ht/~diamondburned/arikawa
|
|
[pipeline_img]: https://builds.sr.ht/~diamondburned/arikawa.svg?style=flat-square
|
|
|
|
[pkg.go.dev]: https://pkg.go.dev/github.com/diamondburned/arikawa/v3
|
|
[pkg.go.dev_img]: https://pkg.go.dev/badge/github.com/diamondburned/arikawa/v3
|
|
|
|
[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
|
|
|
|
|
|
## Library Highlights
|
|
|
|
- More modularity with components divided up into independent packages, such as
|
|
the API client and the Websocket Gateway being fully independent.
|
|
- Clear separation of models: API and Gateway models are never mixed together so
|
|
to not be confusing.
|
|
- Extend and intercept Gateway events, allowing for use cases such as reading
|
|
deleted messages.
|
|
- Pluggable Gateway cache allows for custom caching implementations such as
|
|
Redis, automatically falling back to the API if needed.
|
|
- Typed Snowflakes make it much harder to accidentally use the wrong ID (e.g.
|
|
it is impossible to use a channel ID as a message ID).
|
|
- Working user account support, with much of them in [ningen][ningen]. Please
|
|
do not use this for self-botting, as that is against Discord's ToS.
|
|
|
|
[ningen]: https://github.com/diamondburned/ningen
|
|
|
|
|
|
## Examples
|
|
|
|
### [Commands (Hybrid)](https://github.com/diamondburned/arikawa/tree/v3/0-examples/commands-hybrid)
|
|
|
|
commands-hybrid is an alternative variant of
|
|
[commands](https://github.com/diamondburned/arikawa/tree/v3/0-examples/commands),
|
|
where the program permits being hosted either as a Gateway-based daemon or as a
|
|
web server using the Interactions Webhook API.
|
|
|
|
Both examples demonstrate adding interaction commands into the bot as well as an
|
|
example of routing those commands to be executed.
|
|
|
|
### [Simple](https://github.com/diamondburned/arikawa/tree/v3/0-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.
|
|
|
|
**Note** that Discord discourages use of bots that do not use the interactions
|
|
API, meaning that this example should not be used for bots.
|
|
|
|
### [Undeleter](https://github.com/diamondburned/arikawa/tree/v3/0-examples/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.
|
|
|
|
**Note** that Discord discourages use of bots that do not use the interactions
|
|
API, meaning that this example should not be used for bots.
|
|
|
|
### Bare Minimum Messaging Example
|
|
|
|
The least amount of code recommended to have a bot that logs all messages to
|
|
console.
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"log"
|
|
"os"
|
|
"os/signal"
|
|
|
|
"github.com/diamondburned/arikawa/v3/gateway"
|
|
"github.com/diamondburned/arikawa/v3/state"
|
|
)
|
|
|
|
func main() {
|
|
s := state.New("Bot " + os.Getenv("BOT_TOKEN"))
|
|
s.AddIntents(gateway.IntentGuilds | gateway.IntentGuildMessages)
|
|
s.AddHandler(func(m *gateway.MessageCreateEvent) {
|
|
log.Printf("%s: %s", m.Author.Username, m.Content)
|
|
})
|
|
|
|
ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt)
|
|
defer cancel()
|
|
|
|
if err := s.Connect(ctx); err != nil {
|
|
log.Println("cannot connect:", err)
|
|
}
|
|
}
|
|
```
|
|
|
|
|
|
## 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 ./...
|
|
```
|