modmgr

package

v1.9.3 Latest Latest Go to latest Published: Jun 17, 2026 License: GPL-3.0 Imports: 23 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ikafly144/au_mod_installer

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func DownloadMods(cacheDir string, modVersions []ModVersion, binaryType aumgr.BinaryType, ...) error
func GenerateDoorstopConfig(basePath string) string
func PrepareProfileDirectory(profileDir string, gamePath string, cacheDir string, modVersions []ModVersion, ...) error
func ResolveDependencies(initialMods []ModVersion, provider VersionProvider) (map[string]ModVersion, error)
type CacheMetadata
type HashCheckingWriter
type Mod
type ModDependencydeprecated
type ModDependencyType
type ModPackdeprecated
type ModType
- func (mt ModType) IsVisible() bool
type ModVersion
type ProfileMetadata
- func GetProfileMetadata(profileDir string) (*ProfileMetadata, error)
type VersionProvider

Constants ¶

View Source

const FeatureDirectJoin = "direct_join"

Variables ¶

This section is empty.

Functions ¶

func DownloadMods ¶ added in v1.1.0

func DownloadMods(cacheDir string, modVersions []ModVersion, binaryType aumgr.BinaryType, progressListener progress.Progress, force bool) error

func GenerateDoorstopConfig ¶ added in v1.8.0

func GenerateDoorstopConfig(basePath string) string

func PrepareProfileDirectory ¶ added in v1.1.0

func PrepareProfileDirectory(profileDir string, gamePath string, cacheDir string, modVersions []ModVersion, binaryType aumgr.BinaryType, gameVersion string, force bool, progressListener progress.Progress) error

PrepareProfileDirectory installs mods from cache to the profile directory and generates doorstop_config.ini.

func ResolveDependencies ¶ added in v1.1.0

func ResolveDependencies(initialMods []ModVersion, provider VersionProvider) (map[string]ModVersion, error)

ResolveDependencies recursively finds all required dependencies for a given set of mod versions. It returns a map of ModID to ModVersion containing all original mods and their required dependencies. The algorithm attempts to find the best compatible version combination, trying newer versions first but backtracking to older versions if conflicts arise. When multiple MODs require the same dependency, it merges constraints to find a version that satisfies all.

Types ¶

type CacheMetadata ¶ added in v1.6.5

type CacheMetadata struct {
	ModVersion ModVersion `json:"mod_version"`
}

type HashCheckingWriter ¶ added in v1.4.2

type HashCheckingWriter interface {
	io.Writer
	Sum() (map[string]string, error)
}

type Mod ¶

type Mod struct {
	model.ModDetails
}

type ModDependency deprecated

type ModDependency struct {
	ID      string            `json:"id"`
	Version string            `json:"version,omitempty"`
	Type    ModDependencyType `json:"type"`
}

Deprecated: use model.ModVersionDependency instead

type ModDependencyType ¶

type ModDependencyType = model.DependencyType

const (
	ModDependencyTypeRequired ModDependencyType = model.DependencyTypeRequired
	ModDependencyTypeOptional ModDependencyType = model.DependencyTypeOptional
	ModDependencyTypeConflict ModDependencyType = model.DependencyTypeConflict
	ModDependencyTypeEmbedded ModDependencyType = model.DependencyTypeEmbedded
)

type ModPack deprecated

type ModPack struct {
	ID      string `json:"id"`
	Version string `json:"version,omitempty"`
}

Deprecated: use profile.Profile to represent mod packs now

type ModType ¶

type ModType string

const (
	ModTypeMod     ModType = "mod"
	ModTypeLibrary ModType = "library"
	// Deprecated: should not be used anymore
	// ModPack will be represented as profile.Profile now
	ModTypeModPack ModType = "modpack"
)

func (ModType) IsVisible ¶

func (mt ModType) IsVisible() bool

type ModVersion ¶

type ModVersion struct {
	model.ModVersionDetails
}

func (ModVersion) CompatibleFilesCount ¶

func (m ModVersion) CompatibleFilesCount(binaryType aumgr.BinaryType) int

func (ModVersion) Downloads ¶

func (m ModVersion) Downloads(binaryType aumgr.BinaryType) iter.Seq[model.ModVersionFile]

func (ModVersion) HasFeature ¶ added in v1.6.0

func (m ModVersion) HasFeature(feature string) bool

func (ModVersion) IsCompatible ¶

func (m ModVersion) IsCompatible(launcherType aumgr.LauncherType, binaryType aumgr.BinaryType, gameVersion string) bool

type ProfileMetadata ¶ added in v1.1.0

type ProfileMetadata struct {
	GameVersion string           `json:"game_version"`
	BinaryType  aumgr.BinaryType `json:"binary_type"`
	ModVersions []ModVersion     `json:"mod_versions"`
	ModFiles    []string         `json:"mod_files,omitempty"`
}

func GetProfileMetadata ¶ added in v1.1.0

func GetProfileMetadata(profileDir string) (*ProfileMetadata, error)

type VersionProvider ¶ added in v1.1.0

type VersionProvider interface {
	GetModVersion(modID string, versionID string) (*ModVersion, error)
	GetLatestModVersion(modID string) (*ModVersion, error)
	GetModVersionIDs(modID string, limit int, after string) ([]string, error)
}

VersionProvider is an interface to fetch mod version details.

Source Files ¶

View all Source files

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