Skip to content

1.2 Include Koala Library into your Script

Jump to bottom
Davide Magni edited this page Mar 3, 2017 · 4 revisions

Once downloaded from Package Control, Koala will be stored inside one of Sublime Text 3 folders. We need to rescue that folder in order to copy Koala to our script's root folder.

Move Koala to the right folder and start scripting

  1. Click on Preferences > Browse Packages...
  2. Open the folder "Koala"
  3. Inside the folder "Koala" you will find a few files and a folder. Let's focus on the following ones:
    • "Koala - TEMPLATE SCRIPT.ksp": this is a template file which contains all the main functions of Koala where they are supposed to be. This includes all the Debugging and Logging functions, so it's ready to go. You can compile and apply it to Kontakt right away.
    • "Koala" folder. This folder all the files used by Koala.
  4. Copy the folder "Koala" and the file "Koala - TEMPLATE SCRIPT.ksp" into the root directory of your script.
  5. "Koala - TEMPLATE SCRIPT.ksp" will be the main KSP file of your script. You can rename it the way you like.
  6. Start scripting using "Koala - TEMPLATE SCRIPT.ksp".
  7. Once you are satisfied about your script, press F5 (Windows) or CMD+K (Mac) to compile. The resulting script will be copied to clipboard.
  8. Paste your script to Kontakt and press Apply. If there are no mistakes, the script will be applied to Kontakt and executed.

Set-up your script

Koala works only on brand-new scripts. To help you getting started, we included a template file inside Koala's folder. Use a copy of the Template File that comes with Koala to start writing your script. That's the best solution, as it already has all the scripting needed for Koala to work properly.

SublimeKSP syntax

SublimeKSP comes with its own simplified syntax. Please refer to SublimeKSP Wiki and Nils Liberg's website to become a real master.

Clone this wiki locally