shortcuts

package
v0.0.20 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 26, 2024 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GenerateAppID

func GenerateAppID(exe string, appName string) uint

Generate appID - Used for big picture grids

func GenerateShortcutID

func GenerateShortcutID(exe string, appName string) uint

Generate shortcutID - Used as appID in shortcuts.vdf

func SaveToFile

func SaveToFile(shortcuts []*Shortcut, destinationFile string) error

Save shortcuts list to shortcuts file

Types

type MergeCallback added in v0.0.12

type MergeCallback func(target *Shortcut, source *Shortcut)

Merge callback with rules to apply between target and source

type Shortcut

type Shortcut struct {
	// Default specs
	AppID               uint     `json:"appId"`
	AppName             string   `json:"appName"`
	StartDir            string   `json:"startDir"`
	Exe                 string   `json:"exe"`
	LaunchOptions       string   `json:"launchOptions"`
	ShortcutPath        string   `json:"shortcutPath"`
	Icon                string   `json:"icon"`
	IsHidden            uint     `json:"isHidden"`
	AllowDesktopConfig  uint     `json:"allowDesktopConfig"`
	AllowOverlay        uint     `json:"allowOverlay"`
	OpenVR              uint     `json:"openVr"`
	Devkit              uint     `json:"devkit"`
	DevkitGameID        string   `json:"devkitGameId"`
	DevkitOverrideAppID uint     `json:"devkitOverrideAppId"`
	FlatpakAppID        string   `json:"flatpakAppId"`
	LastPlayTime        uint     `json:"lastPlayTime"`
	Tags                []string `json:"tags"`

	// Extended specs
	IconURL      string `json:"iconUrl"`
	LogoURL      string `json:"logoUrl"`
	Cover        string `json:"cover"`
	CoverURL     string `json:"coverUrl"`
	Banner       string `json:"banner"`
	BannerURL    string `json:"bannerUrl"`
	Hero         string `json:"hero"`
	HeroURL      string `json:"heroUrl"`
	Platform     string `json:"platform"`
	RelativePath string `json:"relativePath"`
}

Shortcut struct

func AddShortcut

func AddShortcut(shortcuts []*Shortcut, shortcut *Shortcut) ([]*Shortcut, error)

Add shortcut to the list

func GetShortcut added in v0.0.13

func GetShortcut(shortcuts []*Shortcut, appID uint) *Shortcut

Retrieve shortcut in the list with given appID

func LoadFromFile

func LoadFromFile(shortcutsFile string) ([]*Shortcut, error)

Load shortcuts from file

func MergeShortcuts added in v0.0.11

func MergeShortcuts(main []*Shortcut, extra []*Shortcut, mergeCallback MergeCallback, appendWhenNotFound bool) []*Shortcut

Merge shortcuts lists into one

func RemoveShortcut added in v0.0.10

func RemoveShortcut(shortcuts []*Shortcut, shortcut *Shortcut) ([]*Shortcut, error)

Remove shortcut from the list

func SortShortcuts

func SortShortcuts(shortcuts []*Shortcut) ([]*Shortcut, error)

Sort shortcuts in alphabetical order

Jump to

Keyboard shortcuts

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