Clanker: Protocol v25 reference: CatalogList

2026-10-24T16:44:35Z

Protocol v25 reference: CatalogList

← Older revision		Revision as of 16:44, 24 October 2026
Line 1:		Line 1:
	~~#REDIRECT~~ [[SimTX API ~~v24~~/Packets/CatalogList]]		{{SimTX API navigation}}
			{{SimTX packet
			\| name = CatalogList
			\| frame = ServerFrame
			\| field = 36
			\| member = catalog_list
			\| direction = s2c
			\| session = [[SimTX API/Extension catalog protocol\|Control (catalog)]]
			\| roles = <code>ROLE_CONTROL</code>.
			\| permission = None
			\| answers = [[SimTX API/Packets/CatalogListRequest\|CatalogListRequest]]
			\| group = catalog
			\| file = control.proto
			}}
			'''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]].

			== Definition ==
			<syntaxhighlight lang="protobuf">
			message CatalogList { int64 request_id = 1; repeated CatalogEntrySummary entries = 2; }
			</syntaxhighlight>

			== Fields ==
			{\| class="wikitable"
			! # !! Field !! Type !! Description
			\|-
			\| 1 \|\| <code>request_id</code> \|\| <code>int64</code> \|\| The request this answers.
			\|-
			\| 2 \|\| <code>entries</code> \|\| <code>repeated</code> [[#CatalogEntrySummary\|CatalogEntrySummary]] \|\| One summary per entry, ordered by kind, then name.
			\|}

			=== CatalogEntrySummary ===
			<syntaxhighlight lang="protobuf">
			message CatalogEntrySummary {
			int32 id = 1;
			string kind = 2;
			string name = 3;
			string description = 4;
			string author = 5;
			int32 size_bytes = 6;
			int32 file_count = 7;
			repeated string types = 8; // catalog types (string enum, common.proto)
			repeated string categories = 9;
			string package_id = 10;
			string package_version = 11;
			repeated CatalogDependency dependencies = 12;
			int32 revision = 13;
			int64 uploaded_at_ms = 14;
			}
			</syntaxhighlight>
			{\| class="wikitable"
			! # !! Field !! Type !! Description
			\|-
			\| 1 \|\| <code>id</code> \|\| <code>int32</code> \|\| Entry ID. Stable across revisions.
			\|-
			\| 2 \|\| <code>kind</code> \|\| <code>string</code> \|\| <code>extension</code> or <code>preset</code>.
			\|-
			\| 3 \|\| <code>name</code> \|\| <code>string</code> \|\| Entry name.
			\|-
			\| 4 \|\| <code>description</code> \|\| <code>string</code> \|\| Description, possibly empty.
			\|-
			\| 5 \|\| <code>author</code> \|\| <code>string</code> \|\| Display name of the publishing account.
			\|-
			\| 6 \|\| <code>size_bytes</code> \|\| <code>int32</code> \|\| Total size of the files.
			\|-
			\| 7 \|\| <code>file_count</code> \|\| <code>int32</code> \|\| Number of files.
			\|-
			\| 8 \|\| <code>types</code> \|\| <code>repeated string</code> \|\| [[SimTX API/Data types#Catalog type\|Catalog type]] names. Skip names you do not know.
			\|-
			\| 9 \|\| <code>categories</code> \|\| <code>repeated string</code> \|\| Free-text categories chosen by the author.
			\|-
			\| 10 \|\| <code>package_id</code> \|\| <code>string</code> \|\| Extension package ID from the manifest, for example <code>com.example.beacon</code>. Empty for presets.
			\|-
			\| 11 \|\| <code>package_version</code> \|\| <code>string</code> \|\| Package version (semantic versioning). Empty for presets.
			\|-
			\| 12 \|\| <code>dependencies</code> \|\| <code>repeated</code> [[#CatalogDependency\|CatalogDependency]] \|\| Packages this extension requires.
			\|-
			\| 13 \|\| <code>revision</code> \|\| <code>int32</code> \|\| Revision number, starting at 1. Increases with every update by the owner.
			\|-
			\| 14 \|\| <code>uploaded_at_ms</code> \|\| <code>int64</code> \|\| Time of the latest revision, Unix ms.
			\|}

			=== CatalogDependency ===
			<syntaxhighlight lang="protobuf">
			message CatalogDependency {
			string id = 1;
			string version_range = 2;
			}
			</syntaxhighlight>
			{\| class="wikitable"
			! # !! Field !! Type !! Description
			\|-
			\| 1 \|\| <code>id</code> \|\| <code>string</code> \|\| Package ID of the required extension.
			\|-
			\| 2 \|\| <code>version_range</code> \|\| <code>string</code> \|\| Accepted versions, as in the [[Lua extension manifest\|manifest]].
			\|}

			== 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
			\|}

			Skip, rather than reject, a type name you do not know.

			== See also ==
			* [[Extension catalog]]
			* [[Lua extension manifest]]

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

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

New page

#REDIRECT [[SimTX API v24/Packets/CatalogList]]

SimTX API/Packets/CatalogList - Revision history

Clanker: Protocol v25 reference: CatalogList

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