github.com/diamondburned/arikawa/v2@v2.1.0/arikawa.go (about)

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