game

Documentation

Index

• Variables
• type Game
  • func At(path string) Game
  • func (g Game) Available() ([]pkg.Package, error)
  • func (g Game) BasePath() (string, error)
  • func (g Game) Find(name string) []pkg.Package
  • func (g Game) FromSource(source string) (pkg.Package, error)
  • func (g Game) Get(name string) (pkg.Package, error)
  • func (g Game) Installed() ([]pkg.Package, error)

Variables

var Default = Game{}

Default game instance at the current working directory.

Types

type Game

type Game struct {
	Path string
}

Game represents a game instance at a given path.

func At

func At(path string) Game

At returns the game instance at the given path.

func (Game) Available

func (g Game) Available() ([]pkg.Package, error)

Available mods.

func (Game) BasePath

func (g Game) BasePath() (string, error)

BasePath returns the resolved path of the game.

func (Game) Find

func (g Game) Find(name string) []pkg.Package

Find matching mods with (part of) the given name.

func (Game) FromSource

func (g Game) FromSource(source string) (pkg.Package, error)

FromSource returns a mod that represents the source object

func (Game) Get

func (g Game) Get(name string) (pkg.Package, error)

Get mod by name.

func (Game) Installed

func (g Game) Installed() ([]pkg.Package, error)

Installed mods.