github.com/meowstercatel/discordgo@v0.0.0-20250615204139-29b43d676735/docs/GettingStarted.md (about)

     1  # Getting Started
     2  
     3  This page is dedicated to helping you get started on your way to making the
     4  next great Discord bot or client with DiscordGo. Once you've done that please
     5  don't forget to submit it to the 
     6  [Awesome DiscordGo](https://github.com/bwmarrin/discordgo/wiki/Awesome-DiscordGo) list :).
     7  
     8  
     9  **First, lets cover a few topics so you can make the best choices on how to 
    10  move forward from here.**
    11  
    12  #### Bot Application
    13  A bot application is a special program that interacts with the Discord servers
    14  to perform some form of automation or provide some type of service.  Examples 
    15  are things like number trivia games, music streaming, channel moderation, 
    16  sending reminders, playing loud airhorn sounds, comic generators, YouTube 
    17  integration, Twitch integration... You're *almost* only limited by your imagination.
    18  
    19  Bot applications require the use of a special Bot account.  These accounts are
    20  tied to your personal user account. Bot accounts cannot login with the normal
    21  user clients and they cannot join servers the same way a user does. They do not 
    22  have access to some user client specific features however they gain access to
    23  many Bot specific features.
    24  
    25  To create a new bot account first create yourself a normal user account on 
    26  Discord then visit the [My Applications](https://discord.com/developers/applications/me)
    27  page and click on the **New Application** box.  Follow the prompts from there
    28  to finish creating your account.
    29  
    30  
    31  **More information about Bot vs Client accounts can be found [here](https://discord.com/developers/docs/topics/oauth2#bot-vs-user-accounts).**
    32  
    33  # Requirements
    34  
    35  DiscordGo requires Go version 1.4 or higher.  It has been tested to compile and
    36  run successfully on Debian Linux 8, FreeBSD 10, and Windows 7.  It is expected 
    37  that it should work anywhere Go 1.4 or higher works. If you run into problems
    38  please let us know :).
    39  
    40  You must already have a working Go environment setup to use DiscordGo.  If you 
    41  are new to Go and have not yet installed and tested it on your computer then 
    42  please visit [this page](https://golang.org/doc/install) first then I highly
    43  recommend you walk though [A Tour of Go](https://tour.golang.org/welcome/1) to
    44  help get your familiar with the Go language.  Also checkout the relevant Go plugin 
    45  for your editor — they are hugely helpful when developing Go code.
    46  
    47  * Vim — [vim-go](https://github.com/fatih/vim-go)
    48  * Sublime — [GoSublime](https://github.com/DisposaBoy/GoSublime)
    49  * Atom — [go-plus](https://atom.io/packages/go-plus)
    50  * Visual Studio — [vscode-go](https://github.com/Microsoft/vscode-go)
    51  
    52  
    53  # Install DiscordGo
    54  
    55  Like any other Go package the fist step is to `go get` the package.  This will
    56  always pull the latest tagged release from the master branch. Then run 
    57  `go install` to compile and install the libraries on your system.
    58  
    59  #### Linux/BSD
    60  
    61  Run go get to download the package to your GOPATH/src folder.
    62  
    63  ```sh
    64  go get github.com/bwmarrin/discordgo
    65  ```
    66  
    67  Finally, compile and install the package into the GOPATH/pkg folder. This isn't
    68  absolutely required but doing this will allow the Go plugin for your editor to
    69  provide autocomplete for all DiscordGo functions.
    70  
    71  ```sh
    72  cd $GOPATH/src/github.com/bwmarrin/discordgo
    73  go install
    74  ```
    75  
    76  #### Windows
    77  Placeholder.
    78  
    79  
    80  # Next...
    81  More coming soon.