Wimpy MP3 Player ExpressionEngine Plugin

Version 1.0

Installation Instructions

1. Follow the standard instructions for installing Wimpy.

Click here to review the instructions.

2. Use the Customizer tool to create a "wimypConfigs.xml " file.

IMPORTANT: You must click the "Download a wimpyConfigs.xml file" in the "Wimpy Script Configuration" area to generate a "wimpyConfigs.xml" file.

Upload the resulting "wimypConfigs.xml" file to the same folder that you installed Wimpy in during step 1..

3. Test Wimpy by accessing wimpy.php with your web browser.

Example:

http://www.yoursite.com/mp3s/wimpy.php

4. Download and unzip the Wimpy MP3 player EE plugin package (if you haven't done so already):

Click here to download the package

5. Open pi.wimpyplayer.php with a text editor and scroll down until you see the "CONFIGURATION" section

Set the URLs to the Wimpy files on your site as described below.

// ===================
// CONFIGURATION
// ===================
// File Locations:
// SWF file - Set the full URL to wimpy.swf on your web site.
// Example:
// $wimpySwf = "http://www.yoursite.com/mp3s/wimpy.swf";
$wimpySwf = "http://www.plaino.com/mp3s/wimpy.swf";
//
// PHP file - Set the full URL to wimpy.php on your web site.
// Example:
// $wimpySwf = "http://www.yoursite.com/mp3s/wimpy.swf";
$wimpyPhp = "http://www.plaino.com/mp3s/wimpy.php";
//
/* Configs File - Set the full URL to wimpyConfigs.xml on your web site. You can generate a wimpyConfigs.xml file by using the Customizer Tool at wimpyplayer.com. When using the Customizer tool, you must click the"Download a wimpyConfigs.xml file" in the "Wimpy Script Configuration" area to generate a "wimpyConfigs.xml" file.
*/
$wimpyConfigs = "http://www.plaino.com/mp3s/wimpyConfigs.xml";

// Width and Height:
// Specify the width and height of the player:
$wimpyWidth = 135;
$wimpyHeight = 175;

// Background color:
$bkgdColor = "FFFFFF";

// ======================
// POP UP WINDOW SETTINGS
// ======================

// Show Popup Link:
// You can cause this block to display a link above or below the
// player so that users can pop up the player into a new window,
// so they can listen while they surf your site.
//
// Options:
// 0 = don't show popup link
// 1 = put link on bottom only
// 2 = put link on top only
// 3 = put link on both top and bottom
$showPopupLink = 1;

// Just Show Pop up Link
// This will cause this block to NOT display the
// player within the page, and only show a link to pop up Wimpy
// (either a text link or image button as defined above)
//
// Options:
// 0 = Player will display on the page in addition to the pop up links
// 1 = Player will not display in your page, only a link to pop up the player.
$justShowLink = 0;

// Text Link:
// Default Text to use for the pop up link (if used):
$popupButtonText = "Launch Jukebox";

// Use Image As Pop Up Button:
// If you want to use an image (button), rather than a text link,
// enter the URL to the image file.
//
// NOTE: Leave as "" if you just want to use a text link
// NOTE: Setting this to a file location will automatically set the link to an image,
// and any text defined in "Text Link" above will be disregarded.
//
// Example:
// $popupButtonImage = "http://www.yoursite.com/mp3s/popupJukeboxButton.gif";
$popupButtonImage = "";

// Pop Up On Load:
// If you want Wimpy to pop up when the page loads, set this to 1 or true
//
// NOTE: In order to use this option, you MUST set an image button
// (see above "Use Image As Pop Up Button")
//
// Options:
// 0 = don't automatically pop up wimpy when the page loads.
// 1 = pop up wimpy when the page loads
$popupOnLoad = 0;

// Pop Up Margin
// specify the padding (in pixels) for the pop up window
$popupMargin = 10;

6. Upload the pi.wimpyplayer.php to your ExpressionEngine installation folder.

This folder is usually located within the ExpressionEngine "system" folder.

Example:

/system/plugins/pi.wimpyplayer.php

7. Login as an administrator at your ExpressionEngine site to make sure that Wimpy is listed as a plugin.

Example:

http://www.yoursite.com/system/index.php

- Click the "ADMIN" tab
- From the "System Administration menu on the left, click on "utilities"
- From the list of available Utility items, click "Plugin Manager"
- Click on "Wimpy Player" to see some examples of how to include the player within a template by clicking on the "wimpy Player" link in the list of available plugins.

8. Wimpy should now be be ready to use in your templates.

To include Wimpy in your templates, add the following line of code:

{exp:wimpyplayer}

Wimpy will automatically list and play the MP3 files that are located in your Wimpy installation folder.

If you would like to specify a playlist, use the following:

{exp:wimpyplayer playlist="http://www.yoursite.com/mp3s/track.mp3"}

To list more than one file in the playlist, separate each URL to the MP3 files with a "pipe" character.

Example:

{exp:wimpyplayer playlist="track01.mp3|track02.mp3|track03.mp3"}
NOTE: only the file names are listed above for simplicity-sake... you should use a full URL to each file.