SimTX API v24/Packets/CatalogList

CatalogList

Frame	{{{frame}}}, field {{{field}}}
Member	{{{member}}}
Direction	Server → client
Session	Control (catalog)
Roles
Permission	None
Answered by
Answers	CatalogListRequest
Defined in

CatalogList is the index of the extension catalog: one summary per entry, without file contents. Fetch an entry's files with CatalogFetch.

Layout

Field	Type	Description
packetId	u8	Always 24.
count	i32	Number of entries.
entries	count × Entry	See below. Ordered by kind, then name.

Entry

Field	Type	Description
id	i32	Entry ID. Stable across revisions.
kind	UTF	extension or preset.
name	UTF	Entry name.
description	UTF	Description, possibly empty.
author	UTF	Display name of the publishing account.
sizeBytes	i32	Total size of the files.
fileCount	i32	Number of files.
typeCount	i32	Number of types that follow.
types	typeCount × UTF	Catalog types.
categoryCount	i32	Number of categories that follow, at most 100.
categories	categoryCount × UTF	Free-text categories chosen by the author.
packageId	UTF	Extension package ID from the manifest, for example com.example.beacon. Empty for presets.
packageVersion	UTF	Package version (semantic versioning). Empty for presets.
dependencyCount	i32	Number of dependencies that follow, at most 100.
dependencies	dependencyCount × { UTF id, UTF versionRange }	Packages this extension requires.
revision	i32	Revision number, starting at 1. Increases with every update by the owner.
uploadedAtEpochMillis	i64	Time of the latest revision, Unix milliseconds.

Catalog types

Name	Display name
MODULATION	Modulation
AUDIO_ADDON	Audio add-on
THEME	Theme
ACTION	Tool / action
LIBRARY	Library
PRESET	Preset

A client should skip, rather than reject, a type name it does not recognise, in case new types are added.

See also

• Extension catalog
• Lua extension manifest