Module Management Page

Module Management Page

Sync Engine uses a native Obsidian settings page to manage executable modules from configured sources. Open it from Module management.

Page Layout

ModuleManagement extends Obsidian's SettingPage. Its page contains:

  • a full-width search field;
  • an icon button that opens a menu with the Show installed only toggle and Install module from file;
  • a Solid.js module-card list.

Module source URLs are edited separately on Settings > Sync Engine > Development > Module sources. Returning to Module management creates a new source snapshot and refreshes the catalog.

The search field uses Obsidian's SearchComponent. An empty query sorts modules alphabetically. A non-empty query uses prepareFuzzySearch() against module names and descriptions, then sorts by match score and name.

Install module from file opens a file picker that only accepts .js files; other extensions are rejected with a notice. The chosen file opens the module editor with metadata prefilled from the file's magic bytes, see extensibility: install from file.

Module Cards

Each card displays the module icon, name, version, source status, description, and available actions:

  • Download installs a module that is not installed or has a newer advertised version.
  • README opens the module's README page when its metadata provides one.
  • Edit opens the module metadata and integrity settings.
  • Delete removes the installed module and its stored metadata.
  • Enable stores enabled: true and loads the module.
  • Disable unloads the module and stores enabled: false.

Actions are disabled while another action for the same module is running. Running actions display a progress icon. Module cards are merged by module ID, with installed metadata taking precedence over source metadata.

Source And Compatibility State

fetchSources() reads every configured source. Source responses are cached for automatic update checks and can be forced to refresh for manual operations. Duplicate IDs within a source are ignored.

If a source entry declares a minPluginVersion newer than the running plugin, the catalog marks the plugin as outdated. Update Sync Engine before installing modules that require the newer version.

Newly downloaded modules are disabled by default. Automatic updates only apply to already-installed modules whose recorded source URL matches the advertised source URL.

All content licensed under the CC BY 4.0 License.