-
Notifications
You must be signed in to change notification settings - Fork 5
1.1 Installation
In order to use Koala, you have to fulfill the following requirements:
-
Sublime Text 3. Download and install the latest version.
-
Latest version of Kontakt FULL. You simply cannot use Kontakt Player to execute your own Scripts. Full version is needed.
As of Koala v2.1.0, the library is compatible and fully supports Kontakt 5.6.5. Backwards compatibility is granted until Kontakt 5.5.2. There is no current documentation for Kontakt versions prior to 5.5.2.
Package Control is an extension for Sublime Text 3 which enables the developer to access to a ton of Sublime Text packages. By installing Package Control, you will be able to search the repository and download all the packages you need.
To install Package Control, please refer to this guide.
Now we need to install Sam Windell's fork of SublimeKSP. SublimeKSP is a package for SublimeText 3 originally made by Nils Liberg. Sam did a great job by improving it. Starting from v2.0.0, Koala is entirely based on Sam's compiler, so you have to make sure to use it.
To install Sam Windell's fork of SublimeKSP, please refer to this guide.
Koala features 150+ new functions and constants. In order to optimize the time required to write your scripts, we have set up a set of custom snippets for Sublime Text 3.
A snippet is a single file which contains a "shortcut" to a specific function. When you write one of Koala's function, Sublime Text 3 will give you suggestions of the currently available functions: once you have found the function you were looking for, you just have to hit Enter and the auto-completion system will add the function to your script.
Koala's snippets, once again, have been created using the marvelous KSP Snippet Maker by Sam Windell.
To install Koala snippets from Package Control:
- Open the Command Palette from the Tools menu or CommandShiftP (OS X) or CtrlShiftP (Windows)
- Type "Install Package". This command executes Package Control.
- Type "Koala" and select "Koala - Snippets"
- Hit Enter to install
- Restart Sublime Text
Starting from v2.0.0, Koala is available as a package on Package Control.
- Open the Command Palette from the Tools menu or CommandShiftP (OS X) or CtrlShiftP (Windows)
- Type "Install Package". This command executes Package Control.
- Type "Koala" and select "Koala"
- Hit Enter to install
- Restart Sublime Text
After you downloaded Koala, you will have to copy all the library files to the folder where your KSP script is. We will see how to do this [in the next section](1.2 - Include Koala Library into your Script).
Kontakt 5.6.x features some important updates, such as the possibility to process real numbers and XY Pads (from 5.6.5). Koala 2.1.0 introduced some advanced functions which are compatible solely with Kontakt 5.6. Altough backwards compatibility is ensured with Kontakt 5.5.2, there are some functions that simply will not work if you try to apply them to any version prior to 5.6.0 (which only supports the new math runtime with real numbers and arrays) or 5.6.5 (which in addition to 5.6 supports XY Pads). The compiler will not warn you about this, but the script may not be applied to Kontakt. Be warned.