Arcane Desktop is currently early-access!

Command System

Arcane has a command system that allows for users to control it externally (e.g. via MIDI or OSC), and this reference provides a comprehensive list of available commands for the latest version of Arcane.

For detailed guidance on how to use these commands for specific inputs, see:

MIDI Inputs

The commands available in the version of arcane you are running may differ, and an offline reference is available by going to Help & Docs -> Command Reference from within the app.

A few important things to bear in mind:

Feedback: In most cases, commands are a 2-way communication mechanism, allowing for the current state of a particular command to be fed back to the controlling device (e.g. MIDI controllers). But not all commands will have feedback, and some commands may only provide feedback and not accept input (such as layer visualizers).
Device Context: Each device connected to Arcane's command system has its own context, including whether shift/command is pressed, and the current page or position being displayed.

This context can be manipulated by commands, for example to assign next/previous page buttons, or assign a fader to scroll the position within the page. By default these commands will modify the state of the respective device only.

However, it is possible for one device to adjust the context of another connected device, using the /device/<UUID> command prefix, see more below.
Testing / Monitoring: You can open the monitoring window for any connected input device to observe the commands being received, and identify any issues with incorrect commands.
OSC: External control via OSC is currently under development and not yet supported, but it will use these same commands when available.

Complete Reference

Note: The full list of commands available in the version of Arcane Desktop that you have installed can also be found by going to Help & Docs -> Command Reference from within the app, and can even be viewed offline.

/casting/output-groups/<output group>/blackout

Toggle blackout for the specified output group

Parameters:

<output group>: An integer starting from 0 - The column number of the output group from the Spell Casting window that you want to control. As you navigate left or right, this parameter will be adjusted accordingly, allowing you to build-up a navigable grid on your device.

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Toggles blackout for the output group
Absolute Numeric Value (0-1): If the number is greater than 0, it will toggle the blackout for the output group

Feedback:

This command will send the following feedback

Mode: Ready: When the output group is not currently in blackout mode.
Mode: Active: When the output group is currently in blackout mode.
Mode: Empty: When there is no output group configured for the current index, or you have scrolled right past the last output group.

/casting/output-groups/<output group>/blackout/hold

Hold to keep the output group in blackout. Appropriate for assigning to MIDI buttons when you want to maintain blackout only while the button is pressed.

Parameters:

<output group>: An integer starting from 0 - The column number of the output group from the Spell Casting window that you want to control. As you navigate left or right, this parameter will be adjusted accordingly, allowing you to build-up a navigable grid on your device.

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Enables blackout for the output group
Note OFF / Trigger OFF / FALSE: Disables blackout, and returns the output group to normal mode
Absolute Numeric Value (0-1): If the number is greater than 0, it will enable blackout for the output group, otherwise it will disable it, returning to normal mode

Feedback:

This command will send the following feedback

Mode: Ready: When the output group is not currently in blackout mode.
Mode: Active: When the output group is currently in blackout mode.
Mode: Empty: When there is no output group configured for the current index, or you have scrolled right past the last output group.

/casting/output-groups/<output group>/lock-min

Toggle locking this output group to its minimum intensity

Parameters:

<output group>: An integer starting from 0 - The column number of the output group from the Spell Casting window that you want to control. As you navigate left or right, this parameter will be adjusted accordingly, allowing you to build-up a navigable grid on your device.

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Toggles min for the output group
Absolute Numeric Value (0-1): If the number is greater than 0, it will toggle the min for the output group

Feedback:

This command will send the following feedback

Mode: Ready: When the output group is not currently in min mode.
Mode: Active: When the output group is currently in min mode.
Mode: Empty: When there is no output group configured for the current index, or you have scrolled right past the last output group.

/casting/output-groups/<output group>/lock-min/hold

Hold to keep this output group locked to its minimum intensity. Appropriate for assigning to MIDI buttons when you want to maintain the lock only while the button is pressed.

Parameters:

<output group>: An integer starting from 0 - The column number of the output group from the Spell Casting window that you want to control. As you navigate left or right, this parameter will be adjusted accordingly, allowing you to build-up a navigable grid on your device.

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Enables min for the output group
Note OFF / Trigger OFF / FALSE: Disables min, and returns the output group to normal mode
Absolute Numeric Value (0-1): If the number is greater than 0, it will enable min for the output group, otherwise it will disable it, returning to normal mode

