upgrading your zcx installation¶
To get access to the latest features and bugfixes, you should keep your zcx installation(s) up to date. If you use multiple zcx installations (for different controllers), you need to upgrade each install separately.
Danger
zcx is pre v1. This means it's very likely a new version will have breaking changes. 'Breaking changes' basically means that if you upgrade, your old config might rely on features that work differently now. You may even have to move, rename, or delete certain files to make your old config compatible.
To see if you are affected by any breaking changes, read the releases page on GitHub.
automatic upgrade¶
Starting from v0.5, you can use the Python script upgrade.py to get the latest release from GitHub.
This script will:
- backup your existing installation to
Remote Scripts/__zcx_backups__ - Download the newest release
- Replace all application code with the newest version
- Restore your configuration files
- Install or upgrade the zcx user action.
running the script¶
To run the script, you will need to download and install Python. Once you've done that, open a terminal or PowerShell window and navigate to your zcx installation, and run the script.
macOS
Windows
cd "\Users\<username>\Documents\Ableton\User Library\Remote Scripts\<your zcx folder>"
python upgrade.py
Note
The paths above are the defaults. You will need to modify them if your User Library is in a different location.