games

Documentation

Index

• type Config
  • func (c Config) GetSupportedExtensions() []string
• type FileExtensionWhitelist
• type GameLibrary
  • func NewLib(conf Config) GameLibrary
  • func NewLibWhitelisted(conf Config, filter FileExtensionWhitelist) GameLibrary
• type GameMetadata

Types

type Config

type Config struct {
	// some directory which is going to be
	// the root folder for the library
	BasePath string
	// a list of supported file extensions
	Supported []string
	// a list of ignored words in the files
	Ignored []string
	// print some additional info
	Verbose bool
	// enable directory changes watch
	WatchMode bool
}

Config is an external configuration

func (Config) GetSupportedExtensions

func (c Config) GetSupportedExtensions() []string

type FileExtensionWhitelist

type FileExtensionWhitelist interface {
	GetSupportedExtensions() []string
}

type GameLibrary

type GameLibrary interface {
	GetAll() []GameMetadata
	FindGameByName(name string) GameMetadata
	Scan()
}

func NewLib

func NewLib(conf Config) GameLibrary

func NewLibWhitelisted

func NewLibWhitelisted(conf Config, filter FileExtensionWhitelist) GameLibrary

type GameMetadata

type GameMetadata struct {

	// the display name of the game
	Name string
	// the game file extension (e.g. nes, n64)
	Type string
	// the game path relative to the library base path
	Path string
	// contains filtered or unexported fields
}