Skip to content

Dplug Save Compatibility

Guillaume Piolat edited this page Nov 28, 2018 · 16 revisions

Dplug assumes plug-ins are using SemVer as version numbers.

Releasing a major version (version MAJOR.minor.patch)

  • update publicVersion in plugin.json
  • update pluginUniqueID in plugin.json
  • update vendorName in plugin.json to avoid overwriting previous version files

You can change anything in your plugin now, it's considered a separate plug-in by hosts, and can coexist with previous versions.

Releasing a minor version (version major.MINOR.patch)

All other versions are minor versions changes. Dplug assumes that you will keep save compatibility across minor/patch version changes.

  • You can't remove a Parameter
  • You can't remap a FloatParameter values, or add an option to an IntegerParameter, since it would break existing sessions. You can't change existing Parameter.
  • You can add a Parameter at the end of the list of parameters.
  • You can add presets (TBD what's allowed).

Such a plugin is considered the same than previous versions by hosts. Hence, you are not allowed to change save compatibility.