* 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> |
||
---|---|---|
.github | ||
docs | ||
examples | ||
tools/cmd/eventhandlers | ||
.gitignore | ||
.golangci.yml | ||
.travis.yml | ||
components.go | ||
discord.go | ||
discord_test.go | ||
endpoints.go | ||
event.go | ||
eventhandlers.go | ||
events.go | ||
go.mod | ||
go.sum | ||
interactions.go | ||
interactions_test.go | ||
LICENSE | ||
locales.go | ||
logging.go | ||
message.go | ||
message_test.go | ||
mkdocs.yml | ||
oauth2.go | ||
oauth2_test.go | ||
ratelimit.go | ||
ratelimit_test.go | ||
README.md | ||
restapi.go | ||
restapi_test.go | ||
state.go | ||
structs.go | ||
types.go | ||
user.go | ||
user_test.go | ||
util.go | ||
util_test.go | ||
voice.go | ||
webhook.go | ||
wsapi.go |
DiscordGo
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.
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.
- DiscordGo Examples - A collection of example programs written with DiscordGo
- Awesome DiscordGo - A curated list of high quality projects using DiscordGo
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.