Editing SimTX Guide/Catalog and add-ons

{{SimTX Guide navigation}}
The '''Catalog''' tab lists the extensions and presets that SimTX users share on the server. Extensions written in Lua add modulations, audio add-ons, actions, themes and libraries to the app.

== Browse the catalog ==
[[File:SimTX Guide Catalog browse.png|thumb|center|800px|alt=Catalog tab with search, the All, Extensions and Presets filters, the Newest sort, a list of entries, and CW Beacon selected with Install, author DEMO2, version, revision, size, package ID, and the contents of init.lua.|The Catalog with a modulation selected, showing its details and its init.lua.]]
* Search by name, author or tag.
* Filter by '''All''', '''Extensions''' or '''Presets''', and sort by '''Newest''', '''Name''', '''Author''' or '''Largest'''.
* A tick marks what you have installed; '''Update''' marks an installed entry with a newer revision.

Select an entry to see its author, version, revision, size, package ID and requirements. '''Preview''' shows a preset's settings or a theme. '''Files''' lists its files; manifests can be shown as a '''Table''' or as '''Source'''.

== Install an extension ==
# Select the extension.
# Press '''Install''', or '''Update''' when a newer revision is available.

[[Lua extensions]] describes how installed extensions appear in the app.

== Use a preset ==
* '''Apply to Transmit''' or '''Apply to Receive''' loads the preset's settings.
* '''Save to my presets''' adds it to the '''Presets''' menu.

== Publish an extension ==
# Press '''Publish…'''.
# Press '''Choose folder…''' and choose the extension's folder.
# Enter a '''Name''', a one-line '''Description''' and up to 12 '''Tags''', separated by commas.
# Press '''Publish'''.

If the server refuses the upload, the dialog shows why and stays open. Publishing needs a sign-in with permission to publish. To take your entry down, select it and press '''Remove publication…'''.

== Audio add-ons ==
Audio add-ons process your transmit audio before it is sent.
# Press '''Add-ons''' in the status bar at the bottom of the window.
# Switch each add-on on or off, drag rows to change the order, and open an add-on's options with its options button.

The order applies the next time you press '''Start TX'''. '''Manage extensions…''' opens '''Settings''', '''Extensions'''.

== Actions ==
Actions are tools added by extensions.
# Press '''Actions''' in the status bar, or open the command palette (Ctrl+K or ⌘K) and type the action's name.
# Press '''Run''', or '''Run…''' for an action with settings, adjust them and press '''Run'''.

Ctrl+Shift+A (⌘⇧A) also runs an action.

== Manage extensions ==
'''Settings''', '''Extensions''' lists installed audio add-ons and actions.
* '''Reload''' loads changed extensions again.
* '''Open folder''' opens the extensions folder.
* '''Install examples''' installs the example extensions.

Problems loading an extension show at the top of this section.

== Write a package ==
[[File:SimTX Guide Catalog package editor.png|thumb|center|800px|alt=New package form with Name Band Notes, Version 1.0.0, ID org.example.bandnotes, Entry file init.lua, a description, Types with Action selected, a dependency on example.shared-math with Compatible (^) 1.0.0, and Create package.|A new package in Settings, Developer, with its details and one dependency.]]
'''Settings''', '''Developer''' is a workspace for your own packages.
# Press '''New package…'''.
# Under '''Details''', enter the '''Name''', '''Version''', '''ID''' (like <code>com.example.mypack</code>), '''Entry file''' and '''Description''', and choose the '''Types'''.
# Add '''Dependencies''' with a version rule: '''Compatible (^)''', '''Patch updates (~)''', '''At least (>=)''', '''Exactly''' or '''Any version'''. Library packages also list '''Exports'''.
# Press '''Create package'''.
# Add and edit files in the file list. '''Save''' writes a file; '''Revert''' drops your changes.
# In '''Settings''', '''Extensions''', press '''Reload''' to try it.

'''Local packages''' lists your packages with '''Edit''' and '''Delete…'''. [[Creating Lua extensions]] explains how to write one, and [[Lua extension manifest]] describes the details fields.

[[Category:SimTX Guide]]