RKoL Firefox Extension (RKOL Status)

Created by Matt Hoffman (Grinder on KOL). E-mail can be sent to:

Link to discussion board thread for this extension.

Return to Last Played Page

 

This extension places a small Radio KoL icon in the lower right-hand corner of your browser windows. To the right of the icon, is the name of the current song and band playing on the radio. If you mouse-over the icon, a tool tip will pop-up that shows the number of users listening and the name of the show. You can right-click on the icon to open a pull down menu and set options for the extension or open some RKoL and KoL related web sites.

The song information is updated every 30 seconds by default (can be increased in the options). If you notice that a new song has started playing on the "radio" and the information hasn't updated yet on the page, you can click once on the icon to force an immediate update.

The extension has been tested in Firefox 1.5 to 9..0 on both Windows and Mac OS X.

Note: as of version 3.3.4 of this extension, the display of the song name and artist has been moved to the Firefox Add-On bar. You must enable this bar from the Firefox View menu, Toobars submenu. Also, you must go to the Firefox View Menu, Customize....dialog box and set the "Show" pull-down menu to "Icons and Text".

 

Shown below is the song-band/tool tip at the left and the pull down menu (right click the radio icon) to the right.

 

      

Pull Down Menu

Wiki Entry - This is a quick link to the wiki page for the current DJ (RKoL-Specific feature).

Send a message - This feature allows you to send a message up to 20 times to a single player. You must have chat open in the standard three-pane KoL window. (RKoL-Specific feature).

Radio Stations... - A list of the radio stations that you can select from. The selected station is the one monitored by the extension. This submenu also lets you edit the list of stations adding, editing, or deleting items.

Favorites - You can tag the current song as one of your favorites. The current artist, song name, and DJ are stored in a text file in your local profile directory. If you have entered in your KOL character name in the options dialog box, the favorites tag is also sent to a central database. Pages that allow the listeners to explore the favorite selections will be added at a later date. The Favorites submenu also has commands for opening your favorites list in a text editor and for displaying the list in a web page using several different sorting orders.

Options... - See "Options Dialog" below.

Disable Display - This stops the song and artist from being shown in the window frame. The RKoL: icon will continue to be displayed and the tooltip will continue to function.

Search - This allows you to search for : MusicBrainz, Lyrics, or the official web site of the current artist.

RKol - Links to Radio-KoL web site including the Wiki, forums and the radio schedule. (RKoL-Specific feature).

RKol Community - Links to a variety of "unofficial" Radio-KoL web sites including the Last Played and Player-Made Music sites. (RKoL-Specific feature).

Kingdom of Loathing - Opens the game in a new window. (RKoL-Specific feature).

KoL Game Forums - Opens the KoL game forums in a new window. (RKoL-Specific feature).

Listen... - Opens the radio station you select from the submenu in your streaming player. To add or remove items from the list, use the Edit command under the Radio Stations... submenu.

About - Opens the RKOLStatus extension's about box.

 

Options Dialog

Right-clicking on the RKoL icon will allow you to open the options dialog box.

Update Rate - controls how often the browser goes to the URL and fetches the song and artist data. This number cannot be set less than 30 seconds.

RKOL Features - turning this off eliminates all RKOL-specific features and allows the extension to work as a generic ShoutCast monitor.

Min Window Size - sets the smallest window size that the song/artist information will be displayed in. If a window is smaller than this value it will be treated as if the Display Disable option is set in the pull down menu. The song and artist information will still be available in the window as a tooltip.

Tooltip menu - allows the DJ's name, Genre (show name), or both to be displayed in the Tooltip (note: change won't be shown until after one update).

Show Previous Songs - when enabled, will cause the last five songs played over the radio to be shown in the tooltip.

Schedule menu - allows you to display the names of the next four DJs upcoming on the schedule along with the time they are on air in either AM/PM or 24 hour time. This is a RKoL-specific feature and is disabled when the "RKOL Features" button is off,

