workshop

func CheckAvailable ¶

func CheckAvailable(resource any) (string, []error)

Checks if a resource is available.

Param `resource` is an int for its Workshop ID or a string for its Workshop URL.

func DownloadResource ¶

func DownloadResource(id int, output io.Writer) error

Writes Workshop resource by ID to given Writer.

func ExtractResource ¶

func ExtractResource(r resource.Resource, dir, game string, verbose bool) (string, error)

Extracts things that match "dir/id - (downloaded title).zip" where dir is a given directory and id is the given Workshop ID.

Deletes the archive if successful.

func GetBreadcrumbs ¶ added in v1.0.1

func GetBreadcrumbs(url string) ([]string, error)

At the top of a Workshop page theres "breadcrumbs" which look like "Game > Workshop > Collections > User's Workshop". This function looks for thos "breadcrumbs" then gives them like []string{ "Game", "Workshop", "Collections", "User's Workshop" }

func GetGame ¶

func GetGame(id any) (string, error)

Gets the game from a steam workshop ID or URL. Arg "id" accepts int or string, where the former is the ID and the latter is the full URL.

func GetResourceTitle ¶

func GetResourceTitle(url string) (string, error)

Gets the Workshop title from the page given.

func IsCollection ¶

func IsCollection(url string) (bool, error)

Returns true if the given page is a URL.

At the top of a Workshop page theres "breadcrumbs" which look like "Game > Workshop > Collections > User's Workshop". This function checks if "Collection" is in those breadcrumbs.