SimTX API/Packets/CatalogList

CatalogList

Frame	ServerFrame, field 36
Member	catalog_list
Direction	Server → client
Session	Control (catalog)
Roles	ROLE_CONTROL.
Permission	None
Answered by
Answers	CatalogListRequest
Defined in	control.proto

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

Definition

message CatalogList { int64 request_id = 1; repeated CatalogEntrySummary entries = 2; }

Fields

#	Field	Type	Description
1	request_id	int64	The request this answers.
2	entries	repeated CatalogEntrySummary	One summary per entry, ordered by kind, then name.

CatalogEntrySummary

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;
}

#	Field	Type	Description
1	id	int32	Entry ID. Stable across revisions.
2	kind	string	extension or preset.
3	name	string	Entry name.
4	description	string	Description, possibly empty.
5	author	string	Display name of the publishing account.
6	size_bytes	int32	Total size of the files.
7	file_count	int32	Number of files.
8	types	repeated string	Catalog type names. Skip names you do not know.
9	categories	repeated string	Free-text categories chosen by the author.
10	package_id	string	Extension package ID from the manifest, for example com.example.beacon. Empty for presets.
11	package_version	string	Package version (semantic versioning). Empty for presets.
12	dependencies	repeated CatalogDependency	Packages this extension requires.
13	revision	int32	Revision number, starting at 1. Increases with every update by the owner.
14	uploaded_at_ms	int64	Time of the latest revision, Unix ms.

CatalogDependency

message CatalogDependency {
  string id = 1;
  string version_range = 2;
}

#	Field	Type	Description
1	id	string	Package ID of the required extension.
2	version_range	string	Accepted versions, as in the manifest.

Catalog types

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

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

See also

• Extension catalog
• Lua extension manifest