XDCC packlist script

** Updated 26/12 2008 — version 1.4.1 **
Current version: 1.4.1

Overview

Overview
Introduction
The script
Demo
Download
Requirements
Installation
Future
Version history
License
Subversion (SVN)

Introduction

I thought it was time I did something useful with my *knowledge* of coding that I decided to make… a nice way to list packs for a IRC XDCC bot and then distribute it (durr)!

The script

The script is coded in PHP but relies heavily on the jQuery (as of 1.4) framework (and therefore JavaScript). It’s designed to be easily configurable – adding bots is made with just a few lines of code.

The list is searchable and is generated through an XML- or TXT-file (generated by iroffer(-dinoex) or the likes).

Demo

There is currently a live demo at http://a.satf.se/.

A poor quality screenshot of the search function in action is also available here:
Screenshot

Download

You can download the script with the link below.

botlist_1.4.1_[SATF.SE].zip (60 kB)

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License.

http://files.satf.se/xdcc/botlist_1.4_[SATF.SE].zip
http://files.satf.se/xdcc/botlist_1.3_[SATF.SE].zip
http://files.satf.se/xdcc/botlist_1.2_[SATF.SE].zip
http://files.satf.se/xdcc/botlist_1.1_[SATF.SE].zip
http://files.satf.se/xdcc/botlist_1.0_[SATF.SE].zip

A nightly version (probably unfinished/unstable) can be found at the svn:
svn co svn://svn.satf.se/satf-packlist-script/trunk
Alternatively, you could browse the code, as well as old versions through the svn web interface:
svn.satf.se/websvn

Requirements

Linux/unix web-server (not tested on Windows)
Basic knowledge of PHP in order to configure the bot
A web server with PHP installed and properly configured (preferably Apache)
An iroffer-dinoex bot that generaters an XML-file. Normal iroffer is just fine as of version 1.2.

Installation

Download and unzipDownload the proper .zip-file and unzip files to a local folder and check that in has maintained it’s original structure:

Structure: (+ = directory, - = file)
+css				: css directory
	-darkerthangrey.css	: darkerthangrey template CSS file

+includes			: includes directory
	-bot.class.php		: main class file
	-ets.php		: template class (ets)

+script				: JavaScripts
	-bot.js			: main JS file
	-jquery-1.2.6.min.js	: jQuery framework
	-jquery.corner.js	: neatly rounded corners

+templates			: Templates directory
	-darkerthanblack.tpl	: Main template. Use this as
				 guide when making new templates

-bot.php			: Main file
-config.php			: Configuration file
-README				: README file

Edit config.php:There are a couple of constants and variables/arrays you have to edit in order to adjust the script to your server.

Constants:There are some constants in config.php that needs to be edited. Only edit those described here, the rest should be left at default.

SITE_NAME       - the name of your site

SITE_DOMAIN     - the domain of your site (no leading http://)

LINK_PREFIX     - the "root" subdirectory of your site.
		for subdirectories use e.g. '/bot', for root ''

MAIN_PAGE       - the name of the main page (change if you want to rename it)
		default: 'bot.php'

TEMPLATE_TPL	- the name of the template file (i.e. darkerthanblack.tpl).
		Template files should be put in the templates directory.

Bot configuration:The bot configuration is essentially a PHP array. It is pretty self-explained, just replace the strings inside ” to your liking.

$bots[] = array(
'bot'	=>	'AwesomeBot',
// the bots nickname
'bot_owner'	=>	'satf',
// owner/maintainer of the bot
'xml'		=>	'/path/to/pack.xml',
// Either absolute path or an URL to packlist XML-file
'txt'		=>	'/path/to/pack.txt',
// Either absolute path or an URL to packlist TXT-file
'mode'		=>	'txt',
// define whether to gather data from xml or txt. [MUST BE EITHER 'xml' OR 'txt']
'comment'	=>	'AwesomeBot is filled with awesome!',
// Comment to be displayed
'IRC'		=>	array(
'channels'	=>	'XLG,SATF',
// channels the bot resides in, separate by comma for multiple channels
'server'	=>	'irc.rizon.net'
// the IRC-server the bot resides in
)
);

Add one of these for each bot. Note that you need to have either xml or txt set, or both.

Upload files:Upload ALL files to your web server and try to access bot.php on your web server.

Future

I’ll be adding support for text-files – not only xml-files! Yaay. Already completed! I take requests for features!

Version history

1.4.1 (26/12 2008) – Minor bug fixes
- Fixed minor statistics error
- Made the RSS usable, making packs individual name, number, gets and size available as well as botname.
1.4 (16/7 2008) – Major changes o’hoy
- Majorly improved look and feel.
- Total recode and new code-structure.
- Switched to jQuery JavaScript framework instead of Spry.
- Replaced clipboard function with a JavaScript prompt.
- Fixed several minor bugs.
- Now works (partly) with a JavaScript disabled web browser.
- New, more awesome, search functionality.
- RSS feeds (of packs in descending order).
1.3 (26/1 2008)
- Fixed channels on front page
- Minor bug fixes for bot.php, bot_xml.php and bot.js.
1.2 (21/1 2008)
- Added raw packlist (txt) support
- Fixed minor bugs/made some changes
1.1 (31/12 2007)
- Fixed some bugs with having more than one bot.
1.0 (30/12 2007)
- Script created by Jonas Skovmand (aka. pihl).
- Only XML-support for now.

License

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License.

jQuery is licensed under the GNU General Public License and MIT license.

ETS – Easy Templating System is licensed under GNU Lesser General Public License.

Subversion (SVN)

If you can’t wait for the new version to come out, you could always check out the svn to get a sneak peek of what’s to come.
Click here to go to the svn
And as stated in the download section, you can check out the current nightly version (anonymously) using the following command:
svn co svn://svn.satf.se/var/svn-repos/satf-packlist-script/trunk

Home

About

Contact

Projects

Jonas Skovmand,

Web developer from Sweden, Denmark and Norway.