erikrichardlarson/unbox

Log and display your rekordbox / Serato / Traktor / VirtualDJ / DJUCED / Mixxx / djay Pro tracks as they're played

unbox

Display your Rekordbox, Serato, Traktor, VirtualDJ, Mixxx, DJUCED, and djay Pro tracks to your viewers on Twitch

Our Supporters

Setup

Unbox is designed to be simple to use while providing the most accurate track metadata software. Download the app, unzip, launch, pick your mode, and copy the URLs into OBS. If you encounter any issues, please create an issue here, and we'll respond ASAP.

1. Download and install the Unbox desktop app. Here's the Mac version and the Windows version.

2. Launch the app and select Your DJ Mode. Simply select the mode that corresponds to your DJ software.

3. For VirtualDJ or Traktor users, we have plugins that allow Unbox to follow the master channel.

• For Traktor, download this D2 file, extract it, and place it in your CSI folder located at C:\Program Files\Native Instruments\Traktor Pro 3\Resources64\qml\CSI on Windows or /Applications/Native Instruments/Traktor Pro 3/Traktor.app/Contents/Resources/qml/CSI on Mac. Then, open Traktor and select D2 as your controller: Traktor > Settings > Controller Manager > Select D2 from dropdown.

• For VirtualDJ, download our Windows plugin or Mac plugin, extract it, and place it in your SoundEffect Plugins folder. This is located at C:\Users\YOUR_USERNAME\Documents\VirtualDJ\Plugins64\SoundEffect on Windows or /Users/<USER>/Library/Application Support/VirtualDJ/PluginsMacArm on Mac. This plugin will be available in the Sound Effects dropdown in VirtualDJ as "WindowsUnboxPlugin" or "MacUnboxPlugin". Select the plugin in the dropdown:

Usage

• Available Overlays: Unbox offers two overlays: a track overlay at http://localhost:8001/unbox_overlay.html and an album overlay at http://localhost:8001/album_art.html. The track overlay displays the Artist, Title, Remixer, and Label. The album art overlay shows the album art, if available, or if found through Unbox Plus.

• Unbox Plus: Unbox Plus supplements your existing track metadata with corrected metadata or missing metadata via our metadata API. It also provides up to 500 recommended tracks based on your tracklist history.

Contact Information

If you encounter any issues, you can post them here, or you can reach me at [email protected].

unbox's Issues

Multiple tracks

If multiple tracks are playing at the same time in Rekordbox it seems only one shows in Now playing, is there an obvious way to resolve this?

Unbox stops updating randomly with Denon Prime 4

I'm having an issue while using Unbox on Windows 10 Pro with my Prime 4

At random times the tracks will stop updating, and it'll be stuck on the latest track.

Using Force Restarts, or restarting the application usually fixes the issue, but is there something I can do to minimize the chance of it freezing on a track?

I'm not getting any obvious error messages with the latest release, whereas there used to be a Javascript error with the previous releases.

Not working with Traktor 2

It’s not working with Traktor 2
I’ve installed the D2

Why is the twitch login required?

Hi

Why was the twitch authentication added?
Why is it required? No opt out.

With kind regards.

Issue - this feature looks so good, I kind of wanna lick it.

Please add lickability feature.

https://www.youtube.com/watch?v=u8953JvWuDw&t=2118s

Unable to get track info display in html files

I cant seem to get the http://localhost:8080/play_history.html or http://localhost:8080/now_playing.html to display any track information. The page loads with the "now playing" banner but just no info. The app itself is displaying the current playing track and I see info in the text and json files getting updated. Anyone else run into this? Since I stream from a separate computer, I'd like to bring up the browser on that PC to display the info in OBS, but obviously need to get working locally first. Thanks.

JavaScript error

Haven't actually tried it but possibly consider something like this?

unbox/src/index.js

Line 394 in 5e783f5

const path = pathLib.join(os.homedir(), 'Music/_Serato_/');

