Note: This document is a bit out of date at the moment, will update it soon.
If you have not already done so, download and install the latest version of OpenKJ.
First, we'll start off by adding your song collection to the database. Your collection will need to be named in a predictable way in order for the import to work properly. This documentation will assume that you already have karaoke files and that they are named with one of the supported naming conventions.
In OpenKJ, go to the Karaoke menu, then select “Manage Karaoke DB”.
The karaoke database management dialog will appear, as seen below
Click add, you will be prompted to select a directory to add. This should be a directory where you have your karaoke zip files, video files, or paired mp3 and cdg files. This dialog will look different based on which operating system you are using (Linux, Windows, or Mac).
Once you have selected a directory, you will be prompted to pick the file naming pattern that matches the way your files are named. In this example, we're using files named in the format “songid - artist - title.zip”.
Once you have selected the appropriate pattern and clicked OK, you will see your directory listed under Search Directories.
Either select that directory and click “Update”, or, if you added multiple directories and want to search all of them for files, click “Update All”. A dialog will pop up indicating that the database is updating, and when it's done you will see the below notification.
Click “OK”, then close the DB Mangement dialog and return to the main OpenKJ window. In the main window you should now see a list of the songs you just imported in the song database section.
Next, we'll add a singer. Click the add singer button at the bottom of the rotation list.
The new singer dialog will appear. Enter a singer name, then select how you want them added. “Fair” (default) means that the singer will be added one full rotation from the current position (I.E. before the person who is currently singing sings next rotation). “Next” will put them after the current singer. “Bottom” will add them at the bottom of the current rotation. Note that singer names MUST be unique, the software will not add a singer if a singer already exists with the same name.
You will now see the singer listed in the rotation.
At the bottom right of the screen is the singer's song queue. You can add songs to the singer's queue by selecting the singer in the rotation list and double clicking on a song from the database search results, or by dragging and dropping a song onto the singer or into the selected singer's queue.
Once a song is in the singer's queue, you can play the song by simply double clicking on the song in the singer's queue. The singer will be highlighted in yellow in the rotation to indicate that they are the current singer, and the ticker (if enabled) will update to show them as current and update the displayed positions of the other singers in the rotation.
You can also set any requested key change on the song by right clicking on the song and selecting “Set Key Change”. You will be prompted to set the key change in semitones (half-steps) up or down.
Once you have selected a key change and clicked OK, you will see it reflected in the “Key” column of the queue list.
Both the rotation and individual singer queues can be reordered by dragging and dropping the singer or song to a different position.
If you would like to remove a singer or song, click on the red X in the far right column.
You may have noticed the heart icon in the rotation in the second to last column on each singer. This indicates and controls whether a singer is a tracked regular singer or not. If you would like to save the current state of the singer's queue, along with any key changes, and continue to track changes, you will want to make the black/grey heart red by clicking on it. This will save the singer and continue to track any songs added, deleted, or moved and save any associated key changes as well for this session and any future sessions in which you load the singer. Note that regular singer names must be unique just like rotation singers.
Once you have them saved, you can load a regular singer into the rotation by clicking the red heart icon below the rotation list. This will bring up the regular singers dialog.
Click the add singer icon in the second to last column to add the singer to the rotation at the position indicated by the “Add Position” dropdown. This functions the same as it does when adding a singer from the main window. Note that the same rules about the name being unique apply, no duplicate names are allowed.
There will be more documentation forthcoming, but this should be enough to get the idea and get you started.
Thanks for trying out OpenKJ! - Isaac