SDK Update – 21/6/18

We’ve just pushed an update to the Jukebox Unity Client SDK ( intended to make it simpler, clearer and more flexible to use.

Key changes are as follows:

  1. The same Jukebox plug-in assembly, Jukebox.dll, now works across all platforms and Unity versions. Previously there needed to be different versions of the DLL for Mac and Windows, and for different versions of Unity; but this has now been unified to a single plug-in version.

However, it is important that if you use this new plug-in DLL, you also update your Unity project to use one of the latest Jukebox SDK packages, as the plug-in requires some code that has been added to all these packages.

  1. The code in the Demo packages has been partitioned more explicitly. The packages now have Jukebox scripts in the following structure:
    1. Scripts/Jukebox contains Jukebox scripts that are intended for use as-is: you should not need to change these scripts when integrating Jukebox with your game. Included in this directory are the JukeboxControl and JukeboxPlaylist scripts present in previous versions of the SDK packages.
    2. Scripts/ contains three example scripts (fewer if you install the minimal package) as follows:
  • ExampleTrackInfoRender.cs: illustrates how to expose track metadata within your game’s UI. This is included in all demo packages.
  • ExampleUserConfigDialog.cs: illustrates how to connect an in-game User-Music-Preferences dialog box to the Jukebox plug-in. This is included in full_example_app.unitypackage and minimal_with_user_config_example_dialog.unitypackage
  • ExampleMusicControl.cs: illustrates how to switch between playlists. This is only included in full_example_app.unitypackage
  1. The JukeboxControl component has been upgraded to allow you to either specify hot-keys for user feedback using the Unity IDE (for quick and easy integration), as well as providing new methods to call to send user-feedback if the game implements custom music feedback controls.


To use this update, please remove all Jukebox SDK scripts from your project and then re-import the appropriate package. The new packages also include the plug-in DLL, as it should now work for all platforms; although this is also provided separately under the ‘plug-ins’ subdirectory.


As always, please send any feedback or questions you have to this

Leave a Reply

Your email address will not be published. Required fields are marked *