SimTX Guide/Catalog and add-ons

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

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

1. Select the extension.
2. 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

1. Press Publish….
2. Press Choose folder… and choose the extension's folder.
3. Enter a Name, a one-line Description and up to 12 Tags, separated by commas.
4. 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.

1. Press Add-ons in the status bar at the bottom of the window.
2. 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.

1. Press Actions in the status bar, or open the command palette (Ctrl+K or ⌘K) and type the action's name.
2. 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

A new package in Settings, Developer, with its details and one dependency.

Settings, Developer is a workspace for your own packages.

1. Press New package….
2. Under Details, enter the Name, Version, ID (like com.example.mypack), Entry file and Description, and choose the Types.
3. Add Dependencies with a version rule: Compatible (^), Patch updates (~), At least (>=), Exactly or Any version. Library packages also list Exports.
4. Press Create package.
5. Add and edit files in the file list. Save writes a file; Revert drops your changes.
6. 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.