embed

README

discordgo-embed

An embed helper library for DiscordGo.

Installing

go get github.com/clinet/discordgo-embed

Example

package main

import (
    "github.com/bwmarrin/discordgo"
    "github.com/Clinet/discordgo-embed"
)

// ...

discordSession.ChannelSendEmbed(channelID, embed.NewGenericEmbed("Example", "This is an example embed!"))
discordSession.ChannelSendEmbed(channelID, embed.NewErrorEmbed("Example Error", "This is an example error embed!"))

License

The source code for discordgo-embed is released under the MIT License. See LICENSE for more details.

Donations

All donations are appreciated and help me stay awake at night to work on this more. Even if it's not much, it helps a lot in the long run!

Documentation

Index

• Constants
• func NewErrorEmbed(errorTitle, errorMsg string, replacements ...interface{}) *discordgo.MessageEmbed
• func NewErrorEmbedAdvanced(errorTitle, errorMsg string, errorColor int) *discordgo.MessageEmbed
• func NewGenericEmbed(embedTitle, embedMsg string, replacements ...interface{}) *discordgo.MessageEmbed
• func NewGenericEmbedAdvanced(embedTitle, embedMsg string, embedColor int) *discordgo.MessageEmbed
• type Embed
  • func NewEmbed() *Embed
  • func (e *Embed) AddField(name, value string) *Embed
  • func (e *Embed) InlineAllFields() *Embed
  • func (e *Embed) MakeFieldInline() *Embed
  • func (e *Embed) SetAuthor(args ...string) *Embed
  • func (e *Embed) SetColor(clr int) *Embed
  • func (e *Embed) SetDescription(description string) *Embed
  • func (e *Embed) SetFooter(args ...string) *Embed
  • func (e *Embed) SetImage(args ...string) *Embed
  • func (e *Embed) SetThumbnail(args ...string) *Embed
  • func (e *Embed) SetTitle(name string) *Embed
  • func (e *Embed) SetURL(URL string) *Embed
  • func (e *Embed) Truncate() *Embed
  • func (e *Embed) TruncateDescription() *Embed
  • func (e *Embed) TruncateFields() *Embed
  • func (e *Embed) TruncateFooter() *Embed
  • func (e *Embed) TruncateTitle() *Embed

Constants

const (
	EmbedLimitTitle       = 256
	EmbedLimitDescription = 2048
	EmbedLimitFieldValue  = 1024
	EmbedLimitFieldName   = 256
	EmbedLimitField       = 25
	EmbedLimitFooter      = 2048
	EmbedLimit            = 4000
)

Constants for message embed character limits

Functions

func NewErrorEmbed

func NewErrorEmbed(errorTitle, errorMsg string, replacements ...interface{}) *discordgo.MessageEmbed

NewErrorEmbed creates a new error embed

func NewErrorEmbedAdvanced

func NewErrorEmbedAdvanced(errorTitle, errorMsg string, errorColor int) *discordgo.MessageEmbed

NewErrorEmbedAdvanced creates a new error embed with a custom color

func NewGenericEmbed

func NewGenericEmbed(embedTitle, embedMsg string, replacements ...interface{}) *discordgo.MessageEmbed

NewGenericEmbed creates a new generic embed

func NewGenericEmbedAdvanced

func NewGenericEmbedAdvanced(embedTitle, embedMsg string, embedColor int) *discordgo.MessageEmbed

NewGenericEmbedAdvanced creates a new generic embed with a custom color

Types

type Embed

type Embed struct {
	*discordgo.MessageEmbed
}

Embed ...

func NewEmbed

func NewEmbed() *Embed

NewEmbed returns a new embed object

func (*Embed) AddField

func (e *Embed) AddField(name, value string) *Embed

AddField [name] [value]

func (*Embed) InlineAllFields

func (e *Embed) InlineAllFields() *Embed

InlineAllFields sets all fields in the embed to be inline

func (*Embed) MakeFieldInline

func (e *Embed) MakeFieldInline() *Embed

Adds last field as InLine

func (*Embed) SetAuthor

func (e *Embed) SetAuthor(args ...string) *Embed

SetAuthor ...

func (*Embed) SetColor

func (e *Embed) SetColor(clr int) *Embed

SetColor ...

func (*Embed) SetDescription

func (e *Embed) SetDescription(description string) *Embed

SetDescription [desc]

func (*Embed) SetFooter

func (e *Embed) SetFooter(args ...string) *Embed

SetFooter [Text] [iconURL]

func (*Embed) SetImage

func (e *Embed) SetImage(args ...string) *Embed

SetImage ...

func (*Embed) SetThumbnail

func (e *Embed) SetThumbnail(args ...string) *Embed

SetThumbnail ...

func (*Embed) SetTitle

func (e *Embed) SetTitle(name string) *Embed

SetTitle ...

func (*Embed) SetURL

func (e *Embed) SetURL(URL string) *Embed

SetURL ...

func (*Embed) Truncate

func (e *Embed) Truncate() *Embed

Truncate truncates any embed value over the character limit.

func (*Embed) TruncateDescription

func (e *Embed) TruncateDescription() *Embed

TruncateDescription ...

func (*Embed) TruncateFields

func (e *Embed) TruncateFields() *Embed

TruncateFields truncates fields that are too long

func (*Embed) TruncateFooter

func (e *Embed) TruncateFooter() *Embed

TruncateFooter ...

func (*Embed) TruncateTitle

func (e *Embed) TruncateTitle() *Embed

TruncateTitle ...