Feedback:

This command will send the following feedback

Mode: Ready: When the output group is not currently in min mode.
Mode: Active: When the output group is currently in min mode.
Mode: Empty: When there is no output group configured for the current index, or you have scrolled right past the last output group.

/casting/output-groups/<output group>/lock-max

Toggle locking this output group to its maximum intensity

Parameters:

<output group>: An integer starting from 0 - The column number of the output group from the Spell Casting window that you want to control. As you navigate left or right, this parameter will be adjusted accordingly, allowing you to build-up a navigable grid on your device.

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Toggles max for the output group
Absolute Numeric Value (0-1): If the number is greater than 0, it will toggle the max for the output group

Feedback:

This command will send the following feedback

Mode: Ready: When the output group is not currently in max mode.
Mode: Active: When the output group is currently in max mode.
Mode: Empty: When there is no output group configured for the current index, or you have scrolled right past the last output group.

/casting/output-groups/<output group>/lock-max/hold

Hold to keep this output group locked to its maximum intensity. Appropriate for assigning to MIDI buttons when you want to maintain the lock only while the button is pressed.

Parameters:

<output group>: An integer starting from 0 - The column number of the output group from the Spell Casting window that you want to control. As you navigate left or right, this parameter will be adjusted accordingly, allowing you to build-up a navigable grid on your device.

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Enables max for the output group
Note OFF / Trigger OFF / FALSE: Disables max, and returns the output group to normal mode
Absolute Numeric Value (0-1): If the number is greater than 0, it will enable max for the output group, otherwise it will disable it, returning to normal mode

Feedback:

This command will send the following feedback

Mode: Ready: When the output group is not currently in max mode.
Mode: Active: When the output group is currently in max mode.
Mode: Empty: When there is no output group configured for the current index, or you have scrolled right past the last output group.

/casting/output-groups/<output group>/min

Adjust the minimum intensity for this output group

Parameters:

<output group>: An integer starting from 0 - The column number of the output group from the Spell Casting window that you want to control. As you navigate left or right, this parameter will be adjusted accordingly, allowing you to build-up a navigable grid on your device.

Behavior:

This command will respond to the following values, any other values will be ignored.

Absolute Numeric Value (0-1): Sets the min for the output group to the given value, between 0 and 1
Incremental Rotational Adjustment (e.g. endless encoder): Adjusts the min for the output group as a percentage based on the number of degrees rotated (360 degrees = full)

Feedback:

This command will send the following feedback

Mode: Ready: When the value of min is 0
Mode: Active: When the value of min is greater than 0
Mode: Empty: When there is currently no output group configured for the current index, or you have scrolled right past the last output group.

/casting/output-groups/<output group>/max

Adjust the maximum intensity for this output group

Parameters:

<output group>: An integer starting from 0 - The column number of the output group from the Spell Casting window that you want to control. As you navigate left or right, this parameter will be adjusted accordingly, allowing you to build-up a navigable grid on your device.

Behavior:

This command will respond to the following values, any other values will be ignored.

Absolute Numeric Value (0-1): Sets the intensity for the output group to the given value, between 0 and 1
Incremental Rotational Adjustment (e.g. endless encoder): Adjusts the intensity for the output group as a percentage based on the number of degrees rotated (360 degrees = full)

Feedback:

This command will send the following feedback

Mode: Ready: When the value of intensity is 0
Mode: Active: When the value of intensity is greater than 0
Mode: Empty: When there is currently no output group configured for the current index, or you have scrolled right past the last output group.

/casting/layers/<layer index>

Link the feedback for the current layer's visualizer. As events occur for this layer, connected devices will flash accordingly, like the visualizer on the Spell Casting screen itself.

Parameters:

<layer index>: An integer starting from 0 - The row number of the layer from the Spell Casting window that you want to control. As you navigate up or down, or change pages, this parameter will be adjusted accordingly, allowing you to build-up a navigable grid on your device.

Behavior: This command does not respond to any values, it provides feedback only.

Feedback:

This command will send the following feedback

Mode: Empty: When there is currently no layer available at the current index, or you have scrolled down past the last layer.
Mode: Ready: When there is a layer available at the current index.
Mode: Active: When there is an event currently active on the layer
Color: This will be the color of the current layer, but will flash white as events occur

/casting/layers/<layer index>/link/<output group>

Toggle the link between the associated layer and output group

