(Golang) Go bindings for Discord
Find a file
42Atomys 9448b0eb96
Add Guild Scheduled Event Support (#1032)
* Add Guild Scheduled Events support

* Add missing Indents for Guild Scheduled Events

* fix: Do update from new schedules updates and repository updates

* doc: Add missing documentation on const

* doc: Add missing documentation on events struct

* tests: Add a Skip condition when dgBot is not set to prevent segfault

* fix: Somes changes following the last review steps

* docs: Add an example to manipulate GuildScheduledEvent

* clean: Remove useless pointers on struct used to retrieve data

* tests: Test extra query params on GuildScheduledEventUsers requests

* clean: Remove unused variables

* feat: Add nullable types to provide null value to Discord API when is necessary

* feat: Use NullableString in ScheduledEvents

* docs: Add example for usage of NullableString

* Update structs.go

Co-authored-by: Fedor Lapshin <fe.lap.prog@gmail.com>

* Update restapi.go

Co-authored-by: Fedor Lapshin <fe.lap.prog@gmail.com>

* fix: Review changes to move back nullable string into a simple MarshalJSON

* fix: Remove NullString on tests and examples

* doc: Add missing doc

* Update structs.go

Co-authored-by: Fedor Lapshin <fe.lap.prog@gmail.com>

* fix: misunderstood MarhsalJSON

* fix: Follow the convention of discordgo on url.Values

* Update examples/scheduled_events/main.go

Co-authored-by: Fedor Lapshin <fe.lap.prog@gmail.com>

* changes: use conditional instead on Sprintf

* fix: Add missing status on Params

* Update structs.go

Co-authored-by: Fedor Lapshin <fe.lap.prog@gmail.com>

* Update structs.go

Co-authored-by: Fedor Lapshin <fe.lap.prog@gmail.com>

* changes: Move flag.Parse inside the init function

* fix: remove null statement of test suite

* fix: Rewrite Marshal of GuildScheduledEventParams to prevent a stack overflow on marshall same type

* clean: Remove unused Intents

* Update restapi.go

Co-authored-by: Fedor Lapshin <fe.lap.prog@gmail.com>

* Update restapi.go

Co-authored-by: Fedor Lapshin <fe.lap.prog@gmail.com>

* Update restapi.go

Co-authored-by: Fedor Lapshin <fe.lap.prog@gmail.com>

* doc: polish the documentation

* clean: Final polish code

* doc: Add information about 1:1 usage

* Update discord_test.go

Co-authored-by: Fedor Lapshin <fe.lap.prog@gmail.com>

* doc: remove unnecessary additional infos

* Update structs.go

Co-authored-by: Fedor Lapshin <fe.lap.prog@gmail.com>

* Update discord_test.go

Co-authored-by: Fedor Lapshin <fe.lap.prog@gmail.com>

* Update restapi.go

Co-authored-by: Fedor Lapshin <fe.lap.prog@gmail.com>

* chore(examples/scheduled_events): removed NullString comment

* fix(structs): grammar in comment to EntityType

* fix: run gofmt

Co-authored-by: Fedor Lapshin <fe.lap.prog@gmail.com>
2022-02-27 18:22:31 +03:00
.github feat(github/release): added fallback category back 2022-02-27 13:06:34 +03:00
docs Vectorization of DiscordGo mark (#1099) 2022-02-16 23:23:27 +03:00
examples Add Guild Scheduled Event Support (#1032) 2022-02-27 18:22:31 +03: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
.golangci.yml CI (#1076) 2022-02-16 16:24:17 +03: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 feat: min and max constraints for slash command options (#1026) 2022-02-26 21:02:33 +03:00
discord.go Revert "feat(structs#Session): made sessionID and sequence fields public" 2022-02-27 18:11:50 +03:00
discord_test.go Add Guild Scheduled Event Support (#1032) 2022-02-27 18:22:31 +03:00
endpoints.go Add Guild Scheduled Event Support (#1032) 2022-02-27 18:22:31 +03:00
event.go Revert "feat(structs#Session): made sessionID and sequence fields public" 2022-02-27 18:11:50 +03:00
eventhandlers.go Add Guild Scheduled Event Support (#1032) 2022-02-27 18:22:31 +03:00
events.go Add Guild Scheduled Event Support (#1032) 2022-02-27 18:22:31 +03: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 feat: min and max constraints for slash command options (#1026) 2022-02-26 21:02:33 +03: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
locales.go add interaction locales (#1073) 2022-02-02 14:45:15 -05:00
logging.go Changed "consistancy" to "consistency" in logging.go 2020-06-08 14:01:37 +02:00
message.go add interaction field to message struct (#1112) 2022-02-26 23:16:57 +03: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 Add Invite Create/Delete (#1105) 2022-02-26 00:13:27 +03: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 Vectorization of DiscordGo mark (#1099) 2022-02-16 23:23:27 +03:00
restapi.go Add Guild Scheduled Event Support (#1032) 2022-02-27 18:22:31 +03:00
restapi_test.go feat(*)!: dropped undocumented endpoints 2022-02-08 18:25:24 +03:00
state.go Threads reloaded (#1058) 2022-02-17 22:50:42 +03:00
structs.go Add Guild Scheduled Event Support (#1032) 2022-02-27 18:22:31 +03:00
types.go Remove Timestamp type, use time.Time 2021-12-24 12:38:50 -05:00
user.go Add Guild Member avatar (#1077) 2022-02-26 00:26:51 +03:00
user_test.go add String() method to User (#350) 2017-04-07 08:19:48 -07:00
util.go Add Guild Member avatar (#1077) 2022-02-26 00:26:51 +03: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 Revert "feat(structs#Session): made sessionID and sequence fields public" 2022-02-27 18:11:50 +03:00

DiscordGo

Go Reference Go Report Card Build Status Discord Gophers Discord API

DiscordGo logo

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.