Ship::ArchiveManifest Struct Reference

Metadata block embedded in an archive's manifest file. More...

#include <Archive.h>

Public Attributes
std::string	Name
	Display name of the mod/archive.
std::string	Icon
	Path to the mod's icon within the archive.
std::string	Author
	Author(s) of the archive.
std::string	Version
	Human-readable version string.
std::string	Website
	Author's website URL.
std::string	Description
	Short description of the archive contents.
std::string	License
	SPDX license identifier or URL.
uint32_t	CodeVersion
	API version of compiled script modules bundled with this archive.
uint32_t	GameVersion
	Numeric game version this archive targets.
std::string	Main
	Entry-point script path within the archive.
std::unordered_map< std::string, std::string >	Binaries
	Platform → binary path map for bundled native libs.
std::vector< std::string >	Dependencies
	Archive names that must be loaded before this one.
std::string	Checksum
	Hex-encoded SHA-256 checksum of the archive contents.
std::string	Signature
	Base64-encoded digital signature over the checksum.
std::string	PublicKey
	Base64-encoded public key used to verify the signature.

Detailed Description

Metadata block embedded in an archive's manifest file.

Populated by Archive subclasses when they open and parse the manifest entry. Fields that are not present in a particular archive are left as empty strings or zero values.

Member Data Documentation

Author

std::string Ship::ArchiveManifest::Author

Author(s) of the archive.

Binaries

std::unordered_map<std::string, std::string> Ship::ArchiveManifest::Binaries

Platform → binary path map for bundled native libs.

Checksum

std::string Ship::ArchiveManifest::Checksum

Hex-encoded SHA-256 checksum of the archive contents.

CodeVersion

uint32_t Ship::ArchiveManifest::CodeVersion

API version of compiled script modules bundled with this archive.

Dependencies

std::vector<std::string> Ship::ArchiveManifest::Dependencies

Archive names that must be loaded before this one.

Description

std::string Ship::ArchiveManifest::Description

Short description of the archive contents.

GameVersion

uint32_t Ship::ArchiveManifest::GameVersion

Numeric game version this archive targets.

Icon

std::string Ship::ArchiveManifest::Icon

Path to the mod's icon within the archive.

License

std::string Ship::ArchiveManifest::License

SPDX license identifier or URL.

Main

std::string Ship::ArchiveManifest::Main

Entry-point script path within the archive.

Name

std::string Ship::ArchiveManifest::Name

Display name of the mod/archive.

PublicKey

std::string Ship::ArchiveManifest::PublicKey

Base64-encoded public key used to verify the signature.

Signature

std::string Ship::ArchiveManifest::Signature

Base64-encoded digital signature over the checksum.

Version

std::string Ship::ArchiveManifest::Version

Human-readable version string.

Website

std::string Ship::ArchiveManifest::Website

Author's website URL.

---

The documentation for this struct was generated from the following file:

• include/ship/resource/archive/Archive.h