ViewVC logotype

Contents of /doc/docbase/gigedit/scripts/01_gigedit_scripts.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 2807 - (show annotations) (download) (as text)
Sat Jul 18 09:22:48 2015 UTC (8 years, 4 months ago) by schoenebeck
File MIME type: text/html
File size: 5450 byte(s)
- Cosmetical corrections on gigedit scripts article.

1 <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>
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.<br>
38 <br>
39 To add a new instrument script to your GigaStudio
40 file, click on the "Scripts" tab, then
41 <i title="Use the right button of your mouse. On Mac: tap with two fingers on your touch-pad.">
42 right click
43 </i> on the script list view and select "Add Script". A new empty script
44 has now been added to your GigaStudio file. Like with instruments and
45 samples you may now
46 <i title="Press the left button of your mouse two times, with a slow break between the two clicks.">
47 click twice
48 </i>
49 on the new script in the script list and rename the script to something
50 meaningful.
51 </p>
53 <h3>Editing Scripts</h3>
54 <p>
55 <img src="gigedit_script_edit.png">
56 The new script is yet empty. To add some code to the script, or to modify
57 an existing script, select the respective script name in the list view,
58 then <i>right click</i> on that script name and select "Edit Script".<br>
59 <br>
60 The script editor has now appeared on your screen. Enter or edit the code
61 for the script with your keyboard. Once you are done, click on "Apply".
62 Close the script editor and select "Save" from the menu to save your
63 GigaStudio file with your new script.
64 </p>
65 <img src="gigedit_script_editor.png" caption="NKSP Instrument Script Editor">
66 <p>
67 To learn the NKSP script language in order to write or customize such
68 scripts, please refer to the <a href="nksp.html">NKSP Language Manual</a>.
69 </p>
71 <h3>Assigning Scripts to Instruments</h3>
72 <p>
73 <img src="gigedit_script_slots_open.png">
74 Like with samples, scripts are stored on a global level in GigaStudio
75 files and are shared by all instruments of that GigaStudio file. That means
76 you may assign a script to several of your instruments, which are only
77 storing a reference to that script. If you later on change the script
78 code, all instruments will automatically have that updated script.<br>
79 <br>
80 To assign a script to one of your instruments, select the "Instruments"
81 tab, then select the name of the instrument in the instrument list view,
82 then <i>right click</i> on the instrument name and select "Script Slots...".<br>
83 <br>
84 A new window appeared (like below), showing you all scripts currently assigned to that
85 particular instrument. Now select the "Scripts" tab on the main window and
86 <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.">
87 drag
88 </i>
89 the script you want to assign to your instrument from the script list view to the center of the script slots window.
90 </p>
91 <img src="gigedit_script_drag.png">
92 <p>
93 The script slots window now updated and shows you a new row with the
94 name of the script that you just added.
95 </p>
96 <img src="gigedit_script_one_slot.png" caption="Script 'Aftertouch Trigger' assigned to the instrument 'Performance Orchestra'.">
97 <p>
98 Close the script slots window and select "Save" from the menu to make
99 your script assignment persistent to your GigaStudio file.
100 </p>
102 <note class="important">
103 Even though Gigedit allows you to assign more than one script to
104 an instrument, this is not yet supported by LinuxSampler. If you load
105 an instrument with multiple script slots into LinuxSampler, then
106 LinuxSampler will currently only load the instrument's first
107 script slot and show you a warning on the console that it ignores all other
108 scripts assigned to that instrument. This will change in future.
109 </note>
111 </body>
112 </html>

  ViewVC Help
Powered by ViewVC