https://wiki.simtx.net/index.php?action=history&feed=atom&title=Extension_catalogExtension catalog - Revision history2026-08-06T11:10:51ZRevision history for this page on the wikiMediaWiki 1.43.9https://wiki.simtx.net/index.php?title=Extension_catalog&diff=572&oldid=prevClanker: Add and update user documentation for Lua extensions and the catalog2026-08-06T09:12:27Z<p>Add and update user documentation for Lua extensions and the catalog</p>
<p><b>New page</b></p><div>The '''extension catalog''' is a collection of Lua extension packages and transmitter presets shared through the connected SimTX server. It is opened with the '''Catalog''' button in the transmitter footer.<br />
<br />
== Browsing ==<br />
The catalog can be searched by name, author, description, package ID, version, type, and category. Separate filters select an extension type or community category. Results may be sorted by update time, name, author, size, type, or category.<br />
<br />
Each entry displays its types, categories, name, package version, catalog revision, author, description, file count, size, and update time.<br />
<br />
'''Preview Selected''' downloads the entry and shows its metadata, folder tree, file paths, and complete file contents. Previewing does not install the item.<br />
<br />
== Installing an extension ==<br />
# Select an extension and choose '''Install Selected'''.<br />
# If required packages are missing, review the dependency list and continue.<br />
# Review each package's files in the installation preview.<br />
# Select '''Install'''.<br />
<br />
The package is checked before installation and is then loaded without restarting the transmitter. An installed package appears in the '''Extensions''' window. Loading errors appear in its '''Problems''' tab.<br />
<br />
Catalog-installed extensions retain their catalog identity and revision. When the client reconnects and a newer revision is available, it downloads, checks, and installs the new revision automatically. Locally created packages without catalog identity are not affected.<br />
<br />
== Installing a preset ==<br />
A preset entry contains a complete transmitter station configuration. After installation it appears in the '''Presets''' menu. The application offers to apply it immediately. Presets are not updated automatically because a revision could change the operator's active settings.<br />
<br />
== Safety and review ==<br />
Installation always presents the exact files before they are written. Extension paths, manifest data, declared types, dependencies, Lua syntax, and package contents are checked again by the client. Community Lua runs with the restricted capabilities described in [[Lua extensions]].<br />
<br />
== Publishing ==<br />
Publishing requires a personal access token with catalog upload permission. The token is obtained with the Discord bot's <code>/link</code> command and is entered in the transmitter's '''Token''' field.<br />
<br />
To publish an extension:<br />
# Open '''Catalog'''.<br />
# Select '''Share Extension Folder...'''.<br />
# Choose a package folder containing [[Lua extension manifest|extension.properties]].<br />
# Enter the catalog name and description.<br />
# Select existing community categories or enter new comma-separated categories.<br />
# Confirm the upload.<br />
<br />
To publish the current transmitter setup, select '''Share Current Settings...''' instead. No preset file needs to be created first.<br />
<br />
A publication may have at most 12 categories, and each category name may contain at most 32 characters. An extension publication contains its manifest and Lua files. A preset publication contains one <code>.stxpreset</code> file. Catalog packages may contain at most 64 files, with a maximum of 60 KiB per file.<br />
<br />
== Revisions and editing ==<br />
A new catalog name begins at revision 1. Only its original author may publish later revisions under that name. The catalog entry retains its identity and increments its revision number.<br />
<br />
The author may select an entry and choose '''Edit Publication'''. The editor permits changes to the description, categories, and file contents, or replacement of the complete source folder or preset file. The proposed files are validated before the new revision is published.<br />
<br />
== Related pages ==<br />
* [[Lua extensions]]<br />
* [[Creating Lua extensions]]<br />
* [[Radio Presets]]<br />
<br />
[[Category:Lua extensions]]</div>Clanker