config

package
v0.0.0-...-26b89f5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 2, 2024 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config 

type Config struct {
	IsDebugEnabled   bool     `toml:"is_debug_enabled" desc:"Default true, enables verbose logging"`
	MaxLevel         int32    `` /* 155-byte string literal not displayed */
	CurrentExpansion int      `` /* 140-byte string literal not displayed */
	Site             Site     `toml:"server" desc:"Web Site configuration"`
	Database         Database `toml:"database" desc:"Database configuration"`
	Item             Item     `toml:"item" desc:"Item configuration"`
	Spell            Spell    `toml:"spell" desc:"Spell configuration"`
	Npc              Npc      `toml:"npc" desc:"NPC configuration"`
	Quest            Quest    `toml:"quest" desc:"Quest parser configuration"`
	Recipe           Recipe   `toml:"recipe" desc:"Recipe parser configuration"`
	Player           Player   `toml:"player" desc:"Player parser configuration"`
	Zone             Zone     `toml:"zone" desc:"Zone parser configuration"`
	MemCache         MemCache `toml:"mem_cache" desc:"Memory cache configuration"`
}

Config represents a configuration parse

func Get 

func Get() *Config

func NewConfig 

func NewConfig(ctx context.Context) (*Config, error)

NewConfig creates a new configuration

func NewTestConfig 

func NewTestConfig(ctx context.Context) (*Config, error)

func (*Config) Verify 

func (c *Config) Verify() error

Verify returns an error if configuration appears off

type Database 

type Database struct {
	Host     string `toml:"host" desc:"Default localhost, where to connect for database"`
	Port     int    `toml:"port" desc:"Default 3306, what port to connect to for database"`
	Username string `toml:"username" desc:"Default peq, Database username"`
	Name     string `toml:"name" desc:"Default peq, Database name"`
	Password string `toml:"password" desc:"Default peqpass, Database password"`
}

type Item 

type Item struct {
	IsEnabled           bool        `toml:"is_enabled" desc:"Default true, enables item endpoints"`
	IsCacheEnabled      bool        `toml:"is_cache_enabled" desc:"Default true, enables item caching"`
	IsDiscoveredOnly    bool        `toml:"is_discovered_only" desc:"Default false, only allow discovered items to be viewed"`
	DiscoverCacheReload int         `` /* 187-byte string literal not displayed */
	Search              ItemSearch  `toml:"search" desc:"Item search configuration"`
	Preview             ItemPreview `toml:"preview" desc:"Item preview configuration"`
}

type ItemPreview 

type ItemPreview struct {
	IsEnabled  bool   `toml:"is_enabled" desc:"Default true, enables item preview"`
	BGColor    string `toml:"bg_color" desc:"Default #313338, background color for item preview"`
	FGColor    string `toml:"fg_color" desc:"Default #DBDEE1, foreground text color for item preview"`
	FontNormal string `toml:"font" desc:"Default goregular.ttf, if changed place a .ttf file same path as binary"`
	FontBold   string `toml:"font_bold" desc:"Default gobold.ttf, if changed place a .ttf file same path as binary"`
}

type ItemSearch 

type ItemSearch struct {
	IsEnabled                bool `toml:"is_enabled" desc:"Default false, makes a search box appear in the item view for finding other items"`
	IsMemorySearchEnabled    bool `toml:"is_memory_search_enabled" desc:"Default false, enables memory search for items"`
	IsOnlyPlayableObtainable bool `toml:"is_only_player_obtainable" desc:"Default false, only items determined player obtainable come up in search"`
}

type LetsEncrypt 

type LetsEncrypt struct {
	IsEnabled bool     `` /* 173-byte string literal not displayed */
	Email     string   `toml:"email" desc:"Default example@email.com, what email to register for lets encrypt"`
	CertPath  string   `toml:"cert" desc:"Default certs/, where to store letsencrypt certs"`
	Domains   []string `toml:"domains" desc:"Default example.com,list of domains to register for letsencrypt, do not use wildcard domains"`
	IsProd    bool     `` /* 145-byte string literal not displayed */
}

type MemCache 

