SimTX API/Packets/CatalogEntry: Difference between revisions

Revision as of 16:44, 24 October 2026

API overviewQuick startHandshakeFramingAll messagesData typesStationsAccount serviceLimits and errorsv24 reference

CatalogEntry
Frame	`ServerFrame`, field 37
Member	`catalog_entry`
Direction	Server → client
Session	Control (catalog)
Roles	`ROLE_CONTROL`.
Permission	None
Answered by
Answers	CatalogFetch
Defined in	`control.proto`

CatalogEntry returns the files of one catalog entry requested with CatalogFetch. An unknown entry is answered with Error instead; the v24 found flag is gone.

Definition

message CatalogEntry {
  reserved 3;
  reserved "found";
  int64 request_id = 1;
  int32 entry_id = 2;
  string kind = 4;
  string name = 5;
  int32 revision = 6;
  repeated CatalogFile files = 7;
}

Fields

#	Field	Type	Description
1	`request_id`	`int64`	The request this answers.
2	`entry_id`	`int32`	The entry ID.
4	`kind`	`string`	`extension` or `preset`.
5	`name`	`string`	Entry name.
6	`revision`	`int32`	Revision number.
7	`files`	`repeated` CatalogFile	The entry's files, at most 1,000.

Reserved, never reused: field number 3 and the name found.

Usage

For an extension, the files form a package as described in Lua extension manifest. Install it by writing each file to its path below an extension directory.
For a preset, there is exactly one .stxpreset file.

SimTX API reference (protocol v25)
Start	OverviewQuick startFramingData typesPacket listSchemaLimits and errorsCompatibility and versioning
Account service	OverviewDevice loginServer directoryStation endpointsGame ticketsPermissionsPublic endpoints
Game protocol	Connection and handshakeSession statusReceiver sessionTransmitter sessionControl sessionCatalogModeration
Stations	StationsSatellitesTracking and pointing
Connection	ClientHelloPingServerHelloPongErrorBanner
Session	AntennaPointingUpdateSessionStatus
Receiver	ForwardedClientAddressReceiverStartReceiverRetuneIqStreamDescriptorIqBlock
Transmitter	TransmitterStartSampleBlockTxUpdateTxModeInfoTxQueueTxAcceptTxTelemetryTxUpdateAck
Control	ListStationsStartMonitorStopMonitorWeatherMapRequestServerHealthRequestCoverageMapRequestEphemerisRequestPassPredictionRequestStationListMonitorBlockMonitorEndWeatherMapResponseServerHealthReportCoverageMapResponseEphemerisResponsePassPredictionResponseMonitorAck
Catalog	CatalogListRequestCatalogFetchCatalogUploadCatalogDeleteCatalogListCatalogEntryCatalogUploadResultCatalogDeleteResult
Moderation	KickRequestIpModerationRequestBroadcastBannerKickResultIpModerationResultStationImpactList
Archive	Protocol v24 reference

@@ Line 1: / Line 1: @@
-#REDIRECT [[SimTX API v24/Packets/CatalogEntry]]
+{{SimTX API navigation}}
+{{SimTX packet
+| name = CatalogEntry
+| frame = ServerFrame
+| field = 37
+| member = catalog_entry
+| direction = s2c
+| session = [[SimTX API/Extension catalog protocol|Control (catalog)]]
+| roles = <code>ROLE_CONTROL</code>.
+| permission = None
+| answers = [[SimTX API/Packets/CatalogFetch|CatalogFetch]]
+| group = catalog
+| file = control.proto
+}}
+'''CatalogEntry''' returns the files of one catalog entry requested with [[SimTX API/Packets/CatalogFetch|CatalogFetch]]. An unknown entry is answered with [[SimTX API/Packets/Error|Error]] instead; the v24 <code>found</code> flag is gone.
+== Definition ==
+<syntaxhighlight lang="protobuf">
+message CatalogEntry {
+  reserved 3;
+  reserved "found";
+  int64 request_id = 1;
+  int32 entry_id = 2;
+  string kind = 4;
+  string name = 5;
+  int32 revision = 6;
+  repeated CatalogFile files = 7;
+}
+</syntaxhighlight>
+== Fields ==
+{| class="wikitable"
+! # !! Field !! Type !! Description
+|-
+| 1 || <code>request_id</code> || <code>int64</code> || The request this answers.
+|-
+| 2 || <code>entry_id</code> || <code>int32</code> || The entry ID.
+|-
+| 4 || <code>kind</code> || <code>string</code> || <code>extension</code> or <code>preset</code>.
+|-
+| 5 || <code>name</code> || <code>string</code> || Entry name.
+|-
+| 6 || <code>revision</code> || <code>int32</code> || Revision number.
+|-
+| 7 || <code>files</code> || <code>repeated</code> [[SimTX API/Data types#CatalogFile|CatalogFile]] || The entry's files, at most 1,000.
+|}
+Reserved, never reused: field number 3 and the name <code>found</code>.
+== Usage ==
+* For an extension, the files form a package as described in [[Lua extension manifest]]. Install it by writing each file to its path below an extension directory.
+* For a preset, there is exactly one <code>.stxpreset</code> file.
+== See also ==
+* [[SimTX API/Packets/CatalogFetch|CatalogFetch]]
+{{SimTX API navbox}}
+[[Category:SimTX API]]