API versions & changelog

​

Current API versions

​

Compatibility model

{
  "name": "my-plugin",
  "id": "my-plugin-id",
  "version": "1.0.0",
  "moduleApiVersion": "2.1.0"
}

1. Exact match or minor version updates: The host loads the plugin if its requested API version is equal to or lower than the host’s supported version (within the same major version).
2. Major version mismatch: If the plugin requires a higher major API version than the host supports, the host disables the plugin and notifies the user with a compatibility warning.
3. Missing version fields: If the plugin configuration does not specify an API version, it defaults to legacy compatibility mode and may run with limited API features.

​

Configuring semver ranges

​

Easy semver guide

• Caret ^ (Recommended): Matches the major version. Allows safe updates.
  • Example: "^2.0.0" works with 2.0.0, 2.1.0, and all 2.x.x versions. It will not work with 3.0.0.
• Tilde ~ (Strict): Matches the major and minor version. Only allows patch fixes.
  • Example: "~2.1.0" works with 2.1.0 and 2.1.1. It will not work with 2.2.0.
• Exact version (Strict): Requires the exact version number.
  • Example: "2.1.0" only works with 2.1.0.

​

Example configuration

​

For a module:

{
  "versions": [
    {
      "version": "1.2.0",
      "commit": "abcdef1234567890abcdef1234567890abcdef12",
      "engines": {
        "moduleApi": "^2.1.0"
      },
      "stage": "public",
      "platforms": ["win32", "linux", "darwin"]
    }
  ]
}

​

For an extension:

{
  "versions": [
    {
      "version": "1.0.0",
      "commit": "1234567890abcdef1234567890abcdef12345678",
      "engines": {
        "extensionApi": "^2.0.0"
      },
      "stage": "public",
      "platforms": ["win32"]
    }
  ]
}

​

API changelogs

​

Version 3.5.0

​

Modules (API 2.1.0)

• Bumped moduleApiVersion to 2.1.0.
• Added the supportCustomArguments configuration flag to let modules explicitly enable or disable custom argument UI rendering.
• Integrated Alert UI feedback support across most module execution steps.

​

Extensions (API 2.0.0)

• Bumped extensionApiVersion to 2.0.0.
• Enabled extensions to dynamically inject positional cards directly into the Tools and Games pages.
• Enabled extensions to dynamically intercept and listen to any IPC event (running callbacks before and after calls) across both main and renderer processes.
• Replaced the legacy IPC implementation with a unified IPC handler system, passed to both main and renderer entrypoints.
• Added API support to trigger modals directly from card dropdown menus.