10.05.2000

joinstat.tcl Component Documentation

# joinstat.tcl for netbots.tcl v3.30
# designed to work with eggdrop 1.4.0 or higher
# Johoho's Eggdrop Page - http://johoho.tuts.net/eggdrop/
# joinstat.tcl copyright (c) 1999,2000 by Johoho <johoho@hojo-net.de>
# netbots.tcl copyright (c) 1998-2000 by slennox <slennox@egghelp.org>

## joinstat.tcl component script v1.02.0, 10.05.2000 ##

# History:
#
# v1.00.0, 09.05.2000 - initial release, not public
# v1.01.0, 10.05.2000 - public release
# v1.02.0, 10.05.2000 - fixed a rather small bug

# thanks slennox for netbots.tcl

Please note that this component is fully compatible with netbots.tcl v3.10 - 3.30 by slennox

Description

This script provides a joining user with some information about the status of the botnet. It tells you how many bots are linked, which netbots are offline, and if any netbot is currently not connected to an ircserver. An example output would look like this way:

*** Now talking in #gardening
-Carrots-  There are 79 bots on the botnet
-Carrots-  16 netbots (4 offline or not linked: Tomatoes, Onions)
-Carrots-  Celery is currently not connected to an irc server
-Carrots-  Milk is currently not connected to an irc server

Installation

netset.tcl

To install this component properly you have to copy it to your netbots directory and add these lines to your netset.tcl conf:

# joinstat.tcl
set nb_component(joinstat) 1
set js_say "Carrots"
set js_serv 1
set js_chans ""
set js_echans ""
set js_nick "$owner"
set js_fast 0
set js_type "NOTICE"

Settings Documentation

js_say (default: YourBotName)
	Only one bot should say something to you on irc. Set here your favourite one.
	Valid settings: a botname

js_serv (default: 1)
	Do you want to be notified about bots which are not connected to an ircserver?
	Valid settings: 1 to enable, 0 to disable.

js_chans (default: "")
	List of channels in which to activate notification.
	Valid settings: one channel like "#donkeys", a list of channels like "#donkeys #cows #pigs", or "" to activate on all channels (except those listed in js_echans).

js_echans (default: "")
	List of channels in which to skip notification.
	Valid settings: one channel like "#donkeys", a list of channels like "#donkeys #cows #pigs", or "" to switch this off.

js_nick (default: "$owner")
	Enter here a list of people who should be notified on join.
	Valid settings: One or more nicknames, seperated by a blank " ". Leave completely blank to disable.

js_fast (default: 0)
	Define here how quickly you want to get the information from the bot. 0 is normal behaviour, 1 is fast behaviour. Please note, that option 1 uses putserv for notification, which shouldn't be used for such things.
	Valid settings: 1 to enable fast notification via putserv, 0 to use slower puthelp.

js_type (default: "NOTICE")
	Define here how you want to be notified by the bot, by message (/msg) or by notice (/notice).
	Valid settings: NOTICE or PRIVMSG

FAQ

Q:		I set js_serv to 1, but on join it doesn't show anything
A:		Well, it seems that all of your bots are connected to an ircserver :-)

Q:		When I join I get the usual messages by the bot but nothing more. After some time I get information about the other bots, why is there such a lag?
A:		joinstat.tcl uses the botnet to ask the other bots whether they are connected to an irc server or not. Such behaviour happens if your botnet is lagging.

Q:		I set a valid handle in 'js_nick', but the bot doesn't notifies him. He's is not an owner.
A:		joinstats.tcl binds only to owner joins to save ressources of the bot. If you want to change this behaviour, add this option to your netset.tcl file: set js_flag "-" You can also use any other valid flag instead of '-' to match

Q:		I have a question, but it's not listed here.
A:		Feel free to contact the authot at johoho@hojo-net.de!

Contact

You can contact me via E-Mail at johoho@hojo-net.de, at ICQ 2499577 (tell me who you are and what you want or I'll ignore you) or catch me on irc usually around 18-24 UTC+1 in #eggdrop. (IrcNET)

DISCLAIMER

joinstat.tcl is provided 'as is' and without warranty of any kind.