Skip to content

Class PackRequest

Namespace: Apogee.Content.Packs
Assembly: Apogee.Content.dll

What packs, and how.

public sealed record PackRequest : IEquatable<PackRequest>

Inheritance

object ← PackRequest

Implements

IEquatable<PackRequest>

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Properties

AllowNothingImported

With : a folder with nothing imported (no assets that need an importer, so no imported/index.xml) is packed with nothing dropped, instead of being an error. An export sets this, since a game of scripts and data has nothing to import.

public bool AllowNothingImported { get; init; }

Property Value

bool

Bases

Makes a patch pack: these packs (in order, with the same ) are what the game has already, and the new pack holds the files that are new or changed, and a removal for each file that is gone.

public IReadOnlyList<string> Bases { get; init; }

Property Value

IReadOnlyList<string>

CompressionLevel

The zstd level, 1 (fast) to 22 (small).

public int CompressionLevel { get; init; }

Property Value

int

Cooked

Pack what a shipped game needs: the imported artifacts instead of the sources, their settings and the files they were made from, and authored documents () and the UID list imported/assets.xml in their cooked form () at the paths they have in the folder, and so are the definitions (the .xml files) in the content folders of the base packages (packages/<id>/, as their mod.xml lists them). The manifests (mod.xml), schemas and sidecars stay text. It needs the folder to have been imported (imported/index.xml, see ) unless says otherwise. Nothing under dev_mods/ is cooked.

public bool Cooked { get; init; }

Property Value

bool

Exclude

Folder-relative prefixes of what to leave out, compared as plain text and case-sensitively (dev_mods/ leaves out that folder; dev_mods would also leave out dev_mods2/). Both slashes work. They are applied to the files in the folder, so a patch pack with a prefix also removes what an earlier pack held under it.

public IReadOnlyList<string> Exclude { get; init; }

Property Value

IReadOnlyList<string>

Folder

The game folder: it is res://, and the paths in the pack are relative to it. Names that start with a dot are left out.

public required string Folder { get; init; }

Property Value

string

Key

Encrypts the pack ( is for the caller to ask: the packer never reads the environment).

public PackKey? Key { get; init; }

Property Value

PackKey?

Output

The first part of the pack (game.pack); a bigger pack goes on in game_001.pack… beside it.

public required string Output { get; init; }

Property Value

string

SplitBytes

A part grows to about this many bytes before the next file starts a new one.

public long SplitBytes { get; init; }

Property Value

long