config

Documentation

Overview

Functions to interact with global and guild-specific configuration values.

Index

• Variables
• func AdvanceTotalMessages() error
• func ExpEnabled(gid string) (enabled bool, err error)
• func GetCustomizableMessage(gid string, key string) (string, error)
• func GetGuildConfValue(id, key string) (string, error)
• func GetLastfm(user *discordgo.User, guild *discordgo.Guild) (string, error)
• func GetMemberExp(user *discordgo.User, guild *discordgo.Guild) (int, error)
• func GetPrefix(gid string) string
• func GetTotalMessages() int
• func HighlightBindMessage(gid, message, highlight string) error
• func HighlightGetBinding(gid, message string) (string, error)
• func HighlightUnbindMessage(gid, message string) error
• func ResetGuild(gid string)
• func ResetGuildConfValue(id, key string) error
• func ResetGuildMap(gid, key string)
• func ResetLastfm(user *discordgo.User, guild *discordgo.Guild) error
• func SetCustomizableMessage(gid string, key string, message string) error
• func SetGuildConfValue(id, key, value string) error
• func SetLastfm(user *discordgo.User, guild *discordgo.Guild, username string) error
• func SetMemberExp(user *discordgo.User, guild *discordgo.Guild, exp int) error
• type Conf
• type MessageOutOfBounds
  • func (err MessageOutOfBounds) Error() string

Variables

var (
	Config         = parseConfig()
	NitoriConfPath string
	TokenOverride  string
	VersionStartup bool
	LogLevel       = getLogLevel()
)

Exported variables for usage in other classes

var CustomizableMessages = map[string]string{
	"levelup": "Congratulations $USER on reaching level $LEVEL.",
}

Functions

func AdvanceTotalMessages

func AdvanceTotalMessages() error

AdvanceTotalMessages advances the total messages processed counter.

func ExpEnabled

func ExpEnabled(gid string) (enabled bool, err error)

ExpEnabled queries whether the experience system is enabled for a guild.

func GetCustomizableMessage

func GetCustomizableMessage(gid string, key string) (string, error)

GetCustomizableMessage gets a guild-specific message within predefined messages, returning default if not present.

func GetGuildConfValue

func GetGuildConfValue(id, key string) (string, error)

GetGuildConfValue gets a configuration value for a specific guild

func GetLastfm

func GetLastfm(user *discordgo.User, guild *discordgo.Guild) (string, error)

GetLastfm gets a user's lastfm username.

func GetMemberExp

func GetMemberExp(user *discordgo.User, guild *discordgo.Guild) (int, error)

GetMemberExp obtains experience amount of a guild member.

func GetPrefix

func GetPrefix(gid string) string

GetPrefix gets the command prefix of a guild and returns the default if none is set.

func GetTotalMessages

func GetTotalMessages() int

GetTotalMessages gets the total amount of messages processed.

func HighlightBindMessage

func HighlightBindMessage(gid, message, highlight string) error

HighlightBindMessage binds a message with the highlight message.

func HighlightGetBinding

func HighlightGetBinding(gid, message string) (string, error)

HighlightGetBinding gets the binding of a message.

func HighlightUnbindMessage

func HighlightUnbindMessage(gid, message string) error

HighlightUnbindMessage unbinds a message with the highlight message.

func ResetGuild

func ResetGuild(gid string)

ResetGuild deletes all db values that belongs to a specific guild.

func ResetGuildConfValue

func ResetGuildConfValue(id, key string) error

ResetGuildConfValue resets a configuration value for a specific guild

func ResetGuildMap

func ResetGuildMap(gid, key string)

ResetGuildMap deletes a map that belongs to a specific guild.

func ResetLastfm

func ResetLastfm(user *discordgo.User, guild *discordgo.Guild) error

ResetLastfm resets a user's lastfm username.

func SetCustomizableMessage

func SetCustomizableMessage(gid string, key string, message string) error

SetCustomizableMessage sets a guild-specific message string within predefined messages.

func SetGuildConfValue

func SetGuildConfValue(id, key, value string) error

SetGuildConfValue sets a configuration value for a specific guild

func SetLastfm

func SetLastfm(user *discordgo.User, guild *discordgo.Guild, username string) error

SetLastfm sets a user's lastfm username.

func SetMemberExp

func SetMemberExp(user *discordgo.User, guild *discordgo.Guild, exp int) error

SetMemberExp sets a member's experience amount.

Types

type Conf

type Conf struct {
	System struct {
		LogLevel      string
		LogPath       string
		Socket        string
		Database      string
		Prefix        string
		Administrator int
		Operator      []int
	}
	WebServer struct {
		Host                string
		Port                int
		BaseURL             string
		Unix                bool
		ForwardedByClientIP bool
		Secret              string
		RateLimit           int
		RateLimitPeriod     int
	}
	Discord struct {
		Token        string
		ClientSecret string
		Presence     string
		Shard        bool
		ShardCount   int
	}
	LastFM struct {
		ApiKey    string
		ApiSecret string
	}
}

type MessageOutOfBounds

type MessageOutOfBounds struct{}

Configuration related types

func (MessageOutOfBounds) Error

func (err MessageOutOfBounds) Error() string