const path = pathLib.join(os.homedir(), (process.platform === 'win32') ? '\\Music\\_Serato_\\' : 'Music/_Serato_/');

Javascript error mac version

When opening the app and getting the options to choose the software, as soon as I select 'Rekordbox DB' I get a javascript error:

Uncaught Exception:
Error: EROFS: read-only file system, open '/private/var/folders/9d/3b_75sn5571_97f7gk73_ltr0000gp/T/AppTranslocation/7B741CC5-E040-4AB7-AC13-44487304E758/d/unbox.app/Contents/Resources/app/src/config.json'
at Object.openSync (fs.js:440:3)
at Object.func [as openSync] (electron/js2c/asar.js:140:31)
at Object.writeFileSync (fs.js:1265:35)
at IpcMainImpl. (/private/var/folders/9d/3b_75sn5571_97f7gk73_ltr0000gp/T/AppTranslocation/7B741CC5-E040-4AB7-AC13-44487304E758/d/unbox.app/Contents/Resources/app/src/index.js:271:10)
at IpcMainImpl.emit (events.js:223:5)
at WebContents. (electron/js2c/browser_init.js:173:8161)
at WebContents.emit (events.js:223:5)

When I then select a layout (eg. ASOT) I get the same JS error.

From here it all works fine though so just wanted to let you know.

The Windows version doesn't have this problem.

Rekordbox real time

You got back to me on Reddit when I asked about this but I'm still having an issue.

I'm on Windows and when I run the real time option I get the box pop up that has the launch button. Initially it didn't do anything but I then noticed the path to the .exe by default looks for version 6.0 but I have Rekordbox 6.5. so I changed this to 6.5 so it matches my .exe file. If Rekordbox is open hitting launch doesn't do anything at all. If Rekordbox is closed and I hit launch, Rekordbox opens but as soon as it's loaded up it shuts itself again.

Is this because this is only compatible specifically with 6.0?

I'm not sure the launch button is actually doing anything when I click it, should it change to something other than 'launch'?

Virtual DJ not working

1st of all great program been using it with rekordbox fine on windows & mac but can't seem to get it working with virtual DJ just nothing is happening

Error

Uncaught Exception:
Error: ENOENT: no such file or directory, open '/Users/djmelodie/Library/Application Support/Pioneer/rekordboxAgent/storage/options.json'
at Object.openSync (fs.js:440:3)
at Object.func [as openSync] (electron/js2c/asar.js:140:31)
at Object.readFileSync (fs.js:342:35)
at Object.fs.readFileSync (electron/js2c/asar.js:542:40)
at PlayHistory.getRecentTracks (/private/var/folders/4v/lvj1zyfd1q3g3pyzbl3215wr0000gn/T/AppTranslocation/F5268397-194D-4198-B615-19BD213463F2/d/unbox.app/Contents/Resources/app/src/index.js:299:35)
at PlayHistory.persistHistory (/private/var/folders/4v/lvj1zyfd1q3g3pyzbl3215wr0000gn/T/AppTranslocation/F5268397-194D-4198-B615-19BD213463F2/d/unbox.app/Contents/Resources/app/src/index.js:344:10)
at Timeout._onTimeout (/private/var/folders/4v/lvj1zyfd1q3g3pyzbl3215wr0000gn/T/AppTranslocation/F5268397-194D-4198-B615-19BD213463F2/d/unbox.app/Contents/Resources/app/src/index.js:393:28)
at listOnTimeout (internal/timers.js:531:17)
at processTimers (internal/timers.js:475:7)

Update Rate of checking for new track

Hi, is there an option that I can change to make the application check more frequently for a new track? It looks like it takes about 70 seconds or so to refresh at the moment. Or, is this a Rekordbox thing?
Thank you.

Twitch Login?

I just tried to pull the latest release, and notice it now requires a twitch login. I don't see anything detailing why this is necessary?

Seems odd for this kind of software to require a third-party login. Can anybody explain why this is a thing?