KOL Character Name - Enter in your Kingdom of Loathing character name to enable entries in the global favorites database. Every time you rate a song using the favorites system, the song, artist, and DJ name will be sent to a central database. This will support the eventual display of all the listeners' favorite songs and not just yours. When the "RKOL Features" button is off, favorites information is not sent to the central database.

RKoL IRC Address - This is the URL of the IRC chat server. By default, it is set to use an IRC client in Firefox such as ChatZilla. If you would prefer an http URL, go to the RKoL Community page and get the latest address.

Application Name - places the name you enter in the pull down menu. When chosen, this will launch whatever application is found along the Application Path.

Application Path. - eg:   C:\Program Files\Winamp\winamp.exe   or   /Applications/iTunes.app/Contents/MacOS/iTunes

User menu/Web Site - allows you to add up to five entries to the pull down menu as quick links to your favorite radio-related sites. In addition to adding URLs to the Web Site edit boxes, you can enter in some of the function names that are within the extension. You can use MarkFavorite(0) to tag the current song as one of your least favorites. You can use MarkFavorite(5) to tag the current song as one of your most favorites. To open the favorites list in a text editor, OpenFavoritesList().To search for lyrics, lyricSearch(). To search for the band's web site bandSearch().

 

How to Install:

Click on the link below to download the add-on. Use the Open command in Firefox to install it..

Download RKoLStatus 3.3.7

 

Version History:

3.3.7 Released Jan 3, 2012 - Bumped max Firefox version Hard!

3.3.6 Released Sep 29, 2011 - Bumped max Firefox version level to 8.0.*

3.3.5 Released Aug 13, 2011 - Bumped max Firefox version level to 6.0.*

3.3.4 Released Jun 21, 2010 - Supports Firefox 5. Moves display of song name to the Add On bar.

3.3.3 Released Feb 10, 2010 - Minor changes to support Firefox 4.0.0Beta 11.

3.2.2 Released Aug 2, 2010 - The RKoL Schedule format was changed recently. Version 3.2.2 is compatible with the changes.

3.2.1 Released Dec 10, 2008 - The RKoL IRC URL is now set in the Options dialog. This was done because the address changes frequently. By default it is set to an irc:// address which requires that you have ChatZilla or a similar IRC chat addon installed for firefox. Alternately, you could set it to the http:// address that is currently shown on the RKoL Community page: http://radio-kol.net/wiki/index.php?title=RadioWiki:Community_Portal

3.1.8 Released May 17, 2008 - Full compatibility with Firefox 3.0. Fixed white pixel in rkol icon.

3.1.7 Released Mar 20, 2008 - Fixed the links to the RKoL wiki site. Tested in Firefox 3.0b4.

3.1.5 Released Jan 4, 2008 - When a server is not found or is offline, the error message will be displayed in the status bar (in place of the current song/artist). This better supports non-rkol users that may not operate their servers 24/7. Build was tested in 2.0 and 3.0b3pre(Minefield).

3.1.1 Released Dec 29, 2007 - Identical to 3.1.0. The version number was bumped do to a problem on the mozilla add-ons server.

3.1.0 Released Dec 19, 2007 - Added the RKOL Features check box to the options.

3.0.0 Released Dec 9, 2007 - Removed the port number from the DJURL to allow forwarding. List of old songs will no longer load garbage if the server is down. Removed the URL from the Options dialog and added the "Radio Stations..." to the pull down menu. Removed the "Listen to RKOL 24" and "64" from the pull down and used a copy of the "Radio Stations..." instead. Added a means to edit the list using XUL dialogs. Tested in Mozilla B2 (Minefield).

2.5.5 Released Aug 12, 2007 - Changed the Favorite submenu to make tagging a bit easier, When the RKoL icon is left-clicked, both the current song and the schedule are now updated. Also the rkol icon blinks to indicate it was left-clicked. ProcessUserCommand can accept either a URL or a function in the extension. Added a button click event handler to make sure right click on PC didn't trigger the left-click functions.