type MemCache struct {
	IsEnabled        bool  `toml:"is_enabled" desc:"If true, memory cache is enabled, default true"`
	MaxMemory        int   `` /* 175-byte string literal not displayed */
	TruncateSchedule int   `` /* 171-byte string literal not displayed */
	Duration         int64 `toml:"duration" desc:"How long to keep memory cache in seconds, default 300 seconds (5 minutes)"`
}

type Npc 

type Npc struct {
	IsEnabled      bool       `toml:"is_enabled" desc:"Default true, enables npc endpoints"`
	IsCacheEnabled bool       `toml:"is_cache_enabled" desc:"Default true, enables npc caching"`
	Search         NpcSearch  `toml:"search" desc:"Npc search configuration"`
	Preview        NpcPreview `toml:"preview" desc:"Npc preview configuration"`
}

type NpcPreview 

type NpcPreview struct {
	IsEnabled  bool   `toml:"is_enabled" desc:"Default true, enables npc preview"`
	BGColor    string `toml:"bg_color" desc:"Default #313338, background color for npc preview"`
	FGColor    string `toml:"fg_color" desc:"Default #DBDEE1, foreground text color for npc preview"`
	FontNormal string `toml:"font" desc:"Default goregular.ttf, if changed place a .ttf file same path as binary"`
	FontBold   string `toml:"font_bold" desc:"Default gobold.ttf, if changed place a .ttf file same path as binary"`
}

type NpcSearch 

type NpcSearch struct {
	IsEnabled             bool `toml:"is_enabled" desc:"Default false, makes a search box appear in the npc view for finding other npcs"`
	IsMemorySearchEnabled bool `toml:"is_memory_search_enabled" desc:"Default false, enables memory search for npcs"`
}

type Player 

type Player struct {
	IsEnabled      bool          `toml:"is_enabled" desc:"Default true, enables player endpoints"`
	IsCacheEnabled bool          `toml:"is_cache_enabled" desc:"Default true, enables player caching"`
	Search         PlayerSearch  `toml:"search" desc:"Player search configuration"`
	Preview        PlayerPreview `toml:"preview" desc:"Player preview configuration"`
}

type PlayerPreview 

type PlayerPreview struct {
	IsEnabled  bool   `toml:"is_enabled" desc:"Default true, enables player preview"`
	BGColor    string `toml:"bg_color" desc:"Default #313338, background color for player preview"`
	FGColor    string `toml:"fg_color" desc:"Default #DBDEE1, foreground text color for player preview"`
	FontNormal string `toml:"font" desc:"Default goregular.ttf, if changed place a .ttf file same path as binary"`
	FontBold   string `toml:"font_bold" desc:"Default gobold.ttf, if changed place a .ttf file same path as binary"`
}

type PlayerSearch 

type PlayerSearch struct {
	IsEnabled             bool `toml:"is_enabled" desc:"Default false, makes a search box appear in the player view for finding other players"`
	IsMemorySearchEnabled bool `toml:"is_memory_search_enabled" desc:"Default false, enables memory search for players"`
}

type Quest 

type Quest struct {
	IsEnabled                   bool         `toml:"is_enabled" desc:"Default true, enables quest features"`
	Path                        string       `toml:"path" desc:"Default quests/, where to find quest files"`
	ActiveConcurrency           int          `` /* 153-byte string literal not displayed */
	IsBackgroundScanningEnabled bool         `` /* 153-byte string literal not displayed */
	BackgroundScanConcurrency   int          `` /* 127-byte string literal not displayed */
	ScanSchedule                int          `` /* 144-byte string literal not displayed */
	Preview                     QuestPreview `toml:"preview" desc:"Quest preview configuration"`
	Search                      QuestSearch  `toml:"search" desc:"Quest search configuration"`
}

type QuestPreview 

type QuestPreview struct {
	IsEnabled  bool   `toml:"is_enabled" desc:"Default true, enables quest preview"`
	BGColor    string `toml:"bg_color" desc:"Default #313338, background color for quest preview"`
	FGColor    string `toml:"fg_color" desc:"Default #DBDEE1, foreground text color for quest preview"`
	FontNormal string `toml:"font" desc:"Default goregular.ttf, if changed place a .ttf file same path as binary"`
	FontBold   string `toml:"font_bold" desc:"Default gobold.ttf, if changed place a .ttf file same path as binary"`
}

type QuestSearch 

