config

Documentation

Overview

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

Index

• Variables
• func AdvanceTotalMessages() error
• func GetCustomizableMessage(gid string, key string) (string, error)
• func GetGuildConfValue(id, key string) (string, error)
• func GetPrefix(gid string) string
• func GetTotalMessages() int
• func ResetGuild(gid string)
• func ResetGuildConfValue(id, key string) error
• func ResetGuildMap(gid, key string)
• func SetCustomizableMessage(gid string, key string, message string) error
• func SetGuildConfValue(id, key, value string) 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{}

var Prefixes = []string{"conf"}

Functions

func AdvanceTotalMessages

func AdvanceTotalMessages() error

AdvanceTotalMessages advances the total messages processed counter.

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 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 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 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

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