SimTX API v24/Packets/CatalogList - Revision history

Clanker: Archive the v24 protocol reference: use the v24 templates, links and categories

2026-10-24T16:14:05Z

Archive the v24 protocol reference: use the v24 templates, links and categories

← Older revision		Revision as of 16:14, 24 October 2026
Line 1:		Line 1:
	{{SimTX API navigation}}		{{SimTX API v24 navigation}}
	{{SimTX packet		{{SimTX packet v24
	\| name = CatalogList		\| name = CatalogList
	\| id = 24		\| id = 24
	\| hex = 0x18		\| hex = 0x18
	\| direction = s2c		\| direction = s2c
	\| session = [[SimTX API/Extension catalog protocol\|Control (catalog)]]		\| session = [[SimTX API v24/Extension catalog protocol\|Control (catalog)]]
	\| size = Variable		\| size = Variable
	\| permission = None		\| permission = None
	\| answers = [[SimTX API/Packets/CatalogListRequest\|CatalogListRequest]]		\| answers = [[SimTX API v24/Packets/CatalogListRequest\|CatalogListRequest]]
	\| group = catalog		\| group = catalog
	}}		}}
	'''CatalogList''' is the index of the [[SimTX API/Extension catalog protocol\|extension catalog]]: one summary per entry, without file contents. Fetch an entry's files with [[SimTX API/Packets/CatalogFetch\|CatalogFetch]].		'''CatalogList''' is the index of the [[SimTX API v24/Extension catalog protocol\|extension catalog]]: one summary per entry, without file contents. Fetch an entry's files with [[SimTX API v24/Packets/CatalogFetch\|CatalogFetch]].

	== Layout ==		== Layout ==
Line 86:		Line 86:
	* [[Lua extension manifest]]		* [[Lua extension manifest]]

	{{SimTX API navbox}}		{{SimTX API v24 navbox}}
	[[Category:SimTX API]]		[[Category:SimTX API v24]]

Clanker: Clanker moved page SimTX API/Packets/CatalogList to SimTX API v24/Packets/CatalogList: Archive the v24 protocol reference

2026-10-24T16:13:59Z

Clanker moved page SimTX API/Packets/CatalogList to SimTX API v24/Packets/CatalogList: Archive the v24 protocol reference

← Older revision	Revision as of 16:13, 24 October 2026
(No difference)

Clanker: SimTX API documentation

2026-10-24T10:01:27Z

SimTX API documentation

New page

{{SimTX API navigation}}
{{SimTX packet
| name = CatalogList
| id = 24
| hex = 0x18
| direction = s2c
| session = [[SimTX API/Extension catalog protocol|Control (catalog)]]
| size = Variable
| permission = None
| answers = [[SimTX API/Packets/CatalogListRequest|CatalogListRequest]]
| group = catalog
}}
'''CatalogList''' is the index of the [[SimTX API/Extension catalog protocol|extension catalog]]: one summary per entry, without file contents. Fetch an entry's files with [[SimTX API/Packets/CatalogFetch|CatalogFetch]].

== Layout ==
{| class="wikitable"
! Field !! Type !! Description
|-
| <code>packetId</code> || <code>u8</code> || Always <code>24</code>.
|-
| <code>count</code> || <code>i32</code> || Number of entries.
|-
| <code>entries</code> || <code>count × Entry</code> || See below. Ordered by kind, then name.
|}

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

== Catalog types ==
{| class="wikitable"
! Name !! Display name
|-
| <code>MODULATION</code> || Modulation
|-
| <code>AUDIO_ADDON</code> || Audio add-on
|-
| <code>THEME</code> || Theme
|-
| <code>ACTION</code> || Tool / action
|-
| <code>LIBRARY</code> || Library
|-
| <code>PRESET</code> || 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]]

{{SimTX API navbox}}
[[Category:SimTX API]]