(Golang) Go bindings for Discord
Clone or download
bwmarrin Merge pull request #460 from spencer1573/patch-1
added clarification when initializing discordgo
Latest commit 73f6772 Apr 4, 2018
Permalink
Failed to load latest commit information.
docs Slight update.. Apr 26, 2016
examples Update main.go Nov 19, 2017
tools/cmd/eventhandlers Remove type checks for handlers, it's done implicitly in the handlerF… Dec 29, 2016
.travis.yml travis: update go versions Jan 26, 2018
LICENSE Rename GoDiscord to Discordgo in LICENSE (develop) May 17, 2016
README.md added clarification when initializing discordgo Oct 20, 2017
discord.go Merge branch 'develop' and bump Version to v0.18.0 Dec 27, 2017
discord_test.go Remove tests against email/password. Dec 27, 2017
endpoints.go Added fix for #437 (#452) Oct 9, 2017
event.go Update event.go Nov 19, 2017
eventhandlers.go Added user notes (#361) Apr 28, 2017
events.go Added user notes (#361) Apr 28, 2017
logging.go Update logging.go Nov 19, 2017
message.go Linting. Sep 3, 2017
message_test.go ContentWithMoreMentionsReplaced for roles and nicks (Fixes #208) (#375) Jun 13, 2017
mkdocs.yml Some website contented added :) Apr 26, 2016
oauth2.go Add missing fields to Application struct Apr 10, 2017
oauth2_test.go Remove tests against email/password. Dec 27, 2017
ratelimit.go Linting. Nov 8, 2017
ratelimit_test.go Ratelimits (#273) Nov 4, 2016
restapi.go If there's an err, return it :) Dec 27, 2017
restapi_test.go Changed test Nickname, for fun! Nov 11, 2017
state.go Fix typo Dec 3, 2017
structs.go adds support for animated emojis (#496) Dec 22, 2017
types.go Added custom rest error type (#271) Oct 14, 2016
types_test.go Timestamp type; a string with a Parse() function Jul 28, 2016
user.go gofmt :) Nov 8, 2017
user_test.go add String() method to User (#350) Apr 7, 2017
voice.go Update voice.go Nov 19, 2017
wsapi.go Update wsapi.go Nov 19, 2017

README.md

DiscordGo

GoDoc Go report Build Status Discord Gophers Discord API

DiscordGo is a Go package that provides low level bindings to the Discord chat client API. DiscordGo has nearly complete support for all of the Discord API endpoints, websocket interface, and voice interface.

If you would like to help the DiscordGo package please use this link to add the official DiscordGo test bot dgo to your server. This provides indispensable help to this project.

  • See dgVoice package for an example of additional voice helper functions and features for DiscordGo

  • See dca for an experimental stand alone tool that wraps ffmpeg to create opus encoded audio appropriate for use with Discord (and DiscordGo)

For help with this package or general Go discussion, please join the Discord Gophers chat server.

Getting Started

master vs develop Branch

  • The master branch represents the latest released version of DiscordGo. This branch will always have a stable and tested version of the library. Each release is tagged and you can easily download a specific release and view release notes on the github releases page.

  • The develop branch is where all development happens and almost always has new features over the master branch. However breaking changes are frequently added to develop and even sometimes bugs are introduced. Bugs get fixed and the breaking changes get documented before pushing to master.

So, what should you use?

If you can accept the constant changing nature of develop then it is the recommended branch to use. Otherwise, if you want to tail behind development slightly and have a more stable package with documented releases then use master

Installing

This assumes you already have a working Go environment, if not please see this page first.

go get will always pull the latest released version from the master branch.

go get github.com/bwmarrin/discordgo

If you want to use the develop branch, follow these steps next.

cd $GOPATH/src/github.com/bwmarrin/discordgo
git checkout develop

Usage

Import the package into your project.

import "github.com/bwmarrin/discordgo"

Construct a new Discord client which can be used to access the variety of Discord API functions and to set callback functions for Discord events.

discord, err := discordgo.New("Bot " + "authentication token")

See Documentation and Examples below for more detailed information.

Documentation

NOTICE : This library and the Discord API are unfinished. Because of that there may be major changes to library in the future.

The DiscordGo code is fairly well documented at this point and is currently the only documentation available. Both GoDoc and GoWalker (below) present that information in a nice format.

  • GoDoc
  • Go Walker
  • Hand crafted documentation coming eventually.

Examples

Below is a list of examples and other projects using DiscordGo. Please submit an issue if you would like your project added or removed from this list

Troubleshooting

For help with common problems please reference the Troubleshooting section of the project wiki.

Contributing

Contributions are very welcomed, however please follow the below guidelines.

  • First open an issue describing the bug or enhancement so it can be discussed.
  • Fork the develop branch and make your changes.
  • Try to match current naming conventions as closely as possible.
  • This package is intended to be a low level direct mapping of the Discord API so please avoid adding enhancements outside of that scope without first discussing it.
  • Create a Pull Request with your changes against the develop branch.

List of Discord APIs

See this chart for a feature comparison and list of other Discord API libraries.

Special Thanks

Chris Rhodes - For the DiscordGo logo and tons of PRs