Before we start scripting we should create a resource container where we put in all our files we need for our instrument (e.g graphic files or impulse responses etc.)
create a resource container
- start Kontakt and create a new instrument
- Save your instrument into a new folder
- DON’T check absolute path (this keeps all file paths relative learn more)
- click on the wrench button, click on “instrument options” and click “create” (see image)
- chose the folder you have just stored your nki/instrument into and enter a name for the resource container. Click “save”
- when you are getting asked to create one, confirm
- Save your instrument again (DON’T check “Absolute paths”) (learn more)
Kontakt will create a “Resources” folder (with sub folders) and a “nkr” file.
Both resources folder & nkr file have the same purpose: they both contain all resources of your instrument like graphics, impulse responses or scripts.
But you can only access the Resources folder, not the nkr container file since all your content is being packed and “encrypted” into this nkr file.
Each time we click on the create button, Kontakt will update the nkr file and copy (and “encrypt”) our resources into the nkr. Provided that we have put all our files correctly into the related resource sub folders (read more below)
With graphic content we also need to add a little text file for each image (see below):
The content (locations) – Extra text file for graphic files
with any graphic content we also need to store a special text file into the Resources\pictures\ folder. Kontakt needs this file to be able to handle special properties for our graphic files, like animation steps, alpha channel etc.
- we have to store all graphics or images into Resources\pictures\
- all impulse responses into Resources\ir_samples\
- scripts to be included into Resources\scripts\
- for each image we also have to add a *.txt file into Resources\pictures with the image’s filename. The text file is declaring the properties of the related image. So if we store an image called “wallpaper.png” we also have to add a “wallpaper.txt” with this content:
Has Alpha Channel: yes Number of Animations: 0 Horizontal Animation: no Vertical Resizable: no Horizontal Resizable: no Fixed Top: 0 Fixed Bottom: 0 Fixed Left: 0 Fixed Right: 0
the txt file should be stored in UTF-8 or ANSI.
workflow developers / kontakt behavior
When we open our instrument (nki), Kontakt will first look into the Resources folder. Only if Kontakt can’t find any files there, it will proceed looking into the nkr file. So the Resources folder always has priority over the nkr file which is very useful for developers because we don’t need to update the nkr file again and again.
Purpose of the nkr file?
Why do we need the nkr file at all? The nkr file simply “hides” and locks all our resources. There are many reasons for not letting everyone access our resources. Probably you may not want others to use them for their own projects or you don’t want others to edit your files.
publishing your instrument
To publish your instrument hit the “create” button for the last time, and verify that all resources have been included into the nkr file.
Simply publish your whole instrument folder without the Resources folder. So just the nki, nkr, nkc file. And of course also your samples, snapshots, midi files etc.
Unless you want to share all your resources of course. In this case simply share your whole instrument folder including your Resources folder.
Before publishing your instrument it’s really highly recommended to verify that all files are really included into the nkr file.
For this just copy your instrument folder (without the resources folder) to another location on your hard drive. Open the instrument (nki) from the new location and check if anything is missing. The most obvious you will notice instantly are missing images.