NAME

bfserve.pl - Basic xchat2 fileserving script

SYNOPSIS

Serves files on an IRC channel using DCC. Leechers wishing to get your files can issue the following commands in the channel:

  @nickname          - sends the leecher your list of shared files
  !nickname filename - queues the given file
  @nickname-queue    - lists files the user has in the queue
  @nickname-remove   - removes user's files from the queue

QUICK START

Copy bfserve.pl into ~/.xchat2/, and edit the top section of the script labelled ``CONFIGURATION'' to point to the right places, etc.
Start up xchat2 and verify that the script is loaded. It should open a debug window called your_nickname_sends. It may give an error that it cannot open your list
Generate a new list by typing /genlist filename. Look at the list file it generates and load it by typing /loadlist filename. If the filename is different than the one listed in the configuration section, you will need to edit the script to point to the new file, so it will find the correct file next time.
Sign onto IRC, join the channel you listed in the configuration channel and type /showad, you're now serving!
At any time, type /status to see a list of the current sends and queues in the debug window.

USAGE

When a user requests a file, it is added to the bottom of the queue (even if there are open send slots). The script checks every 10 seconds to see if there are open send slots, and sends the first valid thing in the queue.

The only exception is your list file. Presumably this file is very small, so even if there are no send slots open, the script will still send your list the next time it checks for things to send.

COMMANDS

/status: Shows a list of the current sends and queues in the debug window.
/genlist filename: Generates a new list by spidering the directories listed in the configuration section, and saves the list in the given file.
/loadlist filename: This script will only serve files listed in your list! So if you have new files to be served, they will not be served by the script until you load a new list. This function is here since it's convenient to change list files while running.
/showad: Manually shows your advertisement in the channel. Normally it will only be shown at a regular interval.
/enqueue nickname file: This does the same thing as if the user with that nickname had typed !your_nickname file in the channel, it adds their request to the queue. However, this version allows you to override the max_queue setting in the configuration, so you can manually give someone more queue slots.; Be sure you are online before you /enqueue things (see below) -- the script doesn't (yet) check before trying to send files.
/saveq: This prints a corresponding /enqueue line for each person in the current list of sends and queues. You can copy this text, if you need to restart xchat and come back while keeping queues intact. Just paste the /enqueue commands back when you return -- the sends will resume and the queue will remain as it was.

CAVEATS

Some things require a restart of xchat2.
Probably some bugs here and there, and a lot fewer features than other scripts.
Sends aren't instantaneous when there are open slots, they are queued and then sent after some delay.
Not a lot of error checking to make sure we are online before sending, etc.
We don't keep track of users leaving or changing nicknames.

AUTHOR

bfserve.pl is written by Mike Rosulek <mike@mikero.com>. Feel free to contact me with comments, questions, patches, or whatever.