From 0ab0026d410f94cb1006bffa3a5bf901d1d4285f Mon Sep 17 00:00:00 2001 From: erikrichardlarson Date: Sat, 3 Jul 2021 12:53:46 -0700 Subject: [PATCH] Update README.md --- README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ecafbb6..1002a25 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ -# unbox - rekordbox / Serato / Traktor / VirtualDJ / Denon / Mixxx "Now Playing" overlays for Twitch / OBS +

unbox

-Display your current or recent rekordbox / serato / traktor / virtualdj / denon / mixxx tracks to your viewers on Twitch. Inspired by PRACT OBS and ASOT. +

+ Display your current or recent tracks to your viewers on Twitch, integrates with OBS and the ID? Twitch extension
+

Supported Platforms
rekordbox | Serato | Traktor | Denon | VirtualDJ | Mixxx

+

- + Screen Shot 2021-07-03 at 12 43 29 PM +

**Please back up your library before using this as corruption could occur, we're not responsible for any issues, or corruption that this software may cause to your library.** @@ -24,7 +28,7 @@ If unbox is useful to you and you'd like to support future development, please f

## How to use -1. **Download the unbox desktop app.** Here's the mac version: [Mac Download](https://github.com/erikrichardlarson/unbox/releases/download/8.3/unbox-mac.zip) and here's the windows version: [Windows Download](https://github.com/erikrichardlarson/unbox/releases/download/8.4/unbox-windows.zip) Currently there is support for rekordbox 5 / 6, Traktor, Serato, and VirtualDJ. +1. **Download the unbox desktop app.** Here's the mac version: [Mac Download](https://github.com/erikrichardlarson/unbox/releases/download/9.0/unbox_mac.dmg) and here's the windows version: [Windows Download](https://github.com/erikrichardlarson/unbox/releases/download/9.0/unbox_windows.zip) **Extra step for Traktor users only: If you're on Traktor, you also need to download this [D2 file](https://github.com/erikrichardlarson/unbox/releases/download/7.0/D2.zip), unzip and just 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. There is a D2 folder already in this CSI directory so it's best to make a backup of that. And if you don't own a Kontrol D2, go to Controller Manager in your preferences, click Add beneath the device dropdown, and add Traktor then select Kontrol D2. I would automate this for you but permissioning makes it tricky, sorry Traktor users.** @@ -37,15 +41,15 @@ If unbox is useful to you and you'd like to support future development, please f 3. **Just keep unbox open when you're playing.** Now that unbox is open, you have access to a few things: -* Browser sources. The browser sources are just web pages that unbox automatically updates when it's open. The dropdown on the second step of the app gives you all available sources, on the third step of the app you can copy the link to your clipboard. For example you can add: http://localhost:8080/history.html or http://localhost:8080/asot.html. Below you can see what these browser sources look like. If rekordbox / Serato / Traktor is on a different computer than you're streaming OBS on, you can grab the IP address of the computer running unbox / rekordbox / Serato / Traktor and use that in place of localhost for your browser source urls. You'll need to have both machines on the same network to make this work. The now playing overlay could look something like this: http://192.168.0.1:8080/asot.html +* Browser sources. The browser sources are just web pages that unbox automatically updates when it's open. The dropdown on the second step of the app gives you all available sources, on the third step of the app you can copy the link to your clipboard. For example you can add http://localhost:8080/asot.html. Below you can see what these browser sources look like. If your DJ software is running on a different computer than you're streaming OBS on, you can grab the IP address of the computer running unbox / your DJ software and use that in place of localhost for your browser source urls. You'll need to have both machines on the same network to make this work. The now playing overlay could look something like this: http://192.168.0.1:8080/asot.html -* Three txt files. You also have access to a "rekordbox_stream.txt" file in your home directory in a folder called unbox_output. You can add this as a text source in OBS, it updates in real time so you can display a plain text view of the current playing track. The other two files are artist.txt and track.txt which are just the artist and track separated. +* Three txt files. You also have access to a "unbox.txt" file in your home directory in a folder called unbox_output. You can add this as a text source in OBS, it updates in real time so you can display a plain text view of the current playing track. The other two files are artist.txt and track.txt which are just the artist and track separated. * To use KUVO live playlists. Just paste in your user id, click get playlist, and we'll find your latest playlist. -

- -

+4. **Integrate with Twitch Panel Extension** + +* To integrate with the Twitch panel extension you'll need to subscribe to Unbox Pro, this can be done in step four in the Unbox app. Once subscribed you'll get a unique token on each login to Unbox, you can enter this token into the configuration page of the Twitch extension and your tracks will now automatically appear in the Panel Extension. Up to 20 tracks will be displayed to your viewers, and remain there after you close Unbox. This way if your viewers show up late to your set, or miss your set they can still see what you've played. ### Customize