2.5.1 Released Jul 31, 2007 - Changed the way that KOLNames are treated when the user doesn't make an entry.

2.5.0 Released Jul 13, 2007 - Added the KOL character name to the options dialog. If the name is present, the favorite rating level along with song/artist/dj is sent to a remote database for storage and eventual display. Added a pull down menu option to display the favorites list in a local web page.

2.1.2 Released Jul 10, 2007 - Fixed a bug causing the Schedule pull-down in the options to always display "none". Fixed a bug that caused the song information to be polled three times after a djarray update. Fixed a bug that prevented the wiki link in the menu from working due to a change in the wiki software.

2.1.1 Released Jul 5, 2007 - Changed the rating system so the user could specify the number of stars and write it out along with the DJ name.

2.1.0 Released Jul 4, 2007 - Added a simple mechanism that allows users to note their favorite songs. Song and artist names are added to a text file stored in the user's profile directory.

2.0.2 Released Jun 26, 2007 - Fixed the link to the RKoL DJMapping site. A change to the wiki caused the URL of the site to change.

2.0.1 Released Mar 13, 2007 - Fixed a bug that caused the default site to be used for loading the last 5 songs played regardless of the site chosen by the user. Removed singingfish web site as a search option since that site no longer exists

2.0 Released Jan 7, 2007 - Now reads the RKoL schedule and can optionally display the next 4 DJ's with their show times in the pop-up tooltip. The Search submenu now contains the choice, "Bands", to search the web for sites related to the band currently playing. RKoL Community submenu added with links to all of the Radio-KoL community pages. Link in pull down menu added to the KoL Game forums. Option added to launch an application of the users choosing. Option window contains name (for menu) and path of the application. The extension was run for a long period of time to ensure that there were no memory leaks.

1.8 Released Dec 16, 2006 - The RKoL DJ mapping web page is now used to determine the name of the DJ. This information is stored locally in a file called "DJArray" in the extension's own folder and is automatically updated once every 24 hours. The option to show the genre-aim information was changed to show the DJ Name (genre) information. This allows DJ's to have both their name and the name of their show (genre string) displayed by the listeners. The pull down menu was reorganized. The first entry is a link to the current DJ's wiki page. The code that processes the song and artist names was further improved to better handle multiple instances of hyphens.

1.7 Released Dec 5, 2006 - Organized the popup menu with submenus. Added SingingFish search. Added Send Message command.

1.6.1 Released Oct 3, 2006 - Fixed a bug that prevented the list of old songs from loading if a song had no "-" in it.

1.6 Released Oct 2, 2006 - Added links for Lyric Search and MusicBrainz. Added the Show Previous Songs option to display the last five songs played over the radio.

1.5 Released Sept 22, 2006 - Changed maximum Firefox version to 2.0 since the extension seems to run under the 2.0 beta. Tooltip system has been rewritten as a pop-up window to allow more than one line of text to be displayed. When Disable Display is set, both song/artist and genre is shown in the tooltip. A link was added to the RKoL forums. The RKoL link was changed so it points directly to the wiki. Added a link for About...A preference was added for Minimum Window Size. Display behaves as if disabled if the window width is less than or equal to the minimum window size.

1.4 Released Sept 18, 2006 - Added third option for Tool tip display (Genre+AIM). Fixed a bug saving out the enableFlag preference.

1.3 Released Sept 16, 2006 - Added option to use the AIM address instead of the Genre. Added ability for user to set 5 custom links to the option menu. Added links to the option menu for the 24k and 64k streams.

1.2 Released Sept 13, 2006 - Pull-down separators added. Links to LastPlayed and Player-Made Music Site Added. Efficiency improved. Bugs in displaying songs without a title or band name fixed. Pull-down menu item to disable display of song/genre added (persistent across restarts).

1.1 Released Sep 11, 2006 - Fixed text encoding issues with non-latin character sets.

1.0 Released Sep 9, 2006