nexus

Documentation

Index

• type IdentifyResult
  • func IdentifyNexusFile(originalBasename string, archiveSize int64, label string, fileVersion string, ...) (*IdentifyResult, []string, error)
• type MatchConfidence
  • func (m MatchConfidence) String() string
• type ModRef
  • func ParseModURL(raw string) (ModRef, error)

Types

type IdentifyResult

type IdentifyResult struct {
	File       nexusclient.ModFileInfo
	Confidence MatchConfidence
	Strategy   string // human readable description of what matched
}

IdentifyResult holds the result of a successful identification

func IdentifyNexusFile

func IdentifyNexusFile(
	originalBasename string,
	archiveSize int64,
	label string,
	fileVersion string,
	files []nexusclient.ModFileInfo,
) (*IdentifyResult, []string, error)

IdentifyNexusFile attempts to identify which ModFileInfo corresponds to a locally imported archive. Returns nil if identification was ambiguous or failed.

type MatchConfidence

type MatchConfidence int

MatchConfidence indicates how certain we are about a file identification

const (
	MatchConfidenceCertain   MatchConfidence = iota // exact filename match
	MatchConfidenceConfident                        // timestamp, size+timestamp, or label+size
	MatchConfidenceNone                             // ambiguous or no match
)

func (MatchConfidence) String

func (m MatchConfidence) String() string

type ModRef

type ModRef struct {
	GameDomain   string
	ModID        int64
	CanonicalUrl string
}

func ParseModURL

func ParseModURL(raw string) (ModRef, error)

ParseModURL extracts (game_domain, mod_id) from a Nexus Mods mod page URL.

Expected paths look like:

/<game_domain>/mods/<mod_id>

e.g. https://www.nexusmods.com/skyrimspecialedition/mods/266