disgo

README

disgo

disgo is a Discord API wrapper written in Go aimed to be consistent, modular, customizable and easy to use

Summary

1. Features
2. Missing Features
3. Getting Started
4. Documentation
5. Examples
6. Related Projects
7. Why another library?
8. Troubleshooting
9. Contributing
10. License

Features

• Full Rest API coverage
• Gateway
• Sharding
• HTTP Interactions
• Application Commands
• Message Components
• Stage Instance
• Guild Template
• Sticker
• RateLimit
• Webhook
• OAuth2
• Threads
• Guild Scheduled Event

Missing Features

• Voice
• RPC

Getting Started

Installing

go get github.com/DisgoOrg/disgo

Building a Disgo Instance

package main

import (
	"github.com/DisgoOrg/disgo/core/bot"
	"github.com/DisgoOrg/disgo/discord"
	"github.com/DisgoOrg/disgo/gateway"
)

func main() {
	disgo, err := bot.New("token",
		bot.WithGatewayOpts(
			gateway.WithGatewayIntents(
				discord.GatewayIntentGuilds,
				discord.GatewayIntentGuildMessages,
				discord.GatewayIntentDirectMessages,
			),
		),
	)
}

Full Ping Pong Example

package main

import (
	"os"
	"os/signal"
	"syscall"

	"github.com/DisgoOrg/disgo/core"
	"github.com/DisgoOrg/disgo/core/bot"
	"github.com/DisgoOrg/disgo/core/events"
	"github.com/DisgoOrg/disgo/discord"
	"github.com/DisgoOrg/disgo/gateway"
	"github.com/DisgoOrg/log"
)

func main() {
	disgo, err := bot.New(os.Getenv("token"),
		bot.WithGatewayOpts(
			gateway.WithGatewayIntents(
				discord.GatewayIntentGuilds,
				discord.GatewayIntentGuildMessages,
				discord.GatewayIntentDirectMessages,
			),
		),
		bot.WithCacheOpts(core.WithCacheFlags(core.CacheFlagsNone)),
		bot.WithEventListeners(&events.ListenerAdapter{
			OnMessageCreate: onMessageCreate,
		}),
	)
	if err != nil {
		log.Fatal("error while building disgo: ", err)
	}

	defer disgo.Close()

	if err = disgo.ConnectGateway(); err != nil {
		log.Fatal("errors while connecting to gateway: ", err)
	}

	log.Info("example is now running. Press CTRL-C to exit.")
	s := make(chan os.Signal, 1)
	signal.Notify(s, syscall.SIGINT, syscall.SIGTERM, os.Interrupt, os.Kill)
	<-s
}

func onMessageCreate(event *events.MessageCreateEvent) {
	var message string
	if event.Message.Content == "ping" {
		message = "pong"
	} else if event.Message.Content == "pong" {
		message = "ping"
	}
	if message != "" {
		_, _ = event.Message.Reply(discord.NewMessageCreateBuilder().SetContent(message).Build())
	}
}

Logging

disgo uses our own small logging lib which provides an interface you can implement. This lib also comes with a default logger which is interchangeable and based on the standard log package. You can read more about it here

Documentation

Documentation is wip and can be found under

• 
• 

Wiki is currently under construction

Examples

You can find examples under _examples

or in these projects:

• disgo-butler
• BansBot
• Reddit-Discord-Bot
• Kitsune-Bot
• Uno-Bot

Related Projects

Lavalink

Standalone audio sending node based on Lavaplayer and JDA-Audio. Allows for sending audio without it ever reaching any of your shards.

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

disgolink

Lavalink Client which can be used to communicate with LavaLink to play/search tracks

dislog

Discord webhook logger integration for logrus

Why another library?

discordgo is a great library, but it's super low level and pain disgord I don't like code gen magic arikawa v3 rewrite looks promising but when I started with disgo v2 looked kinda bad

disgo aims to be a high level library that is modular and not a pain to use.

Troubleshooting

For help feel free to open an issues or reach out on Discord

Contributing

Contributions are welcomed but for bigger changes please first reach out via Discord or create an issue to discuss your intentions and ideas.

License

Distributed under the . See LICENSE for more information.