Parameters:

<layer index>: An integer starting from 0 - The row number of the layer from the Spell Casting window that you want to control. As you navigate up or down, or change pages, this parameter will be adjusted accordingly, allowing you to build-up a navigable grid on your device.
<output group>: An integer starting from 0 - The column number of the output group from the Spell Casting window that you want to control. As you navigate left or right, this parameter will be adjusted accordingly, allowing you to build-up a navigable grid on your device.

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Toggle the link on/off.

Feedback:

This command will send the following feedback

Mode: Empty: When there is currently no layer available at the current index, there is no output group configured at the current index, or you have scrolled past the last layer or output group.
Mode: Ready: When it is possible to link the respective layer and output group.
Mode: Active: When the respective layer and output group are already linked
Color: When unlinked, this will be the color of the current layer, and it will be white when linked

/casting/navigate/up

Scroll up on the current device (within appropriate limits)

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Scroll up a single row, this will not do anything if you are already at the top for this device.
Absolute Numeric Value (0-1): Scroll y to the position specified between 0 - 1, where 0 is the bottom and 1 is the top.
Incremental Adjustment (steps, e.g. +1, -1): Scroll up once for every step. When a negative step is provided, it will scroll down instead.

Feedback:

This command will send the following feedback

Mode: Ready: When it's possible to scroll up on the current device.
Mode: Empty: When you are at the top for the current device already.

/casting/navigate/down

Scroll down on the current device (within appropriate limits)

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Scroll down a single row, this will not do anything if you are already at the bottom for this device.
Absolute Numeric Value (0-1): Scroll y to the position specified between 0 - 1, where 0 is the top and 1 is the bottom.
Incremental Adjustment (steps, e.g. +1, -1): Scroll down once for every step. When a negative step is provided, it will scroll up instead.

Feedback:

This command will send the following feedback

Mode: Ready: When it's possible to scroll down on the current device.
Mode: Empty: When you are at the bottom for the current device already.

/casting/navigate/left

Scroll left on the current device (within appropriate limits)

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Scroll left a single column, this will not do anything if you are already at the leftmost position for this device.
Absolute Numeric Value (0-1): Scroll x to the position specified between 0 - 1, where 0 is the rightmost and 1 is the leftmost.
Incremental Adjustment (steps, e.g. +1, -1): Scroll left once for every step. When a negative step is provided, it will scroll right instead.

Feedback:

This command will send the following feedback

Mode: Ready: When it's possible to scroll left on the current device.
Mode: Empty: When you are at the leftmost position for the current device already.

/casting/navigate/right

Scroll right on the current device (within appropriate limits)

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Scroll right a single column, this will not do anything if you are already at the rightmost position for this device.
Absolute Numeric Value (0-1): Scroll x to the position specified between 0 - 1, where 0 is the rightmost and 1 is the leftmost.
Incremental Adjustment (steps, e.g. +1, -1): Scroll right once for every step. When a negative step is provided, it will scroll left instead.

Feedback:

This command will send the following feedback

Mode: Ready: When it's possible to scroll right on the current device.
Mode: Empty: When you are at the rightmost position for the current device already.

/casting/navigate/next

Go to the next page on the current device (within appropriate limits)

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Go to the next page, this will not do anything if you are already at the last page for this device.
Absolute Numeric Value (0-1): Set the page to the position specified between 0 - 1, where 0 is the first page and 1 is the last page.
Incremental Adjustment (steps, e.g. +1, -1): Go to the next page once for every step. When a negative step is provided, it will go to the previous page instead.

Feedback:

This command will send the following feedback

Mode: Ready: When it's possible to go to the next page on the current device.
Mode: Empty: When you are at the last page for the current device already.

/casting/navigate/previous

Go to the previous page on the current device (within appropriate limits)

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Go to the previous page, this will not do anything if you are already at the first page for this device.
Absolute Numeric Value (0-1): This adjusts your page in reverse order. Set the page to the position specified between 0 - 1, where 0 is the last page and 1 is the first page.
Incremental Adjustment (steps, e.g. +1, -1): Go to the previous page once for every step. When a negative step is provided, it will go to the next page instead.

Feedback:

This command will send the following feedback

Mode: Ready: When it's possible to go to the previous page on the current device.
Mode: Empty: When you are at the first page for the current device already.

/device/<device UUID>/casting/navigate/up

