gigedit/scripts/01_gigedit_scripts.html

<html>
  <head>
    <meta name="author" content="Christian Schoenebeck">
    <title>Managing Scripts</title>
    <meta name="description" content="Managing real-time instrument scripts with Gigedit.">
  </head>
  <body>
    <p>
      Gigedit and LinuxSampler provide support for so called
      <i>real-time instrument scripts</i>. You can use such scripts to add
      your own software extensions to the sampler, in order to customize and/or
      extend the sampler's software behaviors and features, specifically to
      satisfy particular software features required for some of your sounds.
    </p>
    <p>
      This article describes how to manage instrument scripts with Gigedit, that
      is how to add scripts to your GigaStudio files and how to apply them to
      your sounds.
      If you rather want to find out more about instrument scripts in general or
      learn about the details of this programming language, then please refer to the
      <a href="instrument_scripts.html">
        Real-Time instrument Scripts manual
      </a>.
    </p>
    <note>
      Instrument scripts is a feature extension of the GigaStudio file format
      which is only available with Gigedit and LinuxSampler. Instrument scripts
      are not supported by the original GigaStudio software.
    </note>
    
    <h3>Adding Scripts</h3>
    <p>
      <img src="gigedit_script_add.png">
      Before you can apply scripts to some of your sounds, you first need to add
      the instrument script to your GigaStudio file. Once you added a script to
      your GigaStudio file, the script can then be assigned to one or several
      instruments of that GigaStudio file.
    </p>
    <p>
      To add a new instrument script to your GigaStudio
      file, click on the "Scripts" tab, then
      <i title="Use the right button of your mouse. On Mac: tap with two fingers on your touch-pad.">
        right click
      </i> on the script list view and select "Add Script". A new empty script
      has now been added to your GigaStudio file. Like with instruments and
      samples you may now
      <i title="Press the left button of your mouse two times, with a slow break between the two clicks.">
        click twice
      </i>
      on the new script in the script list and rename the script to something
      meaningful.
    </p>
    
    <h3>Editing Scripts</h3>
    <p>
      <img src="gigedit_script_edit.png">
      The new script is yet empty. To add some code to the script, or to modify
      an existing script, select the respective script name in the list view,
      then <i>right click</i> on that script name and select "Edit Script".
    </p>
    <p>
      The script editor has now appeared on your screen. Enter or edit the code
      for the script with your keyboard. Once you are done, click on "Apply".
      Close the script editor and select "Save" from the menu to save your
      GigaStudio file with your new script.
    </p>
    <img src="gigedit_script_editor.png" caption="NKSP Instrument Script Editor">
    <p>
      To learn the NKSP script language in order to write or customize such
      scripts, please refer to the <a href="nksp.html">NKSP Language Manual</a>.
    </p>
    
    <h3>Assigning Scripts to Instruments</h3>
    <p>
      <img src="gigedit_script_slots_open.png">
      Like with samples, scripts are stored on a global level in GigaStudio
      files and are shared by all instruments of that GigaStudio file. That means
      you may assign a script to several of your instruments, which are only
      storing a reference to that script. If you later on change the script
      code, all instruments will automatically have that updated script.
    </p>
    <p>
      To assign a script to one of your instruments, select the "Instruments"
      tab, then select the name of the instrument in the instrument list view,
      then <i>right click</i> on the instrument name and select "Script Slots...".
    </p>
    <p>
      A new window appeared (like below), showing you all scripts currently assigned to that
      particular instrument. Now select the "Scripts" tab on the main window and
      <i title="Point at the item with your mouse, then click and hold the left button of your mouse and while holding the button, move the item with your mouse to its destination.">
        drag
      </i>
      the script you want to assign to your instrument from the script list view to the center of the script slots window.
    </p>
    <img src="gigedit_script_drag.png">
    <p>
      The script slots window now updated and shows you a new row with the
      name of the script that you just added.
    </p>
    <img src="gigedit_script_one_slot.png" caption="Script 'Aftertouch Trigger' assigned to the instrument 'Performance Orchestra'.">
    <p>
      Close the script slots window and select "Save" from the menu to make
      your script assignment persistent to your GigaStudio file.
    </p>

    <note class="important">
      Even though Gigedit allows you to assign more than one script to
      an instrument, this is not yet supported by LinuxSampler. If you load
      an instrument with multiple script slots into LinuxSampler, then
      LinuxSampler will currently only load the instrument's first
      script slot and show you a warning on the console that it ignores all other
      scripts assigned to that instrument. This will change in future.
    </note>

  </body>