Rekordbox 6.5.1 it close after launch "real time" options (WIN10)

Hi all.

It's my first time with the program, i'm been looking for this solution for a long time and i would likme to use the real time option with Rekordbox.
But when I press "Launch" on the "Rekordbox Song Exporter" module, even when the Rekordbox aparently open propertly, it close few seconds after. I can't do anything.

Please tell me what you need from me to help to solve this "issue". I'm useing Rekordbox 6.5.1

Thanks in advance.
Danny

Errors with Mixxx on a Mac (10.14.6)

I'm getting Javascript errors when trying to run unbox with Mixxx. When I first select "Mixxx" I get this error:

If I click "OK" and "Continue", I get this error:

If it helps, on a 2019 15-inch Macbook Pro, running OSX 10.14.6.

My Mixxx version is: 2.2.4 (build 2.2 r6798)

I would loooooove to get this working (especially if I can send the data to the computer that uses OBS). It will make ID-ing tracks during my online sets so much easier!

Thanks!

Mac - Is Unbox supposed to take up 1.4GB in space? (Puppeteer folder)

Seems heavy for the app. Somehow that folder is 931mb on its own.

When I drill further it is in

• Chromium Framework.framework
  and then both
• Chromium Framework (201mb)
• Versions (617mb)

If its necessary to make it work then that's fine - it just seems heavy storage for the app.

Error with Rekordbox 5

This only happens when on the Rekordbox radio button and ive entered my Kuvo live url to track.

Get this error

Uncaught exception:
Error: ENOENT: no such file or directory, open
Then it points to rekordboxAgent\storage\options.json

Any ideas?

Is it required i go to rekordbox 6?

Small overlay in OBS

Hello, first of all, thank you very much for the information ... I want to tell you the following, I have mac and rekorbox, I did the whole procedure for Kuvo and when I go to add the URL of unbox in OBS the overlay appears so small that you see a very thin line, it is as if it were on a very small scale, I did tests with other urls and the result is normal ... I wanted to check the url of unbox, for example http: // localhost: 8080 / asot.html opening it in chrome and it looks good, and it is updated as the songs are played ... I don't know the problem, thanks for attending, greetings

Traktor pro 3 DVS problem

Hi, exellent work!
Traktor pro 3 only works with play/cue option, do not work with DVS playing.

Unbox For Traktor Pro

I am having this issue with the application and this shows up

I am using Traktor Pro 3 on a Mac. Please help.

Source code not updated

Yo! The new release is wonderful, thanks for working on this! Are you planning to update the source code?

Unbox Rekordbox in export mode?

Hi,

Is it possible to run unbox with Rekordbox in export mode?
Then I'm open the software, I don't get any information from my Rekordbox, I use only PC with Windows.

Lag time on Now Playing

It seems to take at least 1 minute for the Now Playing track to update. Any way to reduce the latency?
BTW This works absolutely great otherwise... fabulous.
Thanks,
Nick

Rekordbox display idea (OBS)

Hey,

first let me say AWESOME work! i searched for a tool like that over 2 years (without to have a 2nd PC).

But i have a problem with the display info in OBS...i loop my tracks and like it to let them run from the drop (for beatmatching etc) before i mix the track. And here is the problem...your program shows the track info already before it mixed in (when it runs to long).
Is there a alternative to handle that?
Maybe something like the new Track must reach a special level of loudness (fader moving) or when you hit the Button from the deck (stop playing)?

Best Regards
Dave

Unable to run on 2015 MacBook Pro with MacOS Monterey

Hi there! Trying to run this on my late 2015 MBP and it's not letting me start the app. Running the latest Monterey Dev beta. From what it looks like, is this possibly compiled just for M1 Macs? I'd love to get this working, it look very promising and awesome.

Multiple tracks playing on rekordbox

If multiple tracks are playing at the same time in Rekordbox it seems only one shows in Now playing, is there an obvious way to resolve this?

Call external API when Track changes

