help.php

<h1>Jukebox</h1>

<p>
  <a href="http://makeapullrequest.com">
    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="Pull Requests Welcome">
  </a>
  <img src="https://shields.io/badge/fpp-jukebox-brightgreen" alt="FPP Jukebox Logo">
</p>

<ul>
  <li><a href="#getting-started">Getting Started</a></li>
  <li><a href="#config-options">Config Options</a></li>
  <li><a href="#locked-config-options">Locked Config Options</a></li>
  <li><a href="#notes">Things To Note</a></li>
</ul>

<h2 id="getting-started">Getting Started</h2>
<p>Give you visitors interactions with your show can be easier this plugin. List the songs/playlist you want you visitors to choses from and display them on a touch screen.</p>
<ul>
  <li>Go to "Content Setup"</li>
  <li>Click "Jukebox Config"</li>
  <li>Add a new item</li>
  <li>Select what you want the item to be from the options select (Playlist or Sequence)</li>
  <li>Select the playlist or sequence you want to play</li>
  <li>Assign an image</li>
  <li>Press "Save Config"</li>
</ul>
<p>You can have as many item as you want in the order you want. The item list is sortable just drag and drop them in the order your would like. Just don't forget to press save.</p>
<p>With the images that you assign to a item we recommend a size of 400 x 300px. Note image need to be upload to the images section on the file manger.</p>

<h2 id="config-options">Config Options</h2>
<p>With is plugin there are some other configuration options available to use.</p>
<ul>
  <li><b>Remote IP</b> - Do you have the plugin on one controller and sequences/playlist on another? Enter the ip address on the remote controller.</li>
  <li><b>Static Sequence</b> - If you have a static sequence that you run between your songs select the sequence from the dropdown. The system will wait for that sequence to be playing before the next item played.</li>
  <li><b>Additional Ticker Information</b> - At the top of the jukebox page you will see a "Currently Playing" banner this will show what item is player if anything. This box give you the option to add additional information</li>
  <li><b>Location of additional Ticker Information</b> - Display the what location do you want to put Additional Ticker Information to show - Before the currently playing song information or After it</li>
  <li><b>QR Code</b> - If you use a QR Code to get donates from your visitors this give you the option to select the one your using. Note the qr code needs to upload the images section on the file manger. This will create a "Donate" button on the Jukebox page that will allow the visitor to press and display the qr code.</li>
</ul>

<h2 id="locked-config-options">Locked Config Options</h2>
<p>Only want your visitors to be able to select an item between a set time. Once you have setup the locked config it will switch between the locked and jukebox pages automatically. Note if you change the setting your will need to reload the kiosk page.</p>
<ul>
  <li><b>Show Logo</b> - If you have a show logo and you want to display select it. Note the qr code needs to upload the images section on the file manger.</li>
  <li><b>Show Name</b> - Enter your show name this will display on the Locked Page</li>
  <li><b>Show Information</b> - Some basic text about your show like show open times</li>
  <li><b>Start Time</b> - This is a time you want your visitors to be able to select an item on the Jukebox</li>
  <li><b>End Time</b> - This is a time you want your visitors not to be able to select an item on the Jukebox</li>
</ul>

<h2 id="notes">Things To Note</h2>
<p>Artwork recommends is 400x300px</p>
<p>QR Code size recommends is 2000x2000px</p>
<p>If you have any feature requests please create an issue on github</p>