type QuestSearch struct {
	IsEnabled             bool `toml:"is_enabled" desc:"Default false, makes a search box appear in the quest view for finding other quests"`
	IsMemorySearchEnabled bool `toml:"is_memory_search_enabled" desc:"Default false, enables memory search for quests"`
}

type Recipe 

type Recipe struct {
	IsEnabled                   bool `toml:"is_enabled" desc:"Default true, enables recipe features"`
	ActiveConcurrency           int  `` /* 155-byte string literal not displayed */
	IsBackgroundScanningEnabled bool `` /* 154-byte string literal not displayed */
	BackgroundScanConcurrency   int  `` /* 128-byte string literal not displayed */
	ScanSchedule                int  `` /* 144-byte string literal not displayed */
}

type Site 

type Site struct {
	Host        string      `toml:"host" desc:"Default localhost, what IP to bind to, can also have it empty to bind all"`
	Port        int         `toml:"port" desc:"Default 8080, what port to bind to, if you're not using a proxy and use TLS set to 443"`
	LetsEncrypt LetsEncrypt `toml:"lets_encrypt" desc:"LetsEncrypt configuration"`
	BaseURL     string      `toml:"base_url" desc:"Default http://localhost:8080, base url for the site, e.g. https://foo.com"`
	GoogleTag   string      `toml:"google_tag" desc:"Default empty, google tag manager id"`
}

type Spell 

type Spell struct {
	IsEnabled          bool         `toml:"is_enabled" desc:"Default true, spell endpoints are enabled"`
	IsCacheEnabled     bool         `toml:"is_cache_enabled" desc:"Default true, spell caching is enabled"`
	IsSpellInfoEnabled bool         `toml:"is_spell_info_enabled" desc:"Default true, gives spell effect detailed info (based to mq spell details)"`
	Search             SpellSearch  `toml:"search" desc:"Spell search configuration"`
	Preview            SpellPreview `toml:"preview" desc:"Spell preview configuration"`
}

type SpellPreview 

type SpellPreview struct {
	IsEnabled  bool   `toml:"is_enabled" desc:"Default true, enables spell preview"`
	BGColor    string `toml:"bg_color" desc:"Default #313338, background color for spell preview"`
	FGColor    string `toml:"fg_color" desc:"Default #DBDEE1, foreground text color for spell preview"`
	FontNormal string `toml:"font" desc:"Default goregular.ttf, if changed place a .ttf file same path as binary"`
	FontBold   string `toml:"font_bold" desc:"Default gobold.ttf, if changed place a .ttf file same path as binary"`
}

type SpellSearch 

type SpellSearch struct {
	IsEnabled             bool `toml:"is_enabled" desc:"Default false, makes a search box appear in the spell view for finding other spells"`
	IsMemorySearchEnabled bool `toml:"is_memory_search_enabled" desc:"Default false, enables memory search for spells"`
	IsOnlyPlayerSpells    bool `toml:"is_only_player_spells" desc:"Default false, only spells determined player obtainable come up in search"`
}

type Zone 

type Zone struct {
	IsEnabled bool        `toml:"is_enabled" desc:"Default true, enables zone endpoints"`
	Search    ZoneSearch  `toml:"search" desc:"Zone search configuration"`
	Preview   ZonePreview `toml:"preview" desc:"Zone preview configuration"`
}

type ZonePreview 

type ZonePreview struct {
	IsEnabled  bool   `toml:"is_enabled" desc:"Default true, enables zone preview"`
	BGColor    string `toml:"bg_color" desc:"Default #313338, background color for zone preview"`
	FGColor    string `toml:"fg_color" desc:"Default #DBDEE1, foreground text color for zone preview"`
	FontNormal string `toml:"font" desc:"Default goregular.ttf, if changed place a .ttf file same path as binary"`
	FontBold   string `toml:"font_bold" desc:"Default gobold.ttf, if changed place a .ttf file same path as binary"`
}

type ZoneSearch 

type ZoneSearch struct {
	IsEnabled             bool `toml:"is_enabled" desc:"Default true, makes a search box appear in the zone view for finding other zones"`
	IsMemorySearchEnabled bool `toml:"is_memory_search_enabled" desc:"Default false, enables memory search for zones"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.