Categorygithub.com/rivalo/discordgo_cli
modulepackage
0.10.0
Repository: https://github.com/rivalo/discordgo_cli.git
Documentation: pkg.go.dev

# README

Discordgo ==== [![GoDoc](https://godoc.org/github.com/bwmarrin/discordgo?status.svg)](https://godoc.org/github.com/bwmarrin/discordgo) [![Go report](http://goreportcard.com/badge/bwmarrin/discordgo)](http://goreportcard.com/report/bwmarrin/discordgo) [![Build Status](https://travis-ci.org/bwmarrin/discordgo.svg?branch=master)](https://travis-ci.org/bwmarrin/discordgo)

Discordgo is a Go package that provides low level bindings to the Discord chat client API.

  • See dgVoice for experimental voice support.

Join #go_discordgo Discord chat channel for support.

Getting Started

Installing

Discordgo has been tested to compile on Debian 8 (Go 1.3.3), FreeBSD 10 (Go 1.5.1), and Windows 7 (Go 1.5.2).

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

$ 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("username", "password")

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 functions, constants, and structures.

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

  • Basic - New A basic example using the easy New() helper function
  • Basic - API A basic example using the low level API functions.
  • Bruxism A chat bot for YouTube and Discord
  • GoGerard A modern bot for Discord
  • Digo A pluggable bot for your Discord server

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.
  • Fork the develop branch and make your changes.
  • 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 develop branch.

List of Discord APIs

See this chart for a feature comparison and list of other Discord API libraries.

# Packages

No description provided by the author

# Functions

New creates a new Discord session and will automate some startup tasks if given enough information to do so.
NewState creates an empty state.

# Constants

Discordgo Version, follows Symantic Versioning.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TODO consider removing.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

An Attachment stores data for message attachments.
A Channel holds all data related to an individual Discord channel.
An Embed stores data for message embeds.
No description provided by the author
An Event provides a basic initial struct for all websocket event.
No description provided by the author
A Guild holds all data related to a specific Discord Guild.
A GuildBan stores data for a guild ban.
A GuildEmojisUpdate stores data for a guild emoji update event.
A GuildIntegrationsUpdate stores data for the guild integrations update websocket event.
A GuildRole stores data for guild role websocket events.
A GuildRoleDelete stores data for the guild role delete websocket event.
A ICEServer stores data for a specific voice ICE server.
A Invite stores all data related to a specific Discord Guild or Channel invite.
A Member stores user information for Guild members.
A Message stores all data related to a specific Discord message.
A MessageAck stores data for the message ack websocket event.
A PermissionOverwrite holds permission overwrite data for a Channel.
A Presence stores the online, offline, or idle and game status of Guild members.
A PresenceUpdate stores data for the pressence update websocket event.
No description provided by the author
A ReadState stores data on the read state of channels.
A Ready stores all data for the websocket READY event.
A Role stores information about Discord guild member roles.
A Session represents a connection to the Discord REST API.
A Settings stores data for a specific users Discord client settings.
A State contains the current known state.
A TypingStart stores data for the typing start websocket event.
A User stores all data for an individual Discord user.
A Voice struct holds all data and functions related to Discord Voice support.
A VoiceICE stores data for voice ICE servers.
A VoiceRegion stores data for a specific voice region server.
A VoiceServerUpdate stores the data received during the Voice Server Update data websocket event.
A VoiceState stores the voice states of Guilds.