Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/disgoorg/disgo

A modular Golang Discord API Wrapper
https://github.com/disgoorg/disgo

discord discord-api discord-bot discord-rpc discord-voice go golang hacktoberfest oauth2 rpc voice webhook

Last synced: about 21 hours ago
JSON representation

A modular Golang Discord API Wrapper

Host: GitHub
URL: https://github.com/disgoorg/disgo
Owner: disgoorg
License: apache-2.0
Created: 2021-03-04T19:07:52.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2024-12-11T19:42:46.000Z (1 day ago)
Last Synced: 2024-12-11T20:37:14.785Z (1 day ago)
Topics: discord, discord-api, discord-bot, discord-rpc, discord-voice, go, golang, hacktoberfest, oauth2, rpc, voice, webhook
Language: Go
Homepage:
Size: 3.68 MB
Stars: 340
Watchers: 4
Forks: 36
Open Issues: 15
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

discord-api-libs - disgo - A modular Golang Discord API Wrapper (Libraries / Go)
awesome-discord-bot-tools - disgo - A modular Golang Discord API Wrapper (Libraries / Go)
awesome-discord-bot-tools - disgo - A modular Golang Discord API Wrapper (Libraries / Go)

README

        [![Go Reference](https://pkg.go.dev/badge/github.com/disgoorg/disgo.svg)](https://pkg.go.dev/github.com/disgoorg/disgo)

[![Go Report](https://goreportcard.com/badge/github.com/disgoorg/disgo)](https://goreportcard.com/report/github.com/disgoorg/disgo)

[![Go Version](https://img.shields.io/github/go-mod/go-version/disgoorg/disgo)](https://golang.org/doc/devel/release.html)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/disgoorg/disgo/blob/master/LICENSE)

[![DisGo Version](https://img.shields.io/github/v/tag/disgoorg/disgo?label=release)](https://github.com/disgoorg/disgo/releases/latest)

[![DisGo Discord](https://discord.com/api/guilds/817327181659111454/widget.png)](https://discord.gg/TewhTfDpvW)



# DisGo

DisGo is a [Discord](https://discord.com) API wrapper written in [Golang](https://golang.org/) aimed to be consistent, modular, customizable and higher level than other Discord API wrappers.

## Summary

1. [Stability](#stability)

2. [Features](#features)

3. [Missing Features](#missing-features)

4. [Getting Started](#getting-started)

5. [Documentation](#documentation)

6. [Examples](#examples)

7. [Other interesting Projects to look at](#other-interesting-projects-to-look-at)

8. [Other Golang Discord Libraries](#other-golang-discord-libraries)

9. [Troubleshooting](#troubleshooting)

10. [Contributing](#contributing)

11. [License](#license)

### Stability

The public API of DisGo is mostly stable at this point in time. Smaller breaking changes can happen before the v1 is released. 

After v1 is released breaking changes may only happen if the Discord API requires them. They tend to break their released API versions now and then. In general for every new Discord API version the major version of DisGo should be increased and with that breaking changes between non-major versions should be held to a minimum. 

### Features

* Full Rest API coverage

* [Gateway](https://discord.com/developers/docs/topics/gateway)

* [Sharding](https://discord.com/developers/docs/topics/gateway#sharding)

* [HTTP Interactions](https://discord.com/developers/docs/interactions/slash-commands#receiving-an-interaction)

* [Application Commands](https://discord.com/developers/docs/interactions/application-commands)

* [Message Components](https://discord.com/developers/docs/interactions/message-components)

* [Modals](https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-modal)

* [Stage Instance](https://discord.com/developers/docs/resources/stage-instance)

* [Guild Template](https://discord.com/developers/docs/resources/guild-template)

* [Sticker](https://discord.com/developers/docs/resources/sticker)

* [RateLimit](https://discord.com/developers/docs/topics/rate-limits)

* [Webhook](https://discord.com/developers/docs/resources/webhook)

* [OAuth2](https://discord.com/developers/docs/topics/oauth2)

* [Threads](https://discord.com/developers/docs/topics/threads)

* [Guild Scheduled Event](https://discord.com/developers/docs/resources/guild-scheduled-event)

* [Voice](https://discord.com/developers/docs/topics/voice-connections)

### Missing Features

* [RPC](https://discord.com/developers/docs/topics/rpc) (https://github.com/disgoorg/disgo/pull/170)

## Getting Started

### Installing

```sh

$ go get github.com/disgoorg/disgo

```

### Building a DisGo Instance

Build a bot client to interact with the Discord API

```go

package main

import (

	"context"

	"os"

	"os/signal"

	"syscall"

	"github.com/disgoorg/disgo"

	"github.com/disgoorg/disgo/bot"

	"github.com/disgoorg/disgo/events"

	"github.com/disgoorg/disgo/gateway"

)

func main() {

	client, err := disgo.New("token",

		// set gateway options

		bot.WithGatewayConfigOpts(

			// set enabled intents

			gateway.WithIntents(

				gateway.IntentGuilds,

				gateway.IntentGuildMessages,

				gateway.IntentDirectMessages,

			),

		),

		// add event listeners

		bot.WithEventListenerFunc(func(e *events.MessageCreate) {

			// event code here

		}),

	)

	if err != nil {

		panic(err)

	}

	// connect to the gateway

	if err = client.OpenGateway(context.TODO()); err != nil {

		panic(err)

	}

	s := make(chan os.Signal, 1)

	signal.Notify(s, syscall.SIGINT, syscall.SIGTERM)

	<-s

}

```

### Full Ping Pong Example

A full Ping Pong example can also be found [here](https://github.com/disgoorg/disgo/blob/master/_examples/ping_pong/example.go)

### Logging

DisGo uses [slog](https://pkg.go.dev/log/slog) for logging.

## Documentation

Documentation is wip and can be found under

* [![Go Reference](https://pkg.go.dev/badge/github.com/disgoorg/disgo.svg)](https://pkg.go.dev/github.com/disgoorg/disgo)

* [![Discord Documentation](https://img.shields.io/badge/Discord%20Documentation-blue.svg)](https://discord.com/developers/docs)

GitHub Wiki is currently under construction. We appreciate help here.

## Examples

You can find examples [here](https://github.com/disgoorg/disgo/tree/master/_examples)

There is also a bot template with commands & db [here](https://github.com/disgoorg/bot-template)

or in these projects:

* [DisGo-Butler](https://github.com/disgoorg/disgo-butler)

* [Reddit-Discord-Bot](https://github.com/TopiSenpai/Reddit-Discord-Bot)

* [Kitsune-Bot](https://github.com/TopiSenpai/Kitsune-Bot)

* [KittyBot](https://github.com/KittyBot-Org/KittyBotGo)

## Libraries for DisGo

* [disgomd](https://github.com/eminarican/disgomd) is a command utility library that uses struct based approach

## Other interesting Projects to look at

### [Lavalink](https://github.com/freyacodes/Lavalink)

Is a standalone audio sending node based on [Lavaplayer](https://github.com/sedmelluq/lavaplayer) and JDA-Audio. Which allows for sending audio without it ever reaching any of your shards. Lavalink can be used in combination with [DisGolink](https://github.com/disgoorg/disgolink) for music Bots

Being used in production by FredBoat, Dyno, LewdBot, and more.

### [DisGolink](https://github.com/disgoorg/disgolink)

Is a [Lavalink-Client](https://github.com/freyacodes/Lavalink) which can be used to communicate with Lavalink to play/search tracks

## Other Golang Discord Libraries

* [discordgo](https://github.com/bwmarrin/discordgo)

* [disgord](https://github.com/andersfylling/disgord)

* [arikawa](https://github.com/diamondburned/arikawa)

* [corde](https://github.com/Karitham/corde)

## Troubleshooting

For help feel free to open an issue or reach out on [Discord](https://discord.gg/TewhTfDpvW)

## Contributing

Contributions are welcomed but for bigger changes we recommend first reaching out via [Discord](https://discord.gg/TewhTfDpvW) or create an issue to discuss your problems, intentions and ideas.

## License

Distributed under the [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/disgoorg/disgo/blob/master/LICENSE). See LICENSE for more information.

## Supported by Jetbrains