KONTAKT 4 PLAYER Developer Guide
Contents
1. KONTAKT 4 PLAYER DEVELOPER GUIDE The information in this document is subject to change without notice and does not represent a commitment on the part of Native Instruments GmbH The software described by this document Is Subject to a License Agreement and may not be copied to other media No part of this publication may be copied reproduced or otherwise transmitted or recorded for any purpose without prior written permission by Native Instruments GmbH hereinafter referred to as Native Instruments All product and company names are or trademarks of their respective owners Developer s Guide written by Daniel Santucci and Adam Hanley Edited by Patryk Korman Document Version 1 1 01 2010 Product Version 4 0 09 2009 Special thanks to the Beta Test Team who were invaluable not just in tracking down bugs but in making this a better product Germany Native Instruments GmbH schlesische Str 28 D 10997 Berlin Germany info native instruments de www native instruments de USA Native Instruments North America Inc 5631 Hollywood Boulevard Los Angeles CA 90028 USA Sales native instruments com www native instruments com ND NATIVE INSTRUMENTS Native Instruments GmbH 2009 All rights reserved Table Of Contents 1 Essential Information to Get You Started sss sss ss ese s cesse sees esse seene nenen 6 tl AUCIO Material Samples T 6 12 Namme GCOMV TTT 7 13 Organization OT EUS sirse2. end on get ds Ee Seount lt 4 seul control ui slider Ssliderol 0 100 ui switch SswitchOl ul Label slabelol 1 1 ul menu Smenu0l IDs in an Array array 4 get UL ada ssliderdl Sswitch01 get ui id label01 lt get uli id menu01 par Sui id array Scount SCONTROL PAR PFOS X 262 par sui id array Scount SCONTROL PAR POS _ Y 18 count 50 par str cul id array Scount SCONTROL PAR TEXTI KONTAKT PLAYER Developer Guide 29 This will produce a performance view that looks like this Here we have re arranged the controls in a vertical grid by addressing the elements by their UI IDs in a while loop meaning that we can apply the same processes to all of these ele ments This is very useful when skinning multiple controls for example Now we will skin the UI elements gt First of all place the provided image files and their corresponding text files in the KONTAKT 4 user pictures folder which can be found here e On Windows XP Documents and Settings User My Documents Native Instruments Kontakt 4 Pictures e On Mac OSX or Windows Vista Windows 7 User Documents Native Instruments Kontakt 4 Pictures When you reference an image file in the KONTAKT script it automatically checks the library pictures folder then the user pictures folder This is why the image Tile path does not need referenced Also the image file extension png does not need to be included
3. 0 ccccecececscsccccececscscececeneacacseseeess 26 91 Editing UlElements DY Pixel sisscnsicuvacsetcanowncwutirensveenscenpsendaadguncsendactwatudeneueneeamdenwanuans 26 9 1 1 Overayine WH SATO S sisiran EEN 26 5 2 New User Interface Controls cccccscceeceececcecsecnecneeeeeeeneensenseneenseeeusenseuseuseeseesass 21 5 3 New User Interface Commantis sss esse sss esse sss sse esse ecce ee eee eee 21 5 3 1 UUE E EE EE E A A E E TEA cts cele E E TE 21 332 WiCOMEOL F ala MelelS sascasciveancseasaseisadreonetenieensenaseeaaueierssasiunesseaccnts 21 R A OMI ElEMEN aasa a rE 28 5 3 4 Changing the Instrument lGOn sese eee e e e K Ke e KKK 31 94 PRENALING mate FICS scrret 32 5 4 1 ACCOMPANYING EXT 0 Cccccavrscersacdrecioredeancdeatnennckasimausincetnentersaisenaeks 32 SAL AMAOS e ee eee ee ee ee ee ee 33 IAS G re Sane ee ne a eee nee ere eon ere 35 Ee D lt eo eT 35 KONTAKT PLAYER Developer Guide V 1 Essential Information to Get You Started KONTAKT PLAYER Library development does not require a special developer s version You can use the release KONTAKT version to begin programming your library Please contact Native Instruments if you need a version of KONTAKT for development Only if all items Library and deliverables have been received by Native Instruments and proven to be correct the process of creating the software and Master will start 1 1 Audio Material Samples e wav or aiff files with the extension
4. A click on the gear symbol opens the instrument options screen 2 2 Instrument Options Screen Instrument Maschine Drum Selection DFD KONTAKT _ SOUNDPACK Controller Infos Macintosh HD Sound Libraries Maschine Orum Selection Library Instruments Analog Ki Each library has its own Info screen where in addition to the instrument specific options all related library information like credits copyright serial number and Instrument installation path are displayed This screen is also where the two Info graphics AboutlconLibAuthor tga and AboutliconLib tga are displayed KONTAKT PLAYER Developer Guide 14 2 3 The Library Browser The library browser is on the left side of the player and shows one box for each installed library KONTAKT PLAYER Erguer Libraries D Fast Instrument EditMode O dd Ltrary ap hes FPS He Peed p Ak DEMO SCARBEE PRE BASS hue 7 TT reteset i 4 Output st E Li U Sree Upright Piano UE E oa lhe Tp S UG L t D _f THE R Ee fiet ns E uoaa E SGE Eai STE augina ins fnurents Creare Trigger HO sioj Shuan Caah UIRTUAL BOUEOURI Loading Instruments from the Library Browser The user can access the instruments of all installed libraries by clicking the Instruments or Multis buttons of the corresponding library Instruments Multis There is one way of browsing
5. wav or aif all small letters e ncw native compressed wave files for more info on KONTAKT s compression function please refer to the KONTAKT user manual e 44 1 48 or 96 kHz e 16 or 24 bit When creating the samples for the KONTAKT library please make sure that in the entire li brary there are no samples which have the same name otherwise the conversion encoding of the library can cause problems with assigning the correct samples to the correct instru ment patches This can easily be tested by attempting to copy all of the samples into a single directory T It is ESSENTIAL that the sample names have proper extensions Although OS X does not require them our Windows based library encoding utilities will fail on files without proper extensions KONTAKT PLAYER Developer Guide 6 1 2 Naming Conventions Although virtually any name and length is now acceptable it makes sense to use caution when naming samples and instruments Traditionally slashes and dots cause errors 1 3 Organization of Files In order to make the conversion of the library smooth and easy please sort all instruments Samples and presets into four folders e Info e Instruments e Multis e Samples 1 3 1 Info Folder The info folder contains several text files and all pictures of the product Additionally it can contain any scripts as text files png files for your instrument design and impulse responses During the e
6. 1 i Memory O Note that the height of the performance view does not include the KONTAKT Instrument main controls so instruments are always a little bigger than the set height an important fact when making custom wallpapers Also note the order of the controls In the script the slider is declared first but on the inter face the label appears first This is because of the UI element generation order as described on the previous page The order of the elements as they appear here is the order of element KONTAKT PLAYER Developer Guide 28 layer priority from lowest to highest so for example a slider will always be placed above a label if they are moved to the same space Let us adjust these controls using some of the new commands In the following example the UI IDs will be stored in an array which will later be accessed using a loop counter This is a useful technique that is made possible with the new set control par commands gt Copy and paste the following script into KONTAKT s script editor om LIne Set performance view attributes make perfview set ur hergne px zo0 set script title Example Script Declare UI elements declare declare declare declare E Wir declare ci Id OW C AP oP W id array 0 _ ar ad array Us R 2 array 2 a CO array Si declare Seountk 0 while Sec lt Comecrol SSE lt CONntZOL DO U TE end while
7. The following is a key that describes which align ment corresponds to each value O left l center 2 right KONTAKT PLAYER Developer Guide 35 gt Copy and paste the following script into KONTAKT 4 On LAr make perfview Create and adjust example label declare wr Jaber slabel 1 1 4 set text Slabel 1 Hello World set control par get ui id Slabel 1 SCONTROL PAR TEXT ALIGNMENT 1 move COnNLLOl j label 1 2 1 Lr reote and adost valus Sdit Lo COneErol Tent Type iGE labels declare ul value edit font select 0 24 1 set text Sfont select Select Font Move COneroL jfon seleoL l l create and adjust button for hiding the label background declare ur _ Dutton nme Dg set text hide bg Hide BG set control par get i id hide bg S CONTROL PAR TEXT ALIGNMENT 1 end on value edit callback for changing label font Om Ud CONC rOL Tont Select set control panmget ur ad slabel 1 sCONTROL PAR FONT TIPE STONG select enad On button callback for hadiung Tabel background on Ud control Shide bo if S hide bg 0 set control par get ui id label 1 SCONTROL PAR HIDE SHIDE PART NOTHING else set control par get wui id label 1 CONTROL PAR HIDE HIDE PART BG end if end on CNE OF ser lors KONTAKT PLAYER Developer Guide 36 This should produce something that looks like this Font Selektor 4 2 Output st 1 of Voices OF Moa
8. Tiles to be used in KONTAKT must be saved as png files In order for KONTAKT to treat the image correctly it must be provided in as stack of anima tions So if you want one knob with 100 states you need to build a very long image with all of these states in a row or column KONTAKT will read the file top to bottom or left to right depending on the setting of the txt file So your lowest value for a knob should be at the top or left and the highest at the bottom or right KONTAKT PLAYER Developer Guide 33 Switches and Dropdowns should always have six animations in a set order off on off mouse down on mouse down off mouse over a gt o1 A Go N on mouse over The following script will illustrate the different states of a switch gt First copy the image and text files switch_state_example to the KONTAKT 4 user pictures folder Then copy and paste the following script into a new KONTAKT instrument On nace make perfview declare Ui Switch Sswiteh states set control par str get ui id switch states S CONTROL PAR TEXT set control par str get wui id switch states SCONTROL PAR PICTURE switch state example end on This will produce a single button that changes color depending on its state 1 ott black 2 on red 3 off mouse down orange 4 on mouse down yellow 9 off mouse over purple 6 on mouse over green Image Tiles must always have six animations even If you only plan to use
9. number these are automatically assigned during initialization gt The Ul ID can be retrieved by using the get ui id lt ui element name gt Command The UI IDs are generated each time the script is initialized so it is always advised to use the above command when addressing a Ul element by its ID number 5 3 2 Ul Control Parameters Most attributes for controls are edited using the new set control par Of set con trol par str Commands For skinning Ul elements you should familiarize yourself with these commands and their variables in the KSP reference manual KONTAKT PLAYER Developer Guide 27 9 3 9 Skinning Ul Elements It is now possible to skin e g apply a custom image Tile to various control elements The following is a short scripting tutorial to show you how to skin and adjust controls using the new commands gt Enter the following script into the KONTAKT script editor on init Set performance view attributes make perfview set ul height _ px 50 set script title Example Script Declare UI elements declare wi slider osliderol 0 100 declare ui switch S switch0l declare ui label Slabel0l1 1 1 declare ui menu Smenu0l end on In the above script we have made a performance view called Example Script which is 50 pixels high and includes 4 different Ul elements The instrument should look like this New default Output st 1 7 T Voices OF Mas 32 Midi Ch A
10. the instruments of each library A click on the instrument button in the library box will switch to the standard KONTAKT browser view with a folder and file list KONTAKT PLAYER Developer Guide 15 ise lt Instruments 1 5 waj 0 1 MEI 0 1 MEW Medium 0 1 MEI Smal ee You can use the back arrow to navigate one level higher or use the x button to close the library box The directional arrows will resort the folders or instruments from last to first 2 4 Registration and Authorization in Detail After installation the library runs in 15 minute demo mode You can recognize that the library is In demo mode If the Activate button appears in the Library Box Maschine Drum Selection Activate C7 MASCHINE Instruments Furthermore when in demo mode instruments will be loaded with the title DEMO in the name field lt DEMO Andre Winter Minimize Kit eas A ae Output st 1 Cel t Voices OF Max 32 Purge Cr ee 0 00 i G Midi Ch A 1 Groups Ce i Memory 1 46 ME n SIS KONTAKT PLAYER Developer Guide 16 The Demo Mode allows you to play any Instruments from a particular library for 15 minutes The countdown begins when the first Instrument from that given library is loaded After 15 minutes have passed there will be a Demo Timeout message and any other Instruments loaded from that library will also be timed out Demo Timeout Activate 2 9 Library En
11. AYER libraries are not just sampler patches they are optimized user interfaces as well We recommend spending a bit of time on the overall concept of your library instru ments It s possible to create one general interface for an entire library but this is not always the most elegant solution String patches might need a totally different interface than a Piano Therefore it might make sense to categorize your library and create dedicated interfaces Highly customized GUIs require additional work on concept and scripting but in the end this makes the library much more valuable To get some ideas of what is possible we recommend that you check out the KONTAKT factory library All KONTAKT instruments are intentionally unlocked aS we encourage you to explore and in some cases even use our programming Bear in mind that there are some restrictions as to which factory scripts can be used commercially so if you want to use anything in your product please be sure to ask for our permission first If you don t feel comfortable with making your own scripts or would like something very unique please get in touch with us We know many freelance programmers which may be able to help you realize your vision 4 1 Scripting For in depth script information please consult the KONTAKT Documentation folder There are comprehensive KSP documents which include all the latest features and additions There are also comprehensive online tutorials especia
12. a p 0 00 5 Y Midi Ch A 1 Groups C g Memory 10 27 MB a T T Tune es Cutott Cy ee ee k U 0 7 k O00 st ye CFE BIZ Y 00 Selected Instrument cS DRUM SELECTION MASCHINE Kick 1 OF Hote i Reverb Sat if La Decay jO Select by MIDI EE on Te 0 0 Ve DH e O ms Instrument Drum Computer LS a e a The Performance View Is a customizable easy edit page for each instrument With this view you can design the look and control elements of your interface for each instrument of your library individually Up to 5 tabs are possible Each tab can have Its own layout In the above performance view the tga image contains the labels and background surface including the MASCHINE Drum Selection text Here is how a performance view tga looks for all tabs without any control elements Selected Instrument EE S ba Ka L r babs io d MASCHINE KONTAKT PLAYER Developer Guide 13 You can unfold the performance view by clicking the Instrument Icon Instlcon tga under the gear symbol For KONTAKT PLAYER functionality the gear symbol replaces the KONTAKT edit page wrench button This symbol means that the instrument cannot be opened for editing In other words It is locked If an instrument is locked during encoding access to the edit page even in the full version of KONTAKT is also prohibited The library developer can decide if the instruments Should be locked or not
13. amples c etc Note that it is possible to encode each top level subfolder individually The advantage is that each subfolder gets its own monolith container For example if your library contains bass guitar and drum instruments you could organize your sample subfolders into three categories i e Bass Samples Guitar Samples and Drums Samples respectively 1 3 3 Impulse Responses You may want to include impulse responses with your library Note that the impulses which come with KONTAKT are not available for commercial use with your library When you include impulses you have the choice to either protect them inside the monolith container or not If you wish to protect Impulse response samples then put them in a folder called ir_samples inside the Info folder KONTAKT PLAYER Developer Guide 9 1 3 4 Resaving Instruments with the New Library Structure KONTAKT contains a unique batch save process which can be found under the File Load menu When all files are sorted the above way please batch resave all instruments and multis with the option relative path i e deselect absolute path in the save dialog 1 Choose batch resave from the file load menu 2 Select the folder which should get resaved in this case it is the instrument and multis folders 3 Point the samples missing dialog to the newly organized samples folder and choose save This process will take some time Please allow saving to work uninterrupt
14. binations of grid commands and pixel commands In our experience it is better to choose one format at the start and Stick with It 9 1 1 Overlaying Ul Elements By using the pixel placement method it is now possible to overlay UI elements All elements are generated in order of type so the element layer priority is automatically set by KONTAKT s engine and there is no way to over ride that This will be further explained in the tutorial Avoid overlapping of controls which have mouse interaction ui_knob ul_slider ui_switch ul_ button ul table ul_value_edit KONTAKT PLAYER Developer Guide 26 5 2 New User Interface Controls In the KONTAKT 4 script update two new controls have been introduced Sliders and switches Sliders act as you would expect but they can also be used to replace the old KONTAKT knobs as described in section 5 3 4 A slider can have a custom skin applied to It but a knob being a more complex element cannot Switches are virtually identical to buttons but have the added benefit of being automatable The button has not been replaced as it Is still useful in certain cases for example switching between control views a function that does not need automating 5 3 New User Interface Commands 9 3 1 UIID With the recent update to the KONTAKT script features it is now possible to edit user interface elements in many ways Almost all of the new commands require addressing the element by it s ID
15. coding Options KONTAKT PLAYER provides you with different options concerning the copy protection process Standard KONTAKT PLAYER Library The library is delivered with the KONTAKT PLAYER engine and can be used directly out of the box If the user already owns a KONTAKT PLAYER library an additional library box will appear in the player browser after a successful installation The user can mix Instruments of all installed libraries in one KONTAKT PLAYER instance KONTAKT PLAYER libraries have the following protection e NKIs NKMs NKBs of the copy protected product can only be loaded into KONTAKT PLAYER or KONTAKT f the library is authorized or still in demo mode e Samples and graphic content of the library will be packed in encrypted NKX files KONTAKT PLAYER Developer Guide 17 Lock Option KONTAKT PLAYER libraries can be locked Meaning that even in KONTAKT the user has no access to the edit page or the samples in NKX files If you want to protect the programming work and group management concept you developed in KONTAKT this is the encoding option with the highest security Please keep in mind that the user cannot create own instruments in this library option The user can only edit the provided performance view features provided and save the instruments The gear icon indicates the locked status of the library in KONTAKT KONTAKT PLAYER always shows the gear tool because the edit view is not available fo
16. ed You ll know Saving is done when the samples missing dialog has closed Afterwards try to load all instruments and multis from their new location to make sure they load properly and find all samples 1 4 Library Information Including Instrument Options 1 4 1 Documentation Folder The documentation folder is used for any library relevant information i e Documentation txt and PDF web links video tutorials and basically anything else you can think of The contents of this folder will be listed under the library information i button displayed in the library box Please deliver all documentation in acceptable cross platform formats That means any text documents should be txt or PDF e Save all web links in webloc or url format In most browsers this Is done by dragging the url to a location outside of the window to save it Then place this file into the Documentation folder KONTAKT PLAYER Developer Guide 10 1 4 2 Readme Welcome PDF Please deliver a readme preferably PDF or txt that belongs to the library This readme can be altered to suit your needs It can be decided to also have both a Welcome PDF as in a getting started guide and a text file readme In this case it Is recommended to put any last minute changes into the readme and use the Welcome PDF as a quick start Items of the readme that might should be exchanged or updated e Product logo e Packshot e License agreement e Credits e Readme t
17. exts e Information about the library e itle graphics e URLs All changes will be performed by the OEM partner 1 4 3 Documentation Native Instruments will provide the KONTAKT PLAYER documentation in form of a Getting Started guide plus the KONTAKT manual You are however responsible for your library s documentation No product will be released without appropriate documentation You will be provided a documentation template and a documentation style guide to guide you through the documentation process Please contact Native Instruments for further information 1 9 GUI Sample developer s logo in the Library box format as described in the Info folder section wallpaper tga KONTAKT PLAYER Developer Guide 11 1 6 Library Name The Library name will be used on many occasions e the preferences com native instruments product name plist product name plist e the registry e the installer product name _Setup PC exe product name _Installer Mac mpkg e the CD DVD name e Service Center The library name should not be longer than 27 characters 1 7 Delivery Medium Please either use a DVD R single or dual CD R or Hard Drive for delivery of the Library de pending on the size of the library Burn the CD DVD as Macintosh and PC hybrid compatible KONTAKT PLAYER Developer Guide 12 2 KONTAKT PLAYER Basics 2 1 Performance View lt Flavored Kit ie _ Output st 1 Lj Yoices O Mos 32 E
18. in the script either gt Now add the following text to the script we were already using before the end on com mand set control par _ str get ui id slider01 SCONTROL PAR PICTURE exins poti 129 KONTAKT PLAYER Developer Guide 30 K Click apply and you should have something that looks like this BE B EITS 4 K 2 Output st 1 of Vorees O Mas 32 Purge neul E idi Ch A 1 g Memory 0 We can see here that the slider has now become a knob In KONTAKT 4 it is important to not view a slider as only a horizontal slider but as a skinnable object that acts like a slider ie is controlled by click and drag By adding the image of a knob we can create custom knobs that do not have to look like the default KONTAKT knobs However by skinning a horizontally controlled slider with a vertically controlled knob we Introduce a control problem We need to tell KONTAKT to change to control direction of the Slider so that the new knob acts as expected gt Add this line of code to the script set control par get ui id slider01 SCONTROL PAR MOUSE BEHAVIOUR 500 The value of 500 controls the response of the mouse In this command negative values represent vertical control and positive values horizontal control The higher the numeric value the faster the response will be The strength of these numbers does relate to the size of the control so for each control type it is best to adjust the number through test
19. ing though a value of 500 Is usually a good starting point 9 3 4 Changing the Instrument Icon As well as being able to skin certain UI elements it is now also possible to apply a custom image to the instrument icon the small graphic to the top left of every instrument or even just hide it completely You can access the parameters for the instrument icon still by us ing the set control par and set _COntrol par Str commands using the constant INST icon 1D for the UI ID KONTAKT PLAYER Developer Guide 31 Here are the lines of code you will need to customize the instrument icons e To apply a custom image set control par str INST ICON ID SCONTROL PAR PICTURE lt image name gt e To hide the icon set control par INST ICON ID CONTROL PAR HIDE 0 0 4 Preparing Image Files 9 4 1 Accompanying Text File Each image must be accompanied by a text txt file of the same name containing important Information on how KONTAKT should read this image If a text file is not provided any im age file in the user picture folder will have a default one generated If the image file is in the factory folder a text file will not be generated but the image will be read by KONTAKT as If the values were set to default Here Is an example of the content of one of these text files Has Alpha Channel yes Number of Animations 6 HOrazontal Animation n Vertical Resizable no Horizontal Resizable yes Fixed Top U F
20. ixed Bottom U Fixed Left U Fixed Right 17 KONTAKT PLAYER Developer Guide 32 What this means 1 Has Alpha Channel yes or no tells KONTAKT whether or not the image file contains a transparent alpha layer If in doubt set this to yes as this will cause no problems either way 2 Number of animations sets the number of frames in the image KONTAKT then equally divides the image using this number 3 Horizontal Animation yes or no designates in what direction the image should be split 4 Vertical Resizable yes or no If set to yes it is possible to adjust the height of the im age file in KONTAKT using the CONTROL_PAR_HEIGHT constant in the set control par command 9 Horizontal Resizable yes or no If set to yes it is possible to adjust the width of the image file in KONTAKT using the using the CONTROL_PAR_WIDTH constant 6 Fixed Top Bottom Left Rignht If you wish to be able to resize an image but keep a cer tain area around the edge intact simply set the number of pixels in the desired area In the above example the image is able to be resized horizontally but the 17 pixels on the right side of the image will not be stretched It is important to note that KONTAKT is currently very sensitive about text file line break encoding In our experience the safest software to use is Notepad on Windows This is un fortunately also true for scripts that link to external text Tiles 9 4 2 Animations Image
21. lly noteworthy is one from Nils Liberg http nilsliberg se ksp scripts tutorial Almost every parameter on the full KONTAKT edit page can be accessed from script and imple mented in the performance view When designing your interfaces keep in mind that KONTAKT PLAYER users only have access to the controls which you declare in the performance view So KONTAKT PLAYER Developer Guide 22 careful attention should be given to which engine parameters you make available While this document is meant to serve as an Introduction to KSP you should have a rough overview of basic scripting and declaring GUI elements to understand the following guide 4 2 Enabling the Performance View The call make perfview enables the performance view for the instrument You can use the command in any or all of the five script slots in the init callback Keep in mind that MIDI processing can be done in the remaining 4 slots where the signal flow goes from slot 1 thru to slot 5 meaning that MIDI events generated in slot 1 can be used to transfer information to scripts in following slots 4 3 Performance View Tabs It is possible to have up to 5 performance view tabs per instrument Furthermore each tab can have a different knob layout or graphical elements Below you see a background tga for a 3 tabbed instrument use the make perfview Command in each tab to activate performance views KONTAKT PLAYER Developer Guide 23 To addre
22. lowing requirements format png max size 100 x 22 other transparent back ground Place this logo into the Service Center sub folder e ir_samples e pictures 6 scripts If you have script controlled impulse rsponses external scripts or png graphics these T need to be part of the Info folder as well It is important to place these items into sub folders whose names should be ir_samples scripts and pictures respectively Note that all let ters are lower case 1 3 2 Instruments Multis and Samples Folders Within these folders you can use any subfolder structure you want to organize your library All Subfolders may contain subfolders and sub subfolders etc but too many subfolders many Slow down the loading process of instruments or multis For the Samples folder you MUST use subfolders Each subfolder should have around a maximum of 1000 Tiles or else browser refresh and folder opening times might be affected adversely Keep in mind that the KONTAKT PLAYER Load menus mirror the folder structure you choose KONTAKT PLAYER Developer Guide 8 e Subfolder Instruments Subfolder A containing all instrument files nki Subfolder B containing all instrument files nki etc e Subtolder Multis Subfolder A containing all multi files nkm e Subfolder Samples containing all subfolders with samples Subfolder Samples a Subfolder Samples b Subfolder S
23. ncoding process all these items will be packed into a special NKX monolith This means that the user can t access or change any background pictures and text files What follows Is a list of the items which should be in the info folder upon library delivery e Performance view images Place all performance view images Including backgrounds and knobs in the info folder All files should be in png format Note that when saving an in strument using the patch and samples option the background image will be saved into a Wallpaper s subfolder within the Samples folder Please move just this image into the into folder e LibCopyright txt contains copyright information e LibDescription txt contains library credits and is not length restricted KONTAKT PLAYER Developer Guide 7 e AbouticonLibAuthor tga 120 x 80 pixels Library About screen developer logo deliver with alpha channel e AboutlconLibrary tga 120 x 80 pixels library logo on About screen deliver with alpha channel e wallpaper tga 633 x 99 pixels displayed library browser background also known as the li brary box If using the provided Photoshop templates please deliver without the Overlay layer e Instlcon tga 33 x 34 pixels KONTAKT and KONTAKT PLAYER will automatically display this Icon when an Instrument of the library is loaded Sub Folders e Service Center for Service Center provide one company logo company_name png with the fol
24. nis Pescauesaedueesteeeveeneat 7 1 3 1 HNO eis 7 1 3 2 Instruments Multis and Samples Folders ccccccceeeeeeeeeeeeeeeeeeueeaeeas 8 1 K S IMPUSE RESPONS Seeria ETETEA 9 1 3 4 Resaving Instruments with the New Library Structure sexe e e K K e x e e 10 1 4 Library Information Including Instrument Options cc ccsccsescsesceseceeeseeeeeeseeeees 10 1 4 1 Documentation sele 10 1 4 2 Readme Welcome POE eee eee 11 E E OC UMMC LAO lbs utaate gata ateue ot crictsianueun T E 11 Me 11 a cant Gandeaawesuues wedaeeeemanannenendeaateeaaensan 11 MAG ETT e a IN isaac ace E eee vane canines snedeea verse 12 Te Dehvery Metui T 12 2 KONTAKT PLAYER BASICS nres 13 ZA Perlormmance VICW cssessesssernecsiccnaesactenineaieucdesuancesseeanessiwssiveutlacadiewensdenecanecssacdaettanenies 13 22 AMSIFUMENT Options 0 v esns aa 14 DS Ihe LDA BE OW SC ooi NA 15 2 4 Registration and Authorization in Detail cccccsssssecssccseeceseceecuseeuseeeeeseuseeeeeaes 16 29 Re T ENGOCING Toa ci 17 Library Structure and File Components sss sss ss sss sss ss sse s sees sese eenn ennenen enen 19 4 Conception of KONTAKT PLAYER Libraries From Scratch ss sss sss ss sss s esse sese ennenen 22 A SO vi TT T E 22 4 2 Enabling the Performance View sssss sss s sss ss sse s cesse sees nenen nee 23 A3 Performante VIEW TADS T 23 KONTAKT PLAYER Developer Guide IV 5 New Performance View Possibilities in KONTAKT 4
25. r any instrument KONTAKT PLAYER Developer Guide 18 3 Library Structure and File Components KONTAKT PLAYER instruments are created in the latetst KONTAKT release version The instrument consists of the samples the mapping and group settings the user interface script and the background picture The background picture is chosen in the instrument options on tab 1 Instrument Skin Bitmap Vintage_DO_Wallpaper tga The background skin can be in TGA or PNG Tile format PNG are generally smaller so we rec ommend using them Please use one of our Photoshop templates e g instrument_lrow_flat psd in the library development kit to create your library skin The library has to be delivered in a fixed Tile structure containing four subfolders O Instruments Multis I Samples Instruments Multis and Samples folders should be self explanatory Within these folders you can use any subfolder structure you want to organize your library Keep in mind that the KONTAKT browser mirrors the folder structure you choose KONTAKT PLAYER Developer Guide 19 Info Folder The info folder contains several text files and all pictures of the product including instrument backgrounds During the encoding process these will be packed into a special NKX monolith which means that the user can t access or change any background pictures and text files B AbouticonLibAuthor tga AbouticonLibrary tga E db cache hu txt ij ir_
26. s 32 Purge peu 7 E Midi Ch A 1 Memory O Select Font 0 Hello World With this we have created a KONTAKT font reference You can select a font using the value edit the font will then be displayed in the Hello World label Since some of the fonts can be difficult to see against the background of the label a button Is included to hide this back ground if necessary The text of the label and button have been center aligned to produce a neater interface As you cycle through the fonts you may notice that some do not have a centered vertical alignment It is possible to adjust this now with the scontRoL PAR TExTPOS y constant in the set control par command The value you enter for this command will add a Y posi tion offset from the top of the element in pixels For reference here is a guide with all 25 font variations Font ID amp Font ID ti Font ID 16 Font ID 21 Font 2 Font ID 7 FontiD 12 Font ID 22 Font ibd Font ID 3 Font ID 19 KONTAKT PLAYER Developer Guide 37
27. samples jdx txt LibCopyright txt LibDescription txt D pictures J Service Center vintage D Wallpaper taa The text files contain the Instrument Information e g library credits and copyright All text files have to be Unicode formatted Mac users might have to reformat the txt files OS X s standard text editor TextEdit can handle Unicode texts e LibCopyright txt Contains Copyright text and is restricted to 45 characters e LibDescription txt Contains library credits and is not length restricted faz chine Orum Selection Produced by Native Instruments The description text will show a scroll bar on the right side if necessary Line breaks are possible KONTAKT PLAYER Developer Guide 20 AbouticonLibAuthor tga Library About screen developer logo deliver with alpha channel AbouticonLibrary tga Library logo on About screen deliver with alpha channel gt KONTAKT i SOUNDPACK wallpaper tga Displayed library browser background Note that the KONTAKT is expandable small mid and large Therefore please make sure that the wallpaper is designed to accommodate this variability If using our templates please deliver without the overlay layer Instlcon tga KONTAKT and KONTAKT PLAYER will automatically display this Icon when an instrument of the library is loaded KONTAKT PLAYER Developer Guide 21 4 Conception of KONTAKT PLAYER Libraries From Scratch KONTAKT PL
28. ss the different backgrounds use the command set Skim OECC Oriser IN pixels whereby offset can also be done with an operator as such U 255 1 255 and so on Customizing the Performance View There are a few options which are useful for customizing your library s user interface controls thus making It look even more original This is accomplished by way of hiding KSP s standard GUI elements and in turn incorporating them into your background tga files e The elements whichbackground of knobs labels value edits and tables e value of knobs e title of knobs e mod ring light of knobs The command necessary for this Is hide part lt control variable gt lt hide mask gt wherein lt hide mask gt IS a bit by bit combination of the following constants SHIDE PART BG SHIDE PART VALUE SHIDE PART TITLE 6 SHIDE PART MOD LIGHT The first mentioned constant sHIDE PART BG can be used on knobs labels value edits and tables 77 SHIDE PART VALUE SHIDE PART TITLE and SHIDE MoD LIGHT Can only be used on knobs KONTAKT PLAYER Developer Guide 24 If you want to hide a knob s background and title but keep its value you would use on init make perfview declare ui Knob RHO 0 100 1 hide part Knob SHIDE PART BG or HIDE PART TITLE end on Please note the bit by bit or operator or In this example Without the dots before and after or it would not be
29. the basic on off In this case just triplicate the two on off animations to bring the total up to six KONTAKT PLAYER Developer Guide 34 5 4 3 Tables It is also possible to edit the appearance of tables in KONTAKT 4 but there are some behav iors to take note of Hiding the background of a table will remove a label from behind it but the semi transparent bars of the table will remain This is illustrated here Example of a table with background Example of the same table with the background hidden Changing the color of the bars using the constant sconTROL PAR BAR COLOR requires a hex value to specify the color The hexadecimal value needs a 9 placed at the start and an h placed at the end in order for KONTAKT to read it as a hexadecimal number and not a String This will give you an 8 digit color code reading like 9FFOOOOh which represents red Changing the color of the bars also changes the color of the semi transparent background 5 4 4 Fonts KONTAKT 4 now has a collection of 25 font variations to choose from for any UI element that uses text These fonts are hard coded into the program so you cannot use any custom fonts outside of this collection The fonts are selected using the SCONTROL PAR FONT TYPE constant In the set control par Command followed by a vale from O 24 The text alignment can also now be adjusted using the sconTROL PAR TEXT ALIGNMENT constant followed by a value trom O 2
30. working because it would be recognized as logical operator by the KSP T Please note hide part Is only available in the init callback Here s a simple example of the various combinations 0 a rans parent Script Controls KONTAKT PLAYER Developer Guide 25 5 New Performance View Possibilities in KONTAKT 4 This guide introduces some of the new Performance View options made available by recent updates to KONTAKT s script language It will cover how to use most of the new commands as well as offering some examples of them in practice It is possible to still use the older performance view options offered by earlier versions of KONTAKT which may be preferable if you do not have access to good instrument interface design resources and need a simple way to produce instrument controls 9 1 Editing Ul Elements by Pixel In KONTAKT 4 it is now possible to edit and move user interface elements In pixels rather than by the previous grid system Most of the Ul commands for moving and resizing have been updated with pixel versions that mostly follow the rule of adding px to the end of the older commands check the KSP reference manual for a full list of new pixel based commands Example Positioning a UI element 1 by grid move control lt ul name gt lt x y coordinates by grid gt 2 by pixel move Control pxu name gt lt x y coordinates by pixel gt It is Important to note that there can be issues when using com
Download Pdf Manuals
Related Search