-
-
Notifications
You must be signed in to change notification settings - Fork 57
/
arikawa.go
39 lines (38 loc) · 1.46 KB
/
arikawa.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
// Package arikawa contains a set of modular packages that allows you to make a
// Discord bot or any type of session (OAuth unsupported).
//
// # Session
//
// Package session is the most simple abstraction, which combines the API
// package and the Gateway websocket package together into one. This could be
// used for minimal bots that only use gateway events and such.
//
// # State
//
// Package state abstracts on top of session and provides a local cache of API
// calls and events. Bots that either don't need a command router or already has
// its own should use this package.
//
// # Bot
//
// Package bot abstracts on top of state and provides a command router based on
// Go code. This is similar to discord.py's API, only it's Go and there's no
// optional arguments (yet, although it could be worked around). Most bots are
// recommended to use this package, as it's the easiest way to make a bot.
//
// # Voice
//
// Package voice provides an abstraction on top of State and adds voice support.
// This allows bots to join voice channels and talk. The package uses an
// io.Writer approach rather than a channel, contrary to other Discord
// libraries.
package arikawa
import (
// Low level packages.
_ "github.com/diamondburned/arikawa/v3/api"
_ "github.com/diamondburned/arikawa/v3/gateway"
// Packages that most should use.
_ "github.com/diamondburned/arikawa/v3/session"
_ "github.com/diamondburned/arikawa/v3/state"
_ "github.com/diamondburned/arikawa/v3/voice"
)