Extension catalog: Difference between revisions
Add and update user documentation for Lua extensions and the catalog |
Rework documentation for new users: illustrated steps, clear navigation, preserved technical references, and current 0.3.6 behavior |
||
| Line 1: | Line 1: | ||
{{Documentation navigation}} | |||
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. | 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. | ||
== Choose between a package and a preset == | |||
* An '''extension''' adds a mode, processor, tool, theme, or library. | |||
* A '''station preset''' fills in transmitter settings. Applying one can change frequency, source, power, location, and antenna together. | |||
For first use, find an item, select '''Preview Selected''', then follow the appropriate installation steps below. Preview alone does not install it. After applying a preset, check the frequency and any local file paths before pressing Start TX. | |||
Catalog access uses the current server connection. Publishing uses your signed-in SimTX account and requires the applicable publication permission. | |||
== Browsing == | == Browsing == | ||
| Line 25: | Line 36: | ||
== Publishing == | == Publishing == | ||
Publishing requires | Publishing requires catalog publication permission on the signed-in SimTX account. The current client uses its authenticated control connection. Older clients used a Discord <code>/link</code> token in a Token field; that field is not part of the 0.3.6 workflow. | ||
To publish an extension: | To publish an extension: | ||
Revision as of 21:21, 13 September 2026
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.
Choose between a package and a preset
- An extension adds a mode, processor, tool, theme, or library.
- A station preset fills in transmitter settings. Applying one can change frequency, source, power, location, and antenna together.
For first use, find an item, select Preview Selected, then follow the appropriate installation steps below. Preview alone does not install it. After applying a preset, check the frequency and any local file paths before pressing Start TX.
Catalog access uses the current server connection. Publishing uses your signed-in SimTX account and requires the applicable publication permission.
Browsing
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.
Each entry displays its types, categories, name, package version, catalog revision, author, description, file count, size, and update time.
Preview Selected downloads the entry and shows its metadata, folder tree, file paths, and complete file contents. Previewing does not install the item.
Installing an extension
- Select an extension and choose Install Selected.
- If required packages are missing, review the dependency list and continue.
- Review each package's files in the installation preview.
- Select Install.
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.
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.
Installing a preset
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.
Safety and review
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.
Publishing
Publishing requires catalog publication permission on the signed-in SimTX account. The current client uses its authenticated control connection. Older clients used a Discord /link token in a Token field; that field is not part of the 0.3.6 workflow.
To publish an extension:
- Open Catalog.
- Select Share Extension Folder....
- Choose a package folder containing extension.properties.
- Enter the catalog name and description.
- Select existing community categories or enter new comma-separated categories.
- Confirm the upload.
To publish the current transmitter setup, select Share Current Settings... instead. No preset file needs to be created first.
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 .stxpreset file. Catalog packages may contain at most 64 files, with a maximum of 60 KiB per file.
Revisions and editing
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.
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.