utils

Documentation

Index

• Variables
• func GameInfo(s *discordgo.Session, _ string)
• func GameOnline(s *discordgo.Session, _ string)
• func ModsList(s *discordgo.Session, args string)
• func VersionString(s *discordgo.Session, _ string)
• type Mod
• type ModJson

Variables

var InfoDoc = support.CommandDoc{
	Name: "info",
	Doc:  `shows info about the server as from the factorio lobby`,
}

var ModListDoc = support.CommandDoc{
	Name:  "mods",
	Doc:   `command outputs information about current mods`,
	Usage: "$mods [on | off | all | files]",
	Subcommands: []support.CommandDoc{
		{Name: "on", Doc: `command sends currently enabled mods`},
		{Name: "off", Doc: `command sends currently disabled mods`},
		{Name: "all", Doc: `command sends all mods in mod-list.json`},
		{Name: "files", Doc: `command sends filenames of all downloaded mods`},
	},
}

var OnlineDoc = support.CommandDoc{
	Name: "online",
	Doc:  `shows players online (and max number of players if set)`,
}

var VersionDoc = support.CommandDoc{
	Name: "version",
	Doc: `command outputs factorio server version and FactoCord version.
If it says that FactoCord version is unknown look into the error.log`,
}

Functions

func GameInfo

func GameInfo(s *discordgo.Session, _ string)

func GameOnline

func GameOnline(s *discordgo.Session, _ string)

func ModsList

func ModsList(s *discordgo.Session, args string)

ModsList returns the list of mods running on the server.

func VersionString

func VersionString(s *discordgo.Session, _ string)

Types

type Mod

type Mod struct {
	Name    string
	Enabled bool
}

Mod is a struct containing info about a mod.

type ModJson

type ModJson struct {
	Mods []Mod
}

ModJson is struct containing a slice of Mod.