manifest

type Dependencies map[string]string

type DependencyLock struct {
	Name        string `toml:"name" json:"name"`
	Version     string `toml:"version" json:"version"`
	VersionName string `toml:"versionName" json:"versionName"`
	Type        string `toml:"type" json:"type"`
	IPFSHash    string `toml:"ipfsHash" json:"ipfsHash"`
	Sha1        string `toml:"Sha1,omitempty" json:"Sha1,omitempty"`
	Sha256      string `toml:"Sha256,omitempty" json:"Sha256,omitempty"`
	Sha512      string `toml:"Sha512,omitempty" json:"Sha512,omitempty"`
	URL         string `toml:"url" json:"url"`
	// Provider usually is minepkg but can also be https
	Provider string `toml:"provider" json:"provider"`
	// Dependent is the package that requires this mod. can be _root if top package
	Dependent string `toml:"dependent" json:"dependent"`
	// IsDev is true if this is a dev dependency
	IsDev bool `toml:"isDev,omitempty" json:"isDev,omitempty"`
}

type FabricLock struct {
	Minecraft    string `toml:"minecraft" json:"minecraft"`
	FabricLoader string `toml:"fabricLoader" json:"fabricLoader"`
	Mapping      string `toml:"mapping" json:"mapping"`
}

type ForgeLock struct {
	Minecraft   string `toml:"minecraft" json:"minecraft"`
	ForgeLoader string `toml:"forgeLoader" json:"forgeLoader"`
}

type InterpretedDependency struct {
	// Provider is the system that should be used to fetch this dependency.
	// This usually is `minepkg` and can also be `https`. There might be more providers in the future
	Provider string
	// Name is the name of the package
	Name string
	// Source is what `Provider` will need to fetch the given Dependency
	// In practice this is a version number for `Provider === "minepkg"` and
	// a https url for `Provider === "https"`
	Source string
	// IsDev is true if this is a dev dependency
	IsDev bool

	ID *pkgid.ID
}

type Lockfile struct {
	LockfileVersion int                        `toml:"lockfileVersion" json:"lockfileVersion"`
	Fabric          *FabricLock                `toml:"fabric,omitempty" json:"fabric,omitempty"`
	Forge           *ForgeLock                 `toml:"forge,omitempty" json:"forge,omitempty"`
	Vanilla         *VanillaLock               `toml:"vanilla,omitempty" json:"vanilla,omitempty"`
	Dependencies    map[string]*DependencyLock `toml:"dependencies,omitempty" json:"dependencies,omitempty"`
}

