Resource Container
Introduction
The resource container is a useful tool for library developers. It is a dedicated location to store scripts, graphics, .nka files, Creator Tools GUI Designer performance views and impulse response files that can be referenced by any NKI or a group of NKIs that are linked to the container. Another benefit is that you can create a resource container monolith file containing all the scripts, graphics etc, so that you can easily move them around or send them to other team members. When loading an NKI, the resource container is treated like a sample, so if it is not found it will appear in the Content Missing dialog.
Setup
To create a resource container for your library, open up the instrument Options dialog for the Instrument you're working on, and click the Create button beside the area labeled Resource Container. After creating a new resource container file, Kontakt checks if there is already a Resources
folder available. If there isn’t, Kontakt will ask to create it for you. If you do this, you will find Resources
and Data
folders next to the NKR file you have just created.
The Resources
folder is the place where you can store the files that an Instrument can use which are not samples. As you can see, Kontakt has already created several subfolders for you: data
(for .nka files), ir_samples
, komplete_scripts
(for graphics and scripts used by Komplete UI), performance_view
(for Creator Tools' GUI Designer performance view files) pictures
(for GUI graphics and wallpapers used by KSP), and scripts
. The only thing to do now is to move your files into the right folders and you are ready to go.
Working with the Resource Container
Let’s say you’re creating a new library: after setting up the resource container as described above, you can tell all of the NKIs that are part of your library to use this particular resource container. Just open up the Instrument Options dialog and use the Browse function (click on the open folder button to the left of Create button).
As long as the Resources
folder exist besides the NKR file (which is the resource container monolith), Kontakt will read all files directly from this folder structure.
For loading scripts from the scripts
subfolder, use the “Apply from… → Resources folder” function within the Script Editor.
Now let’s say you want to send your current working status to another team member. Open up the Instrument Options dialog, click the Repack button, which will quickly fully update your existing NKR file. Be aware that this will completely overwrite your monolith, it won’t be matched in any way. Now Kontakt will do the following:
Check the
data
subfolder for any .nka files.Check the
ir_samples
subfolder for any .wav, .aif, .aiff or .ncw files.Check the
komplete_scripts
folder for any valid files used by Komplete UI (.kscript, .png, .svg, .tif, .tiff, .webp, .otf, .ttf).Check the
performance_view
folder for any .nckp files containing performance views created by Creator Tools.Check the
pictures
folder for any .png or .tga files that also have a .txt file of the same filename next to them. Note that wallpapers, instrument icons and custom picture fonts also need a .txt file, or they will be ignored!Check the
scripts
subfolder for any .txt files.Pack all valid files into the Resource Container.
After that, rename your Resources
folder and reopen your Instrument. Now that the Resources
folder is not present anymore, Kontakt will automatically read from the NKR monolith file. If everything is still working as expected, you can send your library (instruments, along with samples and the NKR monolith) to your team members. This is also how your library should be deployed to the market - you are not supposed to release your library with the Resources
folder present!
To continue your work, simply rename the Resources folder back to Resources
.
Remarks
The resource container will be checked in the Content Missing dialog.
When you save your Instrument as a monolith file, the resource container will not be integrated into the monolith. The path to the resource container will be saved as an absolute path, which will only work locally on your machine - on other computers Content Missing dialog will show up upon loading such Instrument, since the path to the resource container is most likely not going to be valid anymore.
Resource Container
Introduction
The resource container is a useful tool for library developers. It is a dedicated location to store scripts, graphics, .nka files, Creator Tools GUI Designer performance views and impulse response files that can be referenced by any NKI or a group of NKIs that are linked to the container. Another benefit is that you can create a resource container monolith file containing all the scripts, graphics etc, so that you can easily move them around or send them to other team members. When loading an NKI, the resource container is treated like a sample, so if it is not found it will appear in the Content Missing dialog.
Setup
To create a resource container for your library, open up the instrument Options dialog for the Instrument you're working on, and click the Create button beside the area labeled Resource Container. After creating a new resource container file, Kontakt checks if there is already a Resources
folder available. If there isn’t, Kontakt will ask to create it for you. If you do this, you will find Resources
and Data
folders next to the NKR file you have just created.
The Resources
folder is the place where you can store the files that an Instrument can use which are not samples. As you can see, Kontakt has already created several subfolders for you: data
(for .nka files), ir_samples
, komplete_scripts
(for graphics and scripts used by Komplete UI), performance_view
(for Creator Tools' GUI Designer performance view files) pictures
(for GUI graphics and wallpapers used by KSP), and scripts
. The only thing to do now is to move your files into the right folders and you are ready to go.
Working with the Resource Container
Let’s say you’re creating a new library: after setting up the resource container as described above, you can tell all of the NKIs that are part of your library to use this particular resource container. Just open up the Instrument Options dialog and use the Browse function (click on the open folder button to the left of Create button).
As long as the Resources
folder exist besides the NKR file (which is the resource container monolith), Kontakt will read all files directly from this folder structure.
For loading scripts from the scripts
subfolder, use the “Apply from… → Resources folder” function within the Script Editor.
Now let’s say you want to send your current working status to another team member. Open up the Instrument Options dialog, click the Repack button, which will quickly fully update your existing NKR file. Be aware that this will completely overwrite your monolith, it won’t be matched in any way. Now Kontakt will do the following:
Check the
data
subfolder for any .nka files.Check the
ir_samples
subfolder for any .wav, .aif, .aiff or .ncw files.Check the
komplete_scripts
folder for any valid files used by Komplete UI (.kscript, .png, .svg, .tif, .tiff, .webp, .otf, .ttf).Check the
performance_view
folder for any .nckp files containing performance views created by Creator Tools.Check the
pictures
folder for any .png or .tga files that also have a .txt file of the same filename next to them. Note that wallpapers, instrument icons and custom picture fonts also need a .txt file, or they will be ignored!Check the
scripts
subfolder for any .txt files.Pack all valid files into the Resource Container.
After that, rename your Resources
folder and reopen your Instrument. Now that the Resources
folder is not present anymore, Kontakt will automatically read from the NKR monolith file. If everything is still working as expected, you can send your library (instruments, along with samples and the NKR monolith) to your team members. This is also how your library should be deployed to the market - you are not supposed to release your library with the Resources
folder present!
To continue your work, simply rename the Resources folder back to Resources
.
Remarks
The resource container will be checked in the Content Missing dialog.
When you save your Instrument as a monolith file, the resource container will not be integrated into the monolith. The path to the resource container will be saved as an absolute path, which will only work locally on your machine - on other computers Content Missing dialog will show up upon loading such Instrument, since the path to the resource container is most likely not going to be valid anymore.