config

Documentation

Overview

Package config provides access to all of the tunable settings of a WolfMUD server. The default values can be overidden via a configuration file. The default name of the configuration file is config.wrj.

Users may specify an alternate path for the configuration file on the command line. As a fallback it will use the current directory. If the path does not specify a filename the default config.wrj will be used.

Index

• Variables

Variables

var Inventory = struct {
	Compact   int // only compact if cap - len*2 > compact
	CrowdSize int // If inventory has more player than this it's a crowd
}{
	Compact:   4,
	CrowdSize: 10,
}

Inventory default configuration

var Login = struct {
	AccountLength  int
	PasswordLength int
	SaltLength     int
}{
	AccountLength:  10,
	PasswordLength: 10,
	SaltLength:     32,
}

Login default configuration

var Server = struct {
	Host        string        // Host for server to listen on
	Port        string        // Port for server to listen on
	Greeting    []byte        // Connection greeting
	IdleTimeout time.Duration // Idle connection disconnect time
	MaxPlayers  int           // Max number of players allowed to login at once
	DataDir     string        // Main data directory
	Debug       bool          // Debug mode flag
}{
	Host:        "127.0.0.1",
	Port:        "4001",
	Greeting:    []byte(""),
	IdleTimeout: 10 * time.Minute,
	MaxPlayers:  1024,
	DataDir:     ".",
	Debug:       false,
}

Server default configuration

var Stats = struct {
	Rate time.Duration // Stats collection and display rate
	GC   bool          // Run garbage collection before stat collection
}{
	Rate: 10 * time.Second,
	GC:   false,
}

Stats default configuration