Controlling zcx from ClyphX Pro¶

zcx ships with a suite of user actions for ClyphX Pro that allow you to control a zcx script from ClyphX. This means an individual script can be interacted with via any X-Trigger, such as an X-Clip, or an X-Control bound to another controller.

Installing the user action¶

zcx downloads include a folder named _user_actions. Simply drag the contents of this folder into the ClyphX Pro user actions folder. The location of this folder is .../Ableton/User Library/Remote Scripts/_user_actions. If this folder doesn't exist, create it.

Using the action¶

Usage of the zcx action is like so:

ZCX <target script> <command type> <command definition>

E.g.

ZCX zcx_push_1 PAGE NEXT

ZCX 2 MODE TGL SHIFT

Targeting a script¶

The zcx action requires a specific script to be targeted. You may target by either script name or slot number.

By name¶

ZCX zcx_push_1 PAGE NEXT

This is the name of the folder containing the zcx script (similar to as seen in Live’s preferences) with any leading underscores removed. E.g. a script in a folder called _my_zcx_script (shown as my zcx script in Live’s prefs) is targeted like ZCX my_zcx_script. If you change the name of the script (by renaming its folder), you will need to update every ClyphX action list that uses the old name.

By number¶

ZCX 2 MODE TGL SHIFT

This is the number of the control surface script slot the zcx script resides in. If you move this script to another slot, you will need to update every ClyphX action list that uses the old number.

Target all scripts¶

ZCX ALL REFRESH

Apply the command to all zcx scripts.

Available commands¶

PAGE¶

Activate a particular page by name or number.

ZCX <target script> PAGE 0

ZCX <target script> PAGE my_cool_page

Or cycle through pages.

ZCX <target script> PAGE NEXT

ZCX <target script> PAGE PREV

MODE¶

Enable, disable, or toggle a zcx mode.

ZCX <target script> MODE ON SHIFT

ZCX <target script> MODE OFF SHIFT

ZCX <target script> MODE TGL SHIFT

OVERLAY¶

Enable, disable, or toggle an overlay.

ZCX <target script> OVERLAY ON my_overlay

ZCX <target script> OVERLAY OFF my_overlay

ZCX <target script> OVERLAY TGL my_overlay

BIND¶

Manually re-bind a zcx encoder or param control to a new target. This works much the same as the ClyphX Pro BIND action.

If binding an encoder, control name is the same one you'd use in encoders.yaml. If binding a named control, control name must be the name from named controls.yaml or the control's alias if one exists. If binding a matrix control, it must have an alias, which you will use for control name.

For valid mapping targets, see Encoder Reference or Control Reference for param controls. The entire mapping target must be wrapped in double-quotes.

Quotes within mapping targets

A special syntax is required when using double-quotes within your mapping target, e.g. "my track" / VOL. You must replace all instances of the double-quote character (") with a backtick (`).

The mapping target "my track" / DEV("my device") P1 becomes "`my track` / DEV(`my device`) P1"

The backtick key is below the escape key.

Warning

This binding is temporary: if the control rebinds itself due to a mode change it will never rebind to a target set by this action. For a more permanent solution, see below.

ZCX <target script> BIND <control name> "<mapping target>"

ZCX zcx_push_1 BIND enc_3 "SEL / PAN"

ZCX zcx_launchpad_x BIND enc_1 "`my track` / DEV(`my device`) P1"

BIND_`mode`¶

Same as above, but overrides an existing mapping target permanently, and allows targeting certain modes.

ZCX <target script> BIND_<mode> <control name> "<mapping target>"

ZCX zcx_push_1 BIND_default my_button "SEL / PAN"

ZCX zcx_launchpad_x BIND_shift__select enc_1 "SEL / DEV(1) P1"

KB¶

Control settings related to the keyboard view.

MSG¶

Only on Push 1

Write a message to the controller's display. The message must be enclosed in double-quotes.

ZCX <target script> MSG "hello there"

HW_MODE¶

Set the controller to either 'Live' or zcx mode.

ZCX <target script> HW_MODE live

ZCX <target script> HW_MODE zcx

REFRESH¶

Force a refresh of all controller feedback.

ZCX <target script> REFRESH

Color commands¶

These commands allow you to set the color on an individual control by alias, as well as across an entire section or group of controls. Allowable color values are an int or a named color.

set_color¶

Set the color of a named or aliased control.

ZCX <target script> SET_COLOR my_control 124

ZCX <target script> SET_COLOR record red

set_on_color, set_off_color¶

As above, but sets on/off or active/inactive colors. Only available on controls with such feedback, including the param control, page control and others.

ZCX <target script> SET_ON_COLOR record green

ZCX <target script> SET_OFF_COLOR record 0

set_section_color¶

Set the color of every control in a matrix section.

ZCX <target script> SET_SECTION_COLOR actions_bottom_right cyan

set_group_color¶

Set the color of every control in a group of controls.

ZCX <target script> SET_GROUP_COLOR scene_buttons 127

HOT_RELOAD¶

Perform a hot reload.

ZCX <target script> HOT_RELOAD