</html>
1	schoenebeck	2732	<html>
2			<head>
3			<meta name="author" content="Christian Schoenebeck">
4			<title>Managing Scripts</title>
5			<meta name="description" content="Managing real-time instrument scripts with Gigedit.">
6			</head>
7			<body>
8			<p>
9			Gigedit and LinuxSampler provide support for so called
10			<i>real-time instrument scripts</i>. You can use such scripts to add
11			your own software extensions to the sampler, in order to customize and/or
12			extend the sampler's software behaviors and features, specifically to
13			satisfy particular software features required for some of your sounds.
14			</p>
15			<p>
16			This article describes how to manage instrument scripts with Gigedit, that
17			is how to add scripts to your GigaStudio files and how to apply them to
18			your sounds.
19			If you rather want to find out more about instrument scripts in general or
20			learn about the details of this programming language, then please refer to the
21			<a href="instrument_scripts.html">
22			Real-Time instrument Scripts manual
23			</a>.
24			</p>
25			<note>
26			Instrument scripts is a feature extension of the GigaStudio file format
27			which is only available with Gigedit and LinuxSampler. Instrument scripts
28			are not supported by the original GigaStudio software.
29			</note>
30
31			<h3>Adding Scripts</h3>
32			<p>
33			<img src="gigedit_script_add.png">
34			Before you can apply scripts to some of your sounds, you first need to add
35			the instrument script to your GigaStudio file. Once you added a script to
36			your GigaStudio file, the script can then be assigned to one or several
37			instruments of that GigaStudio file.
38			</p>
39			<p>
40			To add a new instrument script to your GigaStudio
41			file, click on the "Scripts" tab, then
42			<i title="Use the right button of your mouse. On Mac: tap with two fingers on your touch-pad.">
43			right click
44			</i> on the script list view and select "Add Script". A new empty script
45			has now been added to your GigaStudio file. Like with instruments and
46			samples you may now
47			<i title="Press the left button of your mouse two times, with a slow break between the two clicks.">
48			click twice
49			</i>
50			on the new script in the script list and rename the script to something
51			meaningful.
52			</p>
53
54			<h3>Editing Scripts</h3>
55			<p>
56			<img src="gigedit_script_edit.png">
57			The new script is yet empty. To add some code to the script, or to modify
58			an existing script, select the respective script name in the list view,
59			then <i>right click</i> on that script name and select "Edit Script".
60			</p>
61			<p>
62			The script editor has now appeared on your screen. Enter or edit the code
63			for the script with your keyboard. Once you are done, click on "Apply".
64			Close the script editor and select "Save" from the menu to save your
65			GigaStudio file with your new script.
66			</p>
67			<img src="gigedit_script_editor.png" caption="NKSP Instrument Script Editor">
68			<p>
69			To learn the NKSP script language in order to write or customize such
70			scripts, please refer to the <a href="nksp.html">NKSP Language Manual</a>.
71			</p>
72
73			<h3>Assigning Scripts to Instruments</h3>
74			<p>
75			<img src="gigedit_script_slots_open.png">
76			Like with samples, scripts are stored on a global level in GigaStudio
77			files and are shared by all instruments of that GigaStudio file. That means
78			you may assign a script to several of your instruments, which are only
79			storing a reference to that script. If you later on change the script
80			code, all instruments will automatically have that updated script.
81			</p>
82			<p>
83			To assign a script to one of your instruments, select the "Instruments"
84			tab, then select the name of the instrument in the instrument list view,
85			then <i>right click</i> on the instrument name and select "Script Slots...".
86			</p>
87			<p>
88			A new window appeared (like below), showing you all scripts currently assigned to that
89			particular instrument. Now select the "Scripts" tab on the main window and
90			<i title="Point at the item with your mouse, then click and hold the left button of your mouse and while holding the button, move the item with your mouse to its destination.">
91			drag
92			</i>
93			the script you want to assign to your instrument from the script list view to the center of the script slots window.
94			</p>
95			<img src="gigedit_script_drag.png">
96			<p>
97			The script slots window now updated and shows you a new row with the
98			name of the script that you just added.
99			</p>
100			<img src="gigedit_script_one_slot.png" caption="Script 'Aftertouch Trigger' assigned to the instrument 'Performance Orchestra'.">
101			<p>
102			Close the script slots window and select "Save" from the menu to make
103			your script assignment persistent to your GigaStudio file.
104			</p>
105
106			<note class="important">
107			Even though Gigedit allows you to assign more than one script to
108			an instrument, this is not yet supported by LinuxSampler. If you load
109			an instrument with multiple script slots into LinuxSampler, then
110			LinuxSampler will currently only load the instrument's first
111			script slot and show you a warning on the console that it ignores all other
112			scripts assigned to that instrument. This will change in future.
113			</note>
114
115			</body>
116			</html>