types

Documentation

Index

• type ChangeLog
• type CliFlags
  • func NewScraper() *CliFlags
• type File
• type ModInfo
• type Requirement
• type Results
• type Tag

Types

type ChangeLog

type ChangeLog struct {
	Notes   []string `json:"Notes,omitempty"`
	Version string   `json:"Version,omitempty"`
}

ChangeLog represents a mod's changelog, including the version and a list of notes.

type CliFlags

type CliFlags struct {
	BaseUrl         string
	CookieDirectory string
	CookieFile      string
	DisplayResults  bool
	GameName        string
	ModID           int64
	OutputDirectory string
	SaveResults     bool
	ValidCookies    []string
}

cli related. CliFlags defines the structure for command-line flags, including options such as the base URL, cookie directory, cookie file, display and save result flags, game name, mod ID, output directory, and valid cookies for the operation.

func NewScraper

func NewScraper() *CliFlags

NewScraper initializes and returns a new instance of CliFlags with default values.

type File

type File struct {
	Description string `json:"description"`
	FileSize    string `json:"fileSize"`
	Name        string `json:"name"`
	TotalDLs    string `json:"totalDownloads"`
	UniqueDLs   string `json:"uniqueDownloads"`
	UploadDate  string `json:"uploadDate"`
	Version     string `json:"version"`
}

File represents details about a mod file, including its description, file size, name, download statistics, upload date, and version.

type ModInfo

type ModInfo struct {
	ChangeLogs       []ChangeLog   `json:"ChangeLogs,omitempty"`
	Creator          string        `json:"Creator,omitempty"`
	Dependencies     []Requirement `json:"Dependencies,omitempty"`
	Description      string        `json:"Description,omitempty"`
	Files            []File        `json:"Files,omitempty"`
	LastChecked      time.Time     `json:"LastChecked,omitempty"`
	LastUpdated      string        `json:"LastUpdated,omitempty"`
	LatestVersion    string        `json:"LatestVersion,omitempty"`
	ModID            int64         `json:"ModID,omitempty"`
	ModsUsing        []Requirement `json:"ModsUsing,omitempty"`
	Name             string        `json:"Name,omitempty"`
	OriginalUpload   string        `json:"OriginalUpload,omitempty"`
	ShortDescription string        `json:"ShortDescription,omitempty"`
	Tags             []string      `json:"Tags,omitempty"`
	Uploader         string        `json:"Uploader,omitempty"`
	Url              string        `json:"Url,omitempty"`
	VirusStatus      string        `json:"VirusStatus,omitempty"`
}

ModInfo represents detailed information about a mod, including its changelogs, creator, dependencies, description, files, timestamps, versioning, tags, uploader, URL, and virus status. Fields are JSON-tagged for proper formatting and may be omitted if empty.

type Requirement

type Requirement struct {
	Name  string `json:"Name,omitempty"`
	Notes string `json:"Notes,omitempty"`
}

Requirement represents a mod requirement, including the name of the required mod and any additional notes.

type Results

type Results struct {
	Mods ModInfo `json:"Mods"`
}

Results defines the structure for storing the scraping results, which includes a ModInfo object under the key "Mods" in the JSON output.

type Tag

type Tag struct {
	Tag string `json:"Tag,omitempty"`
}

Tag represents a tag associated with a mod, containing a single tag string.