Scroll up on the current device (within appropriate limits)

Parameters:

<device UUID>: The unique identifier (UUID) of the device you want to run the command in the context of.

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Scroll up a single row, this will not do anything if you are already at the top for this device.
Absolute Numeric Value (0-1): Scroll y to the position specified between 0 - 1, where 0 is the bottom and 1 is the top.
Incremental Adjustment (steps, e.g. +1, -1): Scroll up once for every step. When a negative step is provided, it will scroll down instead.

Feedback:

This command will send the following feedback

Mode: Ready: When it's possible to scroll up on the current device.
Mode: Empty: When you are at the top for the current device already.

/device/<device UUID>/casting/navigate/down

Scroll down on the current device (within appropriate limits)

Parameters:

<device UUID>: The unique identifier (UUID) of the device you want to run the command in the context of.

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Scroll down a single row, this will not do anything if you are already at the bottom for this device.
Absolute Numeric Value (0-1): Scroll y to the position specified between 0 - 1, where 0 is the top and 1 is the bottom.
Incremental Adjustment (steps, e.g. +1, -1): Scroll down once for every step. When a negative step is provided, it will scroll up instead.

Feedback:

This command will send the following feedback

Mode: Ready: When it's possible to scroll down on the current device.
Mode: Empty: When you are at the bottom for the current device already.

/device/<device UUID>/casting/navigate/left

Scroll left on the current device (within appropriate limits)

Parameters:

<device UUID>: The unique identifier (UUID) of the device you want to run the command in the context of.

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Scroll left a single column, this will not do anything if you are already at the leftmost position for this device.
Absolute Numeric Value (0-1): Scroll x to the position specified between 0 - 1, where 0 is the rightmost and 1 is the leftmost.
Incremental Adjustment (steps, e.g. +1, -1): Scroll left once for every step. When a negative step is provided, it will scroll right instead.

Feedback:

This command will send the following feedback

Mode: Ready: When it's possible to scroll left on the current device.
Mode: Empty: When you are at the leftmost position for the current device already.

/device/<device UUID>/casting/navigate/right

Scroll right on the current device (within appropriate limits)

Parameters:

<device UUID>: The unique identifier (UUID) of the device you want to run the command in the context of.

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Scroll right a single column, this will not do anything if you are already at the rightmost position for this device.
Absolute Numeric Value (0-1): Scroll x to the position specified between 0 - 1, where 0 is the rightmost and 1 is the leftmost.
Incremental Adjustment (steps, e.g. +1, -1): Scroll right once for every step. When a negative step is provided, it will scroll left instead.

Feedback:

This command will send the following feedback

Mode: Ready: When it's possible to scroll right on the current device.
Mode: Empty: When you are at the rightmost position for the current device already.

/device/<device UUID>/casting/navigate/next

Go to the next page on the current device (within appropriate limits)

Parameters:

<device UUID>: The unique identifier (UUID) of the device you want to run the command in the context of.

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Go to the next page, this will not do anything if you are already at the last page for this device.
Absolute Numeric Value (0-1): Set the page to the position specified between 0 - 1, where 0 is the first page and 1 is the last page.
Incremental Adjustment (steps, e.g. +1, -1): Go to the next page once for every step. When a negative step is provided, it will go to the previous page instead.

Feedback:

This command will send the following feedback

Mode: Ready: When it's possible to go to the next page on the current device.
Mode: Empty: When you are at the last page for the current device already.

/device/<device UUID>/casting/navigate/previous

Go to the previous page on the current device (within appropriate limits)

Parameters:

<device UUID>: The unique identifier (UUID) of the device you want to run the command in the context of.

Behavior:

This command will respond to the following values, any other values will be ignored.

Note ON / Trigger ON / TRUE: Go to the previous page, this will not do anything if you are already at the first page for this device.
Absolute Numeric Value (0-1): This adjusts your page in reverse order. Set the page to the position specified between 0 - 1, where 0 is the last page and 1 is the first page.
Incremental Adjustment (steps, e.g. +1, -1): Go to the previous page once for every step. When a negative step is provided, it will go to the next page instead.

Feedback:

This command will send the following feedback

Mode: Ready: When it's possible to go to the previous page on the current device.
Mode: Empty: When you are at the first page for the current device already.

Can't find what you're looking for in the docs? Join the official discord to share your feedback and get support!Join the Discord