Tip: Loading ClyphX Pro from another script

[Stray]

Most Control Surface scripts can easily be retrofitted to either load the ClyphX Pro library or to load a component that allows the script to have its own X-Controls. In this way, you can access the functionality of the ClyphX Pro library without having to use up Control Surface slots for either ClyphX Pro or ClyphX XT scripts.

The retrofitting procedure is non-invasive (no permanent changes are made to scripts), can always be undone, does not require any programming knowledge at all and does not require having access to the source code of scripts. We provide the files you need and you just have to follow some simple instructions.

There is one slightly technical note that you should be aware of however. Retrofitting works on a first-come-first-serve basis. The first retrofitted script will load the ClyphX Pro library and each additional retrofitted script will load a component that allows the script to have X-Controls. This is important to understand as it determines where X-Control-related settings files will be loaded from. For the script that loads the ClyphX Pro library, its X-Controls settings will be loaded from X-Controls.txt in the root ClyphX_Pro settings folder. For subsequent scripts, X-Controls settings will be loaded from X-Controls.txt in ClyphX_Pro/XTx where x is the name of the script.

On a related note, if you'll be using the standalone ClyphX_Pro script while retrofitting other scripts, the standalone ClyphX_Pro script must be selected in a Control Surface slot above all other retrofitted scripts.

Additionally, the rules for X-Controls are the same as is covered in the ClyphX Pro User Manual. Specifically, the script you're retrofitting should either not use X-Controls or the MIDI messages used for X-Controls should not be the same as MIDI messages the script itself uses.

There are slightly different procedures for conventional Control Surface scripts, which reside in Live's MIDI Remote Scripts directory, and for User Remote Scripts. The following posts will cover the procedure for each.

In both cases, you will need to locate Live's MIDI Remote Scripts directory:

• On Windows, go to ProgramData\Ableton\Live x\Resources\MIDI Remote Scripts
• On OS X, go to Applications, find the Live x.app, Control-click or right click on it and select Show Package Contents. Then go to Contents/App-Resources/MIDI Remote Scripts

Please close Live before proceeding.

[Stray]

Retrofitting existing Control Surface scripts:

• Locate the folder of the script to retrofit in Live's MIDI Remote Scripts directory.
• In the script's folder, find the file named __init__.pyc and rename it to original__init__.pyc. So you're just adding the word original to the beginning of the file's name.
• Paste the following file into the script's folder and restart Live.
  __init__.py (3.31 KB)
  

Undoing the retrofit:

• Delete the files named __init__.py and __init__pyc.
• Rename original__init__.pyc back to __init__.pyc. So you're just removing the word original from the beginning of the file's name.

Notes: At present, the Push and Push2 Control Surface scripts cannot be retrofitted. Additionally, the following legacy scripts cannot be retrofitted: Axiom, FireOne, LV1_LX1, LV2_LX2_LC2_LD2, MackieControl, MackieControlXT, MackieControl_Classic, MasterControl, Nocturn, ProjectMixIO, RemoteSL, RemoteSL_Classic and Tranzport.

[Stray]

User Remote Scripts are actually just one script that can be configured in different ways based on configuration files. So the following procedure will apply to all User Remote Scripts., but can de disabled for specific scripts if you so choose as covered below.

Retrofitting User Remote Scripts:

• Locate the folder of the script to retrofit in Live's User Remote Scripts directory. This article covers how to locate that.
• In the script's folder, locate the file named UserConfiguration.txt. In the [Globals] section of the file, specify a unique name for InputName. This will serve as the script's name. Note, if you'd like to disable retrofitting for a particular script, specify ControllerName for InputName.
• Locate the _Generic folder in Live's MIDI Remote Scripts directory.
• In the _Generic folder, find the file named GenericScript.pyc and rename it to OriginalGenericScript.pyc.
• Paste the following file into the _Generic folder and restart Live.
  GenericScript.py (3.4 KB)

Undoing the retrofit:

• Delete the files named GenericScript.py and GenericScript.pyc.
• Rename OriginalGenericScript.pyc back to GenericScript.pyc.

[André G. Mendes]

OK so just to make sure I'm doing everything allright.
As I said I'm trying to retroffit the SL MKII and Touchable.
So what I did was I went to each remote control script folder and renamed the "__init__.pyc" to "original__init__.pyc".
Then I copied the new "__init__.py" into each remote script folder.

Am I missing something?

Update: I tried doing it again just for the SL and it didn't work. I noticed that the new init py compiled file was created.

Here's the log:
Log.txt (76.16 KB)

Thanks!


Btw I'm running it now in Live 9.7.5 inside Windows 10. 

[Stray]

There's a couple of issues here. The first is that you should be renaming __init__.pyc to __original_init__.pyc.

The second is that if you're going to use the standalone ClyphX_Pro script with retrofitted scripts, it needs to be selected in a Control Surface slot above all retrofitted scripts. So, in this case, it would need to be selected in slot 1 or 2, above the SL script.

[André G. Mendes]

I've now corrected the mistake to "__original_init__pyc" and now the SL is showing up but it's not starting the remotesl original script. The Clyphx pro is selected in the first slot and the remoteSL on the second.

Log.txt (877 KB)

[André G. Mendes]

Looked into the new "__init_.py" and it says: "Then, simply place this module (named __init__.py) in the script's folder and reload Live."

Do I have to give it a name or is this a typing misunderstanding? 

[Stray]

I'm not sure where you're seeing __init_.py. The name of the file provided in this thread is named __init__.py.

Anyhow, the issue is that the RemoteSL script is a legacy script. Retrofitting won't work with scripts like that unfortunately. I'll update the post to reflect that and mention other legacy scripts.

[André G. Mendes]

Ohhh :,(

Anyway just now saw the drum rack clyphx pro you posted. I´m thinking if will it work if i’ve put all my clyphx actions in there and mapped the pads to a midi cc/channel on every controll surface than i could trigger them all with using just one control surface set to clyphx. Can this be an alternative for still using the SL legacy script and any other scripts combined?

[André G. Mendes]

Btw is making a proper updated version of the SL MKII (with all the light feedback) by Native Kontrol a possibility in a near future?

[Stray]

It's on the wishlist to be supported in Arsenal, but that definitely won't happen until after Live 10 is released.

Regarding your other question, not exactly, no. The Drum Rack doesn't trigger actions. Notes coming from clips on the track (or notes coming into the track from a controller) trigger actions. So you could use it to trigger actions from controllers or your could use the provided Max for Live interface (demonstrated in the Max for Live Integration lesson) to do it in another way. The possibilities are sort of endless. If you have further questions on this though, please post in the main beta thread so we don't obscure this thread with unrelated discussions.

[infinitystairs]

I own Arsenal and ClyphX Pro. Just to be clear, if I want to use ClyphX Pro and not use up a Control Surface slot, I do not need to do this procedure, right? Arsenal seems to load ClyphX Pro without doing this procedure.

In fact, when I performed the retrofit on Arsenal, my log file was full of errors related to ClyphX Pro. And when I undid that retrofit, and loaded ClyphX Pro into its own slot, I saw an error in my log related to multiple instances of ClyphX Pro. It wasn't until I undid both of those mistakes, that I discovered ClyphX Pro was already loaded and working, and didn't require any of this.

[Stray]

Welcome to the forum. Yes, that's correct and is covered in the ClyphX/ClyphX Pro Integration section of the manual.

[André G. Mendes]

Dec 11, 2017 6:37:23 GMT -5 Stray said:

Hi Stray! Just a question about retrofitting. Is it possible to retrofitt the BCR and BCF? I've tried it but it doens't work. I don't know if it's because I'm using the BCFXL and BCRXL script from Isotonik...

Thanks

[Stray]

For the sake of clarity, controllers can't be retrofitted, only scripts can be retrofitted. I'm not familiar with the scripts in question, so I can't say for sure whether they could be retrofitted. I've asked the dev of the script for some info. In the interim, if you could attach your Log.txt file, that might help shed some light on what's going on.