Tuna v1.9.9

A basic part of this plugin is the ability of OBS to load both image and text files from disk. If you do not know how that works it is strongly recommended that you familiarize yourself with both the image and text source first:

The first step is to install the plugin for which you'll have to follow the installation steps for your platform:

After you've installed the plugin you should see a new option in the Tools menu:
If it does not show up it means that either the plugin wasn't installed correctly or that OBS couldn't load it. In that case an obs studio log is necessary to help fix the issue.
After you click on the menu this dialog will open:

1. This is the path to which Tuna saves the cover of the currently playing song. You can leave the default or change it via the "..."-button to a different path if you want. Just remember it later when you add an image source for the cover.
2. If you uncheck this checkbox Tuna will not download the cover of the currently playing song
3. If you check this option Tuna will attempt to look for covers by querying Apple's iTunes servers. This will use the album and artist of the currently playing song to search for matching album art. This means that the art that is found might not be exact. You can also choose the resolution that should be downloaded.
4. If this option is enabled Tuna will remove file extensions from song titles (e.g. .mp3, .wav, .flac etc.). This is useful if you play music through the VLC Source and the songs do not have any metadata saved. In that case VLC will use the entire filename as the title, including the file extension.
5. With these buttons you can add, remove and edit format outputs. They'll be described shortly.
6. Enable this option if you want to use the user script which allows Tuna to receive song information from your web browser or if you want to use the browser widget.
7. All output text files will contain this text if nothing is playing
8. Here you can switch between the different supported music sources. Tuna will use the selected one to look for the currently playing song.
9. This is the rate at which Tuna will refresh song information
10. With these buttons you can start and stop Tuna. If the plugin is stopped it will not look for song information and it will not update the outputs.

Since the information is displayed through text sources, which read text from files on your computer you have to configure Tuna to tell it to create these text files and what should be in them. In the main dialog under the "Basics" Tab you can add, edit and remove outputs:

Adding or editing outputs will show this dialog:

The first option defines where the information is going to be saved. Click the "..."-button to select a file path. After that you have to define what information the text file is going to contain. The dialog gives you all options that are supported by Tuna, but keep in mind that not every music source provides all information.

If you want to display the artist and the song title you would enter "{artists} - {title}" into the textbox at the bottom without the quotes. {artists} and {title} will be replaced by the artists and the title of the currently playing song. So the text file would for example contain "Rick Astley - Never Gonna Give You Up". If a song features multiple artists it will list all of them separated by commas (provided that the music source provides all artists). If you only want the first artist to show up you would use {first_artist}. If you use a formatting option that isn't supported by the currently selected music source the plugin will notify you.

The plugin also has the option to capitalize all letters. If you use {TITLE} instead of {title} the file would contain "Rick Astley - NEVER GONNA GIVE YOU UP". You can also limit formatting options to a certain amount of characters. {TITLE:10} would make sure that the song title will be cut off after ten characters so the file would contain "Rick Astley - NEVER GONN...".

If the "Chat log mode" option is enabled Tuna will append the currently playing song at the end of the file so if you are currently paying "Never Gonna Give You Up" and then switched to "Whenever You Need Somebody" the file would contain:

Rick Astley - Never Gonna Give You Up
Rick Astley - Whenever You Need Somebody

Click to expand...

When you've set up the output click "OK" to save it. Then click "Apply" in the main dialog to apply the changes.

After you've setup the cover path and the song outputs it's time to setup the music source. Here you can find tutorials for the supported sources:

Now that you've setup the correct output and selected it in the basics tab you can add an image source for the cover:

and as many text sources as you have configured song outputs:

You can also drag and drop text and image files into obs studio to automatically create the sources.

The placeholder image is saved under C:\Program Files\obs-studio\data\obs-plugins\tuna\placeholder.png or ~/.config/obs-studio/plugins/tuna/data/placeholder.png. It can be replaced with a transparent png if you don't want anything to show when nothing is playing.

Modify the bounding box type to "Scale to inner bounds". Other scaling types might also work for you, but the default of "No bounds" means that the image source will change its size to whatever image is currently loaded. Additionally you might wan to change the positional alignment to "Center". To change the type select the cover image source, press Ctrl+E and then change the dropdown:

Open or close the dock by selecting View > Docks > Music control. You can also close the dock via the 'x' button when it's undocked or the UI is unlocked. Rightclick anywhere in the dock window to set what information you want displayed.

There's also a lyrics (lyrics.htmi) overlay which will display synchronized lyrics via Musixmatch. The music source has to provide the current progress (Spotify, VLC, MPD or Web Browser) of the song for this to work.