I have an automated streaming Setup, with Macros and so on, all running as a NodeJS server. Part of this setup is to display lower thirds with song information. I wanted to write something like this myself and almost got it to work when I found your project.

Would it be possible to send out the currently Playing Tracks (tracks where the player would have the white border in Rekordbox) via a REST API to some server? Might probably be extremely easy, would also do a PR if appreciated.

High CPU spikes when using KUVO mode

Hi

Unbox 8.1
When using KUVO mode, every ~10 seconds unbox spikes on all threads.
This does not happen in DB mode. There you just have a small spike on a single thread.

I know it's just short and not much compared to OBS / Rekordbox itself. But it should just be a simple http get?
There might be space for improvements :)

Sometimes, when you go from KUVO to DB without closing, it seems to continue? Might still pull data even though we switched mode?

With kind regards.

Track data changes early

I noticed that as I'm playing the next track on the headphones getting ready for the mix (as you do) even this can trigger the data to update.

So it seems to start that 60 second countdown as soon as I hit play on the track I'm mixing in but really it would be much better if the track data only updated once the cross fader is completely across to the next track. I don't know if this is even possible as I guess your limitations are down to what Pioneer actually offers (I'm using Rekordbox)

Denon mode: ability to operate with channel faders < 100%

Fantastic work on this - one feature request would make it perfect for me: Would it be possible for it to have an option to pick up track changes where channel faders are < 100%? I generally mix with the crossfader and generally have channel faders at < 100% during normal operation.

Thank you!

Hard to see if KUVO URL is valid and being used

• I start the app
• select Rekordbox
• enter KUVO url
• Does it now get the data from KUVO or rekordbox DB?
• Do I just paste it in or do I have to unfocus the input field? (Klick somewhere else)

Maybe make it a separate service and not under rekordbox? Should not matter what software is pushing the song to KUVO.

Now Playing Denon only reads from deck 2 on Prime Go

All events are being read from both sides, but when loading a track onto deck 1, it instead copies the name from deck 2
from denon_poller.exe - loading a song onto deck 2:

2021/03/10 20:34:34 169.254.150.175
2021/03/10 20:34:34 169.254.150.175
2021/03/10 20:34:34 169.254.150.175 Gloria Estefen & Miami Sound Machine
2021/03/10 20:34:34 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)
2021/03/10 20:34:34 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)
2021/03/10 20:34:34 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)
2021/03/10 20:34:34 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)

loading a different song onto deck 1:

2021/03/10 20:34:34 169.254.150.175
2021/03/10 20:34:34 169.254.150.175
2021/03/10 20:34:34 169.254.150.175 Gloria Estefen & Miami Sound Machine
2021/03/10 20:34:34 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)
2021/03/10 20:34:34 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)
2021/03/10 20:34:34 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)
2021/03/10 20:34:34 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)
2021/03/10 20:36:21 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)
2021/03/10 20:36:21 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)
2021/03/10 20:36:21 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)
2021/03/10 20:36:21 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)
2021/03/10 20:36:21 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)
2021/03/10 20:36:21 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)
2021/03/10 20:36:22 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)
2021/03/10 20:36:22 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)
2021/03/10 20:36:22 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)
2021/03/10 20:36:22 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)
2021/03/10 20:36:22 169.254.150.175 Gloria Estefen & Miami Sound Machine Conga (12″ Dance Mix)

It is able to read that a song is being loaded, but it seems to read the track title from deck 2 instead of deck 1

The caption does not appear on OBS

Hi everyone,
i have installed UNBOX and am using it on WIN10 and Serato.
UNBOX seems to work fine, in fact I see the flashing green dot of the LIVE GO and I have the links (both localhost and IP address), I also have the local web page with the caption that works regularly.
The problem comes with OBS.
I describe step by step how I proceed:

• I open OBS
• I add a new scene
• I add "Browser"
• paste the localhost link generated by UNBOX
• OK on the window.
  Unfortunately nothing appears.
  OBS is also up to date

Amazing work! + Feature requests

