SimTX API v24/Packets/CatalogList: Difference between revisions
SimTX API documentation |
Archive the v24 protocol reference: use the v24 templates, links and categories |
||
| (One intermediate revision by the same user not shown) | |||
| 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]] | ||
Latest revision as of 16:14, 24 October 2026
| Packet ID | 24(0x18)
|
|---|---|
| Direction | Server → client |
| Session | Control (catalog) |
| Body size | Variable |
| Permission | None |
| Answers | CatalogListRequest |
CatalogList is the index of the extension catalog: one summary per entry, without file contents. Fetch an entry's files with CatalogFetch.
Layout[edit | edit source]
| Field | Type | Description |
|---|---|---|
packetId |
u8 |
Always 24.
|
count |
i32 |
Number of entries. |
entries |
count × Entry |
See below. Ordered by kind, then name. |
Entry[edit | edit source]
| 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[edit | edit source]
| 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.