fmod

README

fmod

Not to be confused with F-mod, fmod is a command line mod installer for Factorio

Usage

Some basic usage

fmod update

This updates the local list of mods. This should usually be done fairly frequently before installing anything new

fmod install install Larger_Inventory

This will install the Larger Inventory mod

fmod search turret

This will list mods with turret in their name

fmod -fv 0.12.xx turret

This will list mods with turret in their name that are currently marked as supported with 0.12.xx

fmod query Larger_Inventory

This will show you some specific details about the Larger Inventory mod

fmod uninstall Larger_Inventory

This will remove Larger_Inventory from you installation

fmod config install-location Z:\\MyGames\\Factorio\\

This sets the diretory of your Factorio installation. By default it's set to the default install directory of Factorio. This needs to be set if you plan on installing Factorio anywhere else.

fmod setup

This will do various things depending on the platform

On Windows we generate a registry file to do URL assosiations so we can install from factoriomods.com

This does nothing on Linux, so far

fmod list

This will list the currently installed mods and their versions

Status

Currently working on laying out the featureset i want to keep.

Eventually I plan to add more features, especially to upgrading mods, clamping versions, and searching by more paramaters

Documentation

Index

• type Mod
• type ModList
  • func GetMods() (ModList, error)
• type Release
• type ReleaseFile

Types

type Mod

type Mod struct {
	Title       string    `json:"title"`
	Name        string    `json:"name"`
	Url         string    `json:"url"`
	Description string    `json:"description"`
	Homepage    string    `json:"homempage"`
	Contact     string    `json:"contact"`
	Author      string    `json:"author"`
	Categories  []string  `json:"categories"`
	Releases    []Release `json:"releases"`
	Message     string    `json:"message"` // Used for error messages
	Version     string    `json:"version"` // Used in info.json not in a factoriomod.com mod
}

type ModList

type ModList []Mod

func GetMods

func GetMods() (ModList, error)

type Release

type Release struct {
	Version      string `json:"version"`
	ReleasedAt   time.Time
	GameVersions []string      `json:"game_versions"`
	Dependencies []string      `json:"dependencise"`
	Files        []ReleaseFile `json:"files"`
}

type ReleaseFile

type ReleaseFile struct {
	Name   string `json:"name"`
	Url    string `json:"url"`
	Mirror string `json:"mirror"`
}