Skip to content

Namespace Apogee.Content.Packs

Classes

GamePacker

Packs a game folder into a pack (see ): the library behind Apogee.Runtime --pack, and what an export calls. The sources of imported assets are dropped from a cooked pack, authored XML and the definitions of the base packages are cooked in place, and a patch pack holds only what changed against its bases.

PackKey

The secret that encrypts a game's packs: 32 bytes, written as 64 hexadecimal digits. The build tool and the editor read it from the environment (APOGEE_PACK_KEY, which the .env file of the repository sets), and an export writes it, masked, into the executable of the game it makes (Apogee.Export.PackKeySlot; obfuscation, not protection) so that a shipped game needs no variable. Without a key packs are not encrypted. It is never written to a pack, a log, or an error message.

PackReport

What did.

PackRequest

What packs, and how.

PackSource

A pack (see ) as a source of the virtual file system. Opening reads the headers and indexes of the first part and of the parts that follow it (name_001.pack…, which must all be there); files are read, decrypted, decompressed and checked against their hashes when asked for. A pack that is encrypted needs the key (without one, or with a wrong one, says so); damage anywhere is an naming the file. Reads are safe from several threads. A patch pack can paths of the packs mounted under it.

PackWriter

Writes a pack: files added with (and paths taken away from the packs below it with , for a patch pack), then . Each file is compressed with zstd when that saves at least 10%, and sealed with AES-256-GCM when there is a key (see ). The pack is split into parts (game.pack, game_001.pack…) at ; mount the first with and it finds the rest.

PackWriterOptions