(Golang) Go bindings for Discord
Find a file
Fedor Lapshin 4ebe5a08ee
Selects component (#954)
* Interactions: the Buttons (#933)

* Interactions: buttons

* Doc fix

* Gofmt fix

* Fix typo

* Remaking interaction data into interface

* Godoc fix

* Gofmt fix

* Godoc fix

* InteractionData helper functions and some fixes in slash commands example

* Fix components example

* Yet another fix of components example

* Fix interaction unmarshaling

* Gofmt fix

* Godoc fix

* Gofmt fix

* Corrected naming and docs

* Rolled back API version

* Requested fixes

* Added support of components to webhook and regular messages

* Fix components unmarshaling

* Godoc fix

* Requested fixes

* Fixed unmarshaling issues

* Components example: cleanup

* Added components tracking to state

* Requested fixes

* Renaming fix

* Remove more named returns

* Minor English fixes

Co-authored-by: Carson Hoffman <c@rsonhoffman.com>

* Doc fix

* Gofmt fix

* Fix typo

* Remaking interaction data into interface

* Godoc fix

* Gofmt fix

* Godoc fix

* InteractionData helper functions and some fixes in slash commands example

* Fix components example

* Yet another fix of components example

* Fix interaction unmarshaling

* Godoc fix

* Gofmt fix

* Corrected naming and docs

* Rolled back API version

* Requested fixes

* Added support of components to webhook and regular messages

* Interactions: select menus

* Example fix

* Merge fix

* Some fixes

* Added missing documentation

* Fix components unmarshaling

* Godoc fix

* Requested fixes

* Fixed unmarshaling issues

* Components example: cleanup

* Gofmt fix

* Godoc fix

* URL field renaming fix

* Added flags to followups

* Updated components example

* Fixed typo in components example

* Merge fix

* Improve handling of invalid interaction situations

* support allowing webhook edits with files, and responding to interactions with files (#931)

* allow files in webhook message edits

* add Files to WebhookEdit struct

* move the construction of the multipart body for files into a shared function

* allow  interaction responses to have files

* go fmt

* fix err shadowing

* document MakeFilesBody

* rename MakeFilesBody -> EncodeWithFiles. fix InteractionRespond responding twice

* use resp in InteractionRespond files, add basic-command-with-files example command

* import strings and go fmt

* EncodeWithFiles -> MultiPartBodyWithJSON

* go fmt

* fix example for slash_commands

* move files to responsedata

* Merge fixes

* Fixed rebase consequences

Co-authored-by: Carson Hoffman <c@rsonhoffman.com>
Co-authored-by: plally <pierce@vulpes.dev>
2021-08-08 20:16:07 -04:00
docs Misc changes to docs (#907) 2021-05-14 22:19:57 -04:00
examples Selects component (#954) 2021-08-08 20:16:07 -04:00
tools/cmd/eventhandlers Remove type checks for handlers, it's done implicitly in the handlerForInterface call. (#305) 2016-12-29 09:58:51 -08:00
.gitignore Slash commands (#856) 2021-02-28 21:54:02 -05:00
.travis.yml Update unmarshal function to wrap ErrJSONUnmarshal and return specific error message. Requires at least Go 1.13. (#924) 2021-05-14 22:30:27 -04:00
components.go Selects component (#954) 2021-08-08 20:16:07 -04:00
discord.go Bump library version to v0.23.0 2021-01-23 19:53:47 -05:00
discord_test.go Add changes to presences, remove Game type 2021-01-20 18:54:38 -05:00
endpoints.go Fix EndpointInvite (#892) 2021-04-09 15:04:37 -04:00
event.go gofmt pass 2020-10-28 21:25:22 -04:00
eventhandlers.go Slash commands (#856) 2021-02-28 21:54:02 -05:00
events.go Interactions: the Buttons (#933) 2021-06-27 12:16:52 -04:00
go.mod Update unmarshal function to wrap ErrJSONUnmarshal and return specific error message. Requires at least Go 1.13. (#924) 2021-05-14 22:30:27 -04:00
go.sum Update unmarshal function to wrap ErrJSONUnmarshal and return specific error message. Requires at least Go 1.13. (#924) 2021-05-14 22:30:27 -04:00
interactions.go Selects component (#954) 2021-08-08 20:16:07 -04:00
interactions_test.go implement interaction request signing verification 2021-01-13 17:43:43 +00:00
LICENSE Rename GoDiscord to Discordgo in LICENSE (develop) 2016-05-17 09:45:25 -04:00
logging.go Changed "consistancy" to "consistency" in logging.go 2020-06-08 14:01:37 +02:00
message.go Interactions: the Buttons (#933) 2021-06-27 12:16:52 -04:00
message_test.go update Activity struct and add emoji functions (#895) 2021-04-10 16:17:16 -04:00
mkdocs.yml Some website contented added :) 2016-04-26 14:48:06 -05:00
oauth2.go Convert more constants to absolute values 2021-05-29 17:55:43 -04:00
oauth2_test.go fixed small typo in oauth2_test.go 2018-04-21 21:55:51 -04:00
ratelimit.go Slash commands (#856) 2021-02-28 21:54:02 -05:00
ratelimit_test.go Correct header in rate limit test 2021-01-20 19:48:09 -05:00
README.md README updates (#935) 2021-05-20 00:13:20 -04:00
restapi.go Selects component (#954) 2021-08-08 20:16:07 -04:00
restapi_test.go Update unmarshal function to wrap ErrJSONUnmarshal and return specific error message. Requires at least Go 1.13. (#924) 2021-05-14 22:30:27 -04:00
state.go Interactions: the Buttons (#933) 2021-06-27 12:16:52 -04:00
structs.go Convert more constants to absolute values 2021-05-29 17:55:43 -04:00
types.go Fixed compilation issues 2017-07-23 08:46:05 +02:00
types_test.go Timestamp type; a string with a Parse() function 2016-07-28 21:16:10 +02:00
user.go fix UserFlags constant types (#937) 2021-05-25 22:09:34 -04:00
user_test.go add String() method to User (#350) 2017-04-07 08:19:48 -07:00
util.go support allowing webhook edits with files, and responding to interactions with files (#931) 2021-07-30 11:22:08 -04:00
util_test.go Adding millisecond precision to SnowflakeTimestamp utility (#732) 2020-06-16 23:43:34 -04:00
voice.go Fix RTP extended header parsing 2021-02-22 13:20:15 +01:00
webhook.go Selects component (#954) 2021-08-08 20:16:07 -04:00
wsapi.go Fix all the typos that goreportcard detected. 2021-05-06 01:06:45 +02:00

DiscordGo

Go Reference Go Report Card 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

Installing

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

go get will always pull the latest tagged release from the master branch.

go get github.com/bwmarrin/discordgo

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.

  • Go Reference
  • 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.
  • 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 master 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.