WebRequest System

From IRCBotWiki

Jump to: navigation, search

Contents

General Information

The AutoDJ WebRequest system allows you to have an integrated playlist on your website for your AutoDJ plugin. The system allows browsing of your playlist, user requests, and also allows users to view your most recently played files.

If you would like to see more features in this system, please post a Feature Request at http://www.shoutirc.com. Since this is an open source project, you are also able to make modifications on your own if you wish.

IRCBot Configuration

You must be using the MySQL queue plugin to use the WebRequest system. It will create the songs table and populate it.

Installation

1. Extract the archive to a desired directory on your web server.
2. Navigate to that folder/install.php
3. If you have any problems, or need help, please post a support ticket at http://www.shoutirc.com.
This is a new package so you may encounter bugs, please report them to us via a support ticket.

Blacklist/Whitelist

Starting with WebRequest 1.2 you can now specify a whitelist (people who can always request without regard to the normal waiting period if you have it enabled), and a blacklist (people who cannot request songs no matter what).

All identification is based off of IPs, as the WebRequest system has no way of knowing who you are.

To use your whitelist, edit your config.inc.php to include the following:

$config['whitelist'] = array();

To add IPs, simply add them to the array:

$config['whitelist'] = array("10.0.0.1");
$config['whitelist'] = array("10.0.0.1", "202.250.39.27");

The match will begin from the beginning of the IP and go as long as the string you specify, so for example to allow anyone from 192.168.0.0-192.168.0.255 to always request:

$config['whitelist'] = array("192.168.0.");

The blacklist works the exact same way, except use $config['blacklist'] instead of $config['whitelist']

License

The WebRequest package is licensed under the GNU General Public License v2 (aka GPLv2), so you are free to make modifications as long as you still give credit to ShoutIRC.com. It is requested that if you make changes to the source you send them to us for possible inclusion in future releases.

Themes

The package by default comes with one skin, you can use it as a basis to create your own skins. Due to the use of the Smarty template engine, you have full control over the HTML output of the script so you can sustomize it heavily. If you would like to send in any theme(s) for possible inclusion in future releases, please submit them via a Support ticket or the Contact page on the main ShoutIRC.com page.

Credits

The default Song Information icon from Mark James (http://www.famfamfam.com/lab/icons/)
Smarty PHP template engine http://smarty.php.net/


IRCBot vde

IRCBot main pages
Main PageInstallationChangelogCommandsPluginsFAQConfigurationCreditsRemote ClientBuffered SendBuilt-In VariablesMulti Sound Server Mode
Auto DJ Pages
Auto DJ Main PageWebRequest SystemSchedulerMP3 EncoderVoice SupportMySQL Plugin
Personal tools