Skip to content

Namespace Apogee.Content.Packages

Classes

GameManifest

The game.xml at the root of a game folder: the game's name, who made it, its version, the folder of the player's files, its Steam app id, and the window it opens with. Checked against the engine's schema (Packages/game.xsd) and further: the version is major.minor.patch, and the paths it names (the entry scene and the icon) are relative and stay inside the game. A game without one still runs from a folder (it has no version and its user folder is named after the folder), but cannot be exported.

PackageCandidate

A package found, before it is decided whether it loads.

PackageDependency

A package that another needs, and which versions of it.

PackageManifest

The mod.xml at the root of a package. Checked against the engine's schema (Packages/mod.xsd) and further: the id is lowercase letters, digits and underscores (and not one the engine uses: engine, self, res, user, mod), versions and ranges parse, and the paths it names are relative and stay inside the package.

PackageOptions

Where looks for packages, and what it checks them against.

PackageSet

The packages of a game: the base game's and the mods. finds them (), reads their manifests, decides which load and in which order (), and mounts each one that loads at mod://<id>/, whatever it is (a folder, a zip), so that a package's files have one address everywhere. What is wrong with a package that does not load is in its ; what is wrong with the search itself (a manifest that does not parse, an id that is not its folder's name) is in . Dispose it to take the mounts away.

PackageSolver

Decides which packages load and in what order. There is one version of each id: the first candidate with an id wins and later ones are ignored with a problem. A package is disabled, with a reason, when it needs a newer API or another game version, the player switched it off, a dependency is missing, disabled, or out of its version range, it is in a dependency cycle, or it is a base package that needs a mod; disabling cascades to what depends on it. What loads is ordered so that dependencies come first, base packages before mods and otherwise by id, so that the order is the same on every machine.

SolveOptions

SolveResult

SolvedPackage

A package and whether it loads. says why not.

UserModSettings

The mods the player switched off, in user://mods.xml (<Mods><Disabled id="cool"/></Mods>). Only the game writes it, never a mod; base packages ignore it.

VersionRange

Which versions a dependency or a game accepts: comparators separated by spaces or commas that must all hold. >=1.2, <=, >, <, =1.2 (or just 1.2), ^1.2.3 (at least that, below the next version of its first non-zero part: <2.0.0, and ^0.2.3 is <0.3.0), ~1.2.3 (below the next minor: <1.3.0), and * (any). Empty means any.

Structs

GameWindow

The window a game opens with.

PackageVersion

A version as major.minor.patch: 1.2 is 1.2.0, a leading v and any -suffix or +build are ignored.

Enums

PackageKind

Where a package comes from. The base game's packages load first and cannot be switched off.