type Manifest struct {
	// ManifestVersion specifies the format version
	// This field is REQUIRED, current version is 0
	ManifestVersion int `toml:"manifestVersion" comment:"Preview of the minepkg.toml format! Could break anytime!" json:"manifestVersion"`
	Package         struct {
		// Type should be one of `TypeMod` ("mod") or `TypeModpack` ("modpack")
		// this field is REQUIRED
		Type string `toml:"type" json:"type"`
		// Name is the name of the package. It may NOT include spaces. It may ONLY consist of
		// alphanumeric chars but can also include `-` and `_`
		// Should be unique. (This will be enforced by the minepkg api)
		// This field is REQUIRED
		Name string `toml:"name" json:"name"`
		// Description can be any free text that describes this package. Should be short(ish)
		Description string `toml:"description" json:"description"`
		// Version is the version number of this package. A proceeding `v` (like `v2.1.1`) is NOT
		// allowed to preserve consistency
		// The version may include prerelease information like `1.2.2-beta.0` or build
		// related information `1.2.1+B7382-2018`.
		// The version can be omitted. Publishing will require a version number as flag in that case
		Version string `toml:"version,omitempty" json:"version,omitempty"`
		// Platform indicates the supported playform of this package. can be `fabric`, `forge` or `vanilla`
		Platform string `toml:"platform,omitempty" json:"platform,omitempty"`
		// Licence for this project. Should be a valid SPDX identifier if possible
		// see https://spdx.org/licenses/
		License string `toml:"license,omitempty" json:"license,omitempty"`
		// Source is an URL that should point to the source code repository of this package (if any)
		Source string `toml:"source,omitempty" json:"source,omitempty"`
		// Homepage is an URL that should point to the website of this package (if any)
		Homepage string `toml:"homepage,omitempty" json:"homepage,omitempty"`
		// Author in the form of "Full Name <email@example.com>". Email can be omitted and Full Name does not have to be a real name
		Author string `toml:"author,omitempty" json:"author,omitempty"`
		// BasedOn can be a another package that this one is based on.
		// Most notably, this field is used for instances to determine what modpack is actually running
		// This field is striped when publishing the package to the minepkg api
		BasedOn string `toml:"basedOn,omitempty" json:"basedOn,omitempty"`
		// Savegame can be the name of the primary savegame on this modpack. Not applicable for other package types.
		// This savegame will be used when launching this package via `minepkg try`.
		// This should be the folder name of the savegame
		Savegame string `toml:"savegame,omitempty" json:"savegame,omitempty"`
	} `toml:"package" json:"package"`
	Requirements struct {
		// Minecraft is a semver version string describing the required Minecraft version
		// The Minecraft version is binding and implementers should not install
		// Mods for non-matching Minecraft versions.
		// Modpack & Mod Authors are encouraged to use semver to allow a broader install range.
		// This field is REQUIRED
		Minecraft string `toml:"minecraft" json:"minecraft"`
		// FabricLoader is a semver version string describing the required FabricLoader version
		// Only one of `Forge` or `FabricLoader` may be used
		FabricLoader string `toml:"fabricLoader,omitempty" json:"fabricLoader,omitempty"`
		// ForgeLoader is the minimum forge version required
		// no semver here, because forge does not follow semver
		ForgeLoader string `toml:"forgeLoader,omitempty" json:"forgeLoader,omitempty"`
		// MinepkgCompanion is the version of the minepkg companion plugin that is going to be added to modpacks.
		// This has no effect on other types of packages
		// `latest` is assumed if this field is omitted. `none` can be used to exclude the companion
		// plugin from a modpack – but this is not recommended
		MinepkgCompanion string `toml:"minepkgCompanion,omitempty" json:"minepkgCompanion,omitempty"`
		// old names, are only here for migration
		Fabric string `toml:"fabric,omitempty" json:"fabric,omitempty"`
		Forge  string `toml:"forge,omitempty" json:"forge,omitempty"`
	} `toml:"requirements" comment:"These are global requirements" json:"requirements"`
	// Dependencies lists runtime dependencies of this package
	// this list can contain mods and modpacks
	Dependencies `toml:"dependencies" json:"dependencies,omitempty"`
	// Dev contains development & testing related options
	Dev struct {
		// BuildCommand is the command used for building this package (usually "./gradlew build")
		BuildCommand string `toml:"buildCommand,omitempty" json:"buildCommand,omitempty"`
		// Jar defines the target location glob to the built jar file for mods. Can be empty. Example: "lib/builds/my-mod-v*.jar"
		Jar string `toml:"jar,omitempty" json:"jar,omitempty"`
		// Dependencies inside the dev struct should only be installed if this package is defined locally.
		// They should never be installed for published packages
		Dependencies `toml:"dependencies,omitempty" json:"dependencies,omitempty"`
	} `toml:"dev" json:"dev"`
}

type PlatformLock interface {
	PlatformName() string
	MinecraftVersion() string
	PlatformVersion() string
}

type PlatformRequirement struct {
	Minecraft     string `toml:"minecraft"`
	LoaderName    string `toml:"loader"`
	LoaderVersion string `toml:"loader_version"`
}

type Problems []ValidationError

type ValidationError struct {
	Path  string
	Level int
	// contains filtered or unexported fields
}

type VanillaLock struct {
	Minecraft string `toml:"minecraft" json:"minecraft"`
}