Just found out about this. Really nice work! I've genuinely been worried I'd have to type these in somewhere and naturally left it. There is a version of this that only really works well on CDJs with an ethernet port when using them with USB and you have totally covered everyone working on controllers/home systems which is - by far - more users.

I'm not remotely into coding and have barely heard of Github except to add something to OBS once before. I'm over the moon that you have made this with all the different ways to connect to kuvo / other computers.

I have some feature requests:

1. Font changer for each line built in. Ability to choose Capitalization, Bold, Italic.

2. Ability to add album Artwork (and change the size it appears)

3. Left Justify, Right Justify, Centre Justify

4. Ability to Specify where the text appears (1 line, 2 line)

I've written this out how various DJs might love using this.

e.g.

1 line version

Artist - Title (Remix) [LABEL]

2 line version

Artist - Title (Remix)
LABEL

3 line version

ARTIST - TITLE
(REMIX)
LABEL

4 line version
ARTIST
TITLE
(REMIX)
LABEL

5. The Kuvo method is a bit smashed up* because of an issue at Kuvo's end I think. If you can somehow get Unbox to listen to what's sending info from Rekordbox to Kuvo at an earlier stage, that might fix it because their website isn't working correctly in Live mode (either doesn't start, or after 10-15 minutes stops working) and we appreciate you have no control over Kuvo.

*technical term

I am also going to donate as I'm super grateful for the effort this must have taken just to get to version 1.

Really happy, thank you so much.

Unbox not reading Serato history

I got it to bypass the java error code by moving app to my desktop.
But now it says my last logged track is something I havent even loaded onto my serato in years.
how do i correct this? I wont change no matter which track i load.
I am using serato dj pro is that the reason?

MacOS OBS browser plugin CSS workaround

It seems that MacOS version of OBS has little trouble in rendering the CSS correctly. There is very little information about this, but following forum post hinted to right direction: https://obsproject.com/forum/threads/css-of-browser-source-rendering-wrong.133496/

For example, I get the coloured header boxes rendered incorrectly (not completely filled, "Now Playing" divided on two lines). Since unbox uses bootstrap and is up-to-date but OBS browser not, the workaround is to inject custom CSS such as:

.col-3 {
    max-width: 40%;
}

[Feature request] Use KUVO user page instead of playlist, to automatically get latest playlist.

Hi mate. Grate software.

Would be great if I could use the KUVO user URL
For example: https://kuvo.com/user/XXXXX/djmix or https://kuvo.com/user/XXXXX or maybe just XXXXX?
And from that unbox can find the latest playlist.

If unbox now remembers the value the user would not need to enter or adjust anything on startup. Setup once, use many times.

Also it seams unbox does not remember any setting. (Color, program etc.) Is that a bug or do you want me to create a separate feature request?

SQLITE_CANTOPEN With Mixxx 2.2.4

On Windows 10, C:\Users\USER\AppData\Local\Mixxx\mixxxdb.sqlite is present.

M1 Mac issue “unbox” is damaged and can’t be opened.

I get this message when I'm initially attempting to get the app open after download. My permissions on System and Security are set to "anyone" and I tried the previous version but Java issues popped up every time I made an attempt to click anything. Is there any current documentation pertaining to M1 issues that I missed?

Here's the message from the previous version::

Uncaught Exception:
Error: EROFS: read-only file system, open '/private/var/folders/jg/r4h95n9176g7l90p3hqzdn780000gn/T/AppTranslocation/A0F86864-C80A-436A-A727-26E65096A15E/d/unbox.app/Contents/Resources/app/src/config.json'
at Object.openSync (fs.js:440:3)
at Object.func [as openSync] (electron/js2c/asar.js:140:31)
at Object.writeFileSync (fs.js:1265:35)
at IpcMainImpl. (/private/var/folders/jg/r4h95n9176g7l90p3hqzdn780000gn/T/AppTranslocation/A0F86864-C80A-436A-A727-26E65096A15E/d/unbox.app/Contents/Resources/app/src/index.js:374:10)
at IpcMainImpl.emit (events.js:223:5)
at WebContents. (electron/js2c/browser_init.js:173:8161)
at WebContents.emit (events.js:223:5)

windows 10 rb 5.85 A Javascript error occurred in the main process

I've got to specify that my rb library is synced between two computers using dropbox. I followed this tutorial
https://forums.pioneerdj.com/hc/en-us/articles/115005245643

How to get text to be in 2 lines only

How to get text to be in 2 lines only but extended out. There are some tracks that are long and it display in 3 or 4 lines and it smooshes it

Javascript Error - Virtual DJ

I have tried running Unbox with Virtual DJ and keep receiving this error:

I did double-check to make sure the tracklist.txt file was there so I'm not exactly sure what the issue may be.

Now Playing in Serato/Win 10 displays next (cued) track when loaded instead of track still playing

When a song is playing, Now Playing shows the right song, until I load a new song onto the other deck. As soon as it is loaded there - not playing yet - Now Playing shows this new song instead of the song that is still playing.

Win 10/Serato

PS the instructions on the main page aren't for Win and are a little confusing; the localhost links you give there don't seem to be valid filenames for windows, and there aren't multiple steps in Win/Serato setup. :)

Where i can get Unbox Pro token

Where i can get Unbox Pro token ? I see extension is installed on my twitch channel but in config i must paste Unbox Pro token.

Unable to open Database file with Mixxx 2.3.0

Hey there,

It was working great with Mixxx for a while, but I just updated and I'm getting this error saying it can't open the database file:

When I installed the new version of Mixxx, I had to enable some sort of access in system preferences because of "sandboxing" in the newer versions of OSX? I'm wondering if that might be the culprit.

A JavaScript Error occured in the main process

First: I love the new UI and the options you can choose from! <3 Thanks for that!

This is my error window:

A JavaScript error occurred in the main process

Uncaught Exception:
Error: EROFS: read-only file system, open '/private/var/folders/z5/zfh080gs4653dv1jrnc_xzqh0000gn/T/AppTranslocation/4C9327B1-CA95-4C35-9474-F1675FBD42B7/d/unbox.app/Contents/Resources/app/src/config.json'
    at Object.openSync (fs.js:440:3)
    at Object.func [as openSync] (electron/js2c/asar.js:140:31)
    at Object.writeFileSync (fs.js:1265:35)
    at IpcMainImpl.<anonymous> (/private/var/folders/z5/zfh080gs4653dv1jrnc_xzqh0000gn/T/AppTranslocation/4C9327B1-CA95-4C35-9474-F1675FBD42B7/d/unbox.app/Contents/Resources/app/src/index.js:271:10)
    at IpcMainImpl.emit (events.js:223:5)
    at WebContents.<anonymous> (electron/js2c/browser_init.js:173:8161)
    at WebContents.emit (events.js:223:5)

I get it that it's read-only, but it's not unbox, that folder is read&write...

How can I solve this issue?

Cheers for your hard work on that awesome project!

PS.: Using unbox here: www.twitch.tv/dannygrunowofficial

No issue - Kudos

So I've been using this for about a month now. After a few very minor complaints on my part, @erikrichardlarson you knocked it out of the park with this. No where else has anyone been able to get track ID from rekordbox. It is working great. Many DJ's are asking me how I did it and I just send them here. Thank you so much.

Now playing in Denon Mode

Hi,
so i just downloaded unbox for windows started my denon prime 4 in standalone mode and then i started unbox and configured it how i like it. selected asot. inserted the local host url and added it to my obs overlay. but all i see is the now playing text and nothing else.
did i something wrong?

The name of the track changes during the pre-listening

Hi everyone,
I use Serato and Win 10 with a Denon MCX8000.
Everything works regularly, but when I start the track that has to enter (in pre-listening), the caption changes, but in reality I'm just listening to it in the headphones.
How can I do?