GigScript Special Include Files

<< Click to Display Table of Contents >>

Navigation:  Reference > Include >

GigScript Special Include Files

As of Gig Performer 4.5, when you create a new GigScript (i.e, you open the Gig Script editor for a newly created gig), there will be two special Include statements inserted automatically at the top of the editor

 

Include "$system$"

Include "$rig$"

 

$system$

The $system$ include file is intended for a script that you want to have available in every single gig file. The actual script name must be named GPSystemScript.gpscript and it must live in the folder

~/Documents/Gig Performer/Scripts/AutoLoad/GPSystemScript.gpscript  (Mac)

C:\Users\<your user name>\Documents\Gig Performer\Scripts\AutoLoad\GPSystemScript.gpscript (Windows)

It is not an error for this file to not exist and so GPScript will just log a warning in the Script Logger window without opening it.

$rig$

The $rig$ include file resolves to the name of your currently referenced Rig Manager file and is intended to be used with specific rigs. For example, if you have a rig where one of your sustain pedals is inverted, you might include code to reverse the polarity of that sustain pedal but you only want that to happen with the specific rig.

If your rig is called xyz, then if a file called xyz.gpscript is found under AutoLoad/Rigs, then it will be loaded automatically when that specific rig is selected, e.g.:

~/Documents/Gig Performer/Scripts/AutoLoad/Rigs/xyz.gpscript  (Mac)

C:\Users\<your user name>\Documents\Gig Performer\Scripts\AutoLoad\Rigs\xyz.gpscript (Windows)

It is not an error for this file to not exist and so GPScript will just log a warning in the Script Logger window without opening it.

 

Note: it is safe to remove those includes from the gig file if you have no need for them.