ficsitcli

package

v1.0.18-0...-26f8a7e Latest Latest Go to latest Published: Nov 9, 2024 License: GPL-3.0 Imports: 38 Imported by: 0

Documentation ¶

Rendered for

Index ¶

Variables
func Init() error
type Action
type ExportedProfile
type ExportedProfileMetadata
type InstallState
type Mod
type PickerDirectory
type PickerResult
type Progress
type ProgressItem
type Update

Constants ¶

This section is empty.

Variables ¶

View Source

var AllActionTypes = []struct {
	Value  Action
	TSName string
}{
	{ActionInstall, "INSTALL"},
	{ActionUninstall, "UNINSTALL"},
	{ActionEnable, "ENABLE"},
	{ActionDisable, "DISABLE"},
	{ActionSelectInstall, "SELECT_INSTALL"},
	{ActionToggleMods, "TOGGLE_MODS"},
	{ActionSelectProfile, "SELECT_PROFILE"},
	{ActionImportProfile, "IMPORT_PROFILE"},
	{ActionUpdate, "UPDATE"},
	{ActionApply, "APPLY"},
}

View Source

var AllInstallationStates = []struct {
	Value  InstallState
	TSName string
}{
	{InstallStateUnknown, "UNKNOWN"},
	{InstallStateLoading, "LOADING"},
	{InstallStateInvalid, "INVALID"},
	{InstallStateValid, "VALID"},
}

View Source

var ErrInstallNotServer = fmt.Errorf("installation is not a server")

View Source

var FicsitCLI *ficsitCLI

View Source

var ServerPicker = &serverPicker{
	disks: make(map[string]diskData),
}

Functions ¶

func Init ¶

func Init() error

Types ¶

type Action ¶

type Action string

const (
	ActionInstall       Action = "install"
	ActionUninstall     Action = "uninstall"
	ActionEnable        Action = "enable"
	ActionDisable       Action = "disable"
	ActionSelectInstall Action = "selectInstall"
	ActionToggleMods    Action = "toggleMods"
	ActionSelectProfile Action = "selectProfile"
	ActionImportProfile Action = "importProfile"
	ActionUpdate        Action = "update"
	ActionApply         Action = "apply"
)

type ExportedProfile ¶

type ExportedProfile struct {
	Profile  cli.Profile              `json:"profile"`
	LockFile resolver.LockFile        `json:"lockfile"`
	Metadata *ExportedProfileMetadata `json:"metadata"`
}

type ExportedProfileMetadata ¶

type ExportedProfileMetadata struct {
	GameVersion int `json:"gameVersion"`
}

type InstallState ¶

type InstallState string

const (
	InstallStateUnknown InstallState = "unknown"
	InstallStateLoading InstallState = "loading"
	InstallStateInvalid InstallState = "invalid"
	InstallStateValid   InstallState = "valid"
)

type Mod ¶

type Mod struct {
	ModReference string                `json:"mod_reference"`
	Name         string                `json:"name"`
	Logo         *string               `json:"logo"` // Base64 encoded
	Authors      []string              `json:"authors"`
	Versions     []resolver.ModVersion `json:"versions"`
}

type PickerDirectory ¶

type PickerDirectory struct {
	Name           string `json:"name"`
	Path           string `json:"path"`
	IsValidInstall bool   `json:"isValidInstall"`
}

type PickerResult ¶

type PickerResult struct {
	IsValidInstall bool              `json:"isValidInstall"`
	Items          []PickerDirectory `json:"items"`
}

type Progress ¶

type Progress struct {
	Action Action                    `json:"action"`
	Item   ProgressItem              `json:"item"`
	Tasks  map[string]utils.Progress `json:"tasks"`
}

type ProgressItem ¶

type ProgressItem struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

type Update ¶

type Update struct {
	Item           string `json:"item"`
	CurrentVersion string `json:"currentVersion"`
	NewVersion     string `json:"newVersion"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL