tmlapi13

Documentation

Index

• func GetInternalName(display_name string) (string, bool)
• func GetRandomMod() string
• type Author
  • func GetAuthorInfo(steamid64 string) (Author, error)
• type AuthorMaintainedModInfo
• type AuthorModInfo
• type ModInfo
  • func GetModInfo(modName string) (ModInfo, error)
• type ModListItem
  • func GetModList() []ModListItem
• type ModVersion
  • func GetModVersionHistory(modName string) ([]ModVersion, error)

Functions

func GetInternalName

func GetInternalName(display_name string) (string, bool)

func GetRandomMod

func GetRandomMod() string

returns a random internal mod name

Types

type Author

type Author struct {
	SteamName          string                    `json:"steam_name"`
	DownloadsTotal     int                       `json:"downloads_total"`
	DownloadsYesterday int                       `json:"downloads_yesterday"`
	Mods               []AuthorModInfo           `json:"mods"`
	MaintainedMods     []AuthorMaintainedModInfo `json:"maintained_mods"`
}

func GetAuthorInfo

func GetAuthorInfo(steamid64 string) (Author, error)

type AuthorMaintainedModInfo

type AuthorMaintainedModInfo struct {
	InternalName       string `json:"internal_name"`
	EscapedModName     string // added later
	DownloadsTotal     int    `json:"downloads_total"`
	DownloadsYesterday int    `json:"downloads_yesterday"`
}

type AuthorModInfo

type AuthorModInfo struct {
	Rank               int    `json:"rank"`
	DisplayName        string `json:"display_name"`
	InternalName       string // added later
	DownloadsTotal     int    `json:"downloads_total"`
	DownloadsYesterday int    `json:"downloads_yesterday"`
}

type ModInfo

type ModInfo struct {
	DisplayName        string `json:"display_name"`
	Rank               int    `json:"rank"`
	InternalName       string `json:"internal_name"`
	Author             string `json:"author"`
	Homepage           string `json:"homepage"`
	Description        string `json:"description"`
	Icon               string `json:"icon"`
	Version            string `json:"version"`
	TModLoaderVersion  string `json:"tmodloader_version"`
	LastUpdated        string `json:"last_updated"`
	ModDependencies    string `json:"modreferences"`
	ModSide            string `json:"modside"`
	DownloadLink       string `json:"download_link"`
	DownloadsTotal     int    `json:"downloads_total"`
	DownloadsToday     int    `json:"downloads_today"`
	DownloadsYesterday int    `json:"downloads_yesterday"`
}

ModInfo holds mod info that is fetched from tmlapis.tomat.dev/1.3/mod

func GetModInfo

func GetModInfo(modName string) (ModInfo, error)

requires a internal modName

type ModListItem

type ModListItem struct {
	DisplayName        string        `json:"display_name"`
	InternalName       string        `json:"internal_name"`
	DisplayNameHTML    template.HTML // added later
	Rank               int           `json:"rank"`
	DownloadsTotal     int           `json:"downloads_total"`
	DownloadsToday     int           `json:"downloads_today"`
	DownloadsYesterday int           `json:"downloads_yesterday"`
	TModLoaderVersion  string        `json:"tmodloader_version"`
}

ModListItem holds a single item when fetching the whole modList

func GetModList

func GetModList() []ModListItem

type ModVersion

type ModVersion struct {
	Version           string `json:"version"`
	DownloadsTotal    int    `json:"downloads_total"`
	TModLoaderVersion string `json:"tmodloader_version"`
	PublishDate       string `json:"publish_date"`
}

func GetModVersionHistory

func GetModVersionHistory(modName string) ([]ModVersion, error)

requires a internal modName