Configure Automatic Billboard Images & Lyric Gathering

[phr00t]

PerformVR can automatically gather images for the billboards behind the audience & gather lyrics from the web. However, I can't preconfigure this for everybody as it usually requires APIs with search limitations or violating a search engine's terms of service. Also, as services change over time, it is easier to change a small configuration file than rebuild the game. You get to pick what search engine works best for you (and be aware of service terms for whatever sites you pick).

Two files control this automatic searching system:

ImageSearchConfig.txt
LyricsSearchConfig.txt

They can be found in the vamp/ folder off of your local installation folder.

The default ImageSearchConfig.txt looks like this:

https://www.EXAMPLE.com/search?q=$SEARCHTERMS&tbm=isch
src="http
"
5

The format is like this:

<Search Engine URL template>
<Text to look for beginnings of image links in results>
<Text that will end an image link in results>
<How many characters after beginning text will image link start>

$SEARCHTERMS will be populated automatically from the name of the song in the URL template. www.EXAMPLE.com needs to be replaced with a search engine that provides image search results in an expected format.

The default LyricsSearchConfig.txt looks like this:

site:EXAMPLELYRICS.com
https://EXAMPLESEARCHENGINE.com/?q=$SEARCHTERMS
<pre id="lyric-body-text"
</pre>

The format is like this:

<Text added to search mostly useful for specifying results from a lyrics site>
<Search Engine URL template>
<Text to search for the possible beginning of lyrics>
<Text that will end a section that may have contained lyrics>

EXAMPLELYRICS.com and EXAMPLESEARCHENGINE.com need to be replaced with valid sites. EXAMPLELYRICS.com should be a service that provides lyrics, and EXAMPLESEARCHENGINE.com should be a web search that allows for instantly redirecting to the first search result. You may find success in using a lyric site directly and just leaving a single space in the first line. PerformVR will look through all possible sections found using the last 2 configuration lines and try to pick the one that most looks like lyrics.

If PerformVR finds results, it will save them in vamp/cache folder. You can also pre-populate this folder with results (saving lyrics to <song file name>.txt and billboard images to <song file name>.0.bmp and <song file name>.1.bmp).