Eggdrop Tcl Archive

Extended Description File

This is the Automatic version 2.0.3 readme file.
This file will tell you what Automatic is, how to install it 
and how to contact me.

What is Automatic?
Automatic is a script I made the first version of for some time back.
The 1.x scripts where programmed in a way I'm not to proved of. I have tried 
to make this better in this version, and I have therefor reprogrammed the 
entire script.

What it does is that it (tries to) take care of all the user file handling. 
It does not delete old users who haven't been seen by the bot in a number of 
days (check my cleanup script for that job). It adds new users as they join, 
and updates all the hosts of the users if someone was to join using a new one.

It also makes it possible for the user to add new alternative nicks to 
his/her user info. The user will automatically be asked if he/she wants to do 
so if they join using a new nick. This script now uses the same way the 
altnick script does to save alternative nick names. This mean you'll need to 
install the altnick3.tcl on your bot. Download that script and read 
the first lines of the script for more info on altnick.

Why use altnick?
I think the altnick script is the closest thing eggdrop have to a standard 
way of saving and registrating alternative nick names. 
It's easy to use in your own scripts, and it does it in a fast and safe way.

What about people who have been using the 1.x scripts, will they need to 
remove the old way of saving alternative nick names, and add them all over 
again manually?
Of course not! I used some time on making this script convert the old way 
into the altnick3.tcl way. 
All you'll need to do is to type .autoconv as a master/owner in a dcc chat 
or telnet connection with your bot after you have installed the script 
correctly. The time it takes depend on all from what server your bot is 
running on to how many users your bot knows. Your bot might "freeze" or 
become a lot slower while it converts the userfile, but that's normal, 
so don't panic.
I will in no way guaranty that the script is 100% successful,
but what it does is this:

    It scans true the user file searching for hosts looking like this:
        *!*@<unknown>.data
        <unknown>*!<unkown>@<unknown>

What it does with a host looking like the first one, is that it stripes away 
every thing but the <unknown> part, and then it adds the unknown part 
(who now should be a alternative nick for that user) as a altnick using 
altnick3.tcl. It then removes the .data host.
On the other host, it makes it look like this: <unknown>!<unknown>@<unknown>, 
and it adds a +C (not +c, but +C!) to the user. 
This makes the Automatic script handle this user in a different way when it 
want to add a new host.

What else is new?
The script now has full support for alternative nicks. This means that if 
someone having a main handle like girl19 should join using a known 
alternative nick girl-19 and at the same time having a new host, the script 
understand that this is girl19, and adds the new host to girl19, 
and not add girl-19 as a new user as the 1.x scripts would have done.
The script should also be more eggdrop friendly, and not trigger some bugs 
inn irc.c (or something like that). 

I have also removed every thing else that you can find in 1.x scripts. 
This is the greet part, away part, split notice part, and info text with far
to many lines logged when someone joins and so on. 
The script will also no longer send a message of way to many lines if 
someone joins using a new unknown nick. It will now just send ONE line. 
Users may also now use /msg <bot> help altnick, /msg <bot> help newnick and 
/msg <bot> help newuser (this requires that you have the help file loaded!).

It's now also more easy to make the script send a different line of text if
this and that should happen since they are all located at the same place 
(at the start of the script). If you want to make the script use a different 
language then english, you shouldn't have to big problems I hope :)
You can also make the script ignore a user (so that the script will not 
notice this user and so on) by giving that user a +N flag 
(use .chattr <handle> +N). 
It also work on bot's (+b users) in the same way.
Well.. I hope that's about it. I have tested it for several months now, 
and haven't found any bugs.

Okey, how do you install it then?
Easy.. copy the script file (automatic_v2.0.2.tcl) and the altnick script 
(altnick3.tcl) to the scripts dir. 
Then copy the automatic.help file to the help/msg dir.

Now at the end of your bot config file, add these lines:

source scripts/altnick3.tcl
source scripts/automatic_v2.0.2.tcl
loadhelp automatic.help

Also do remember to config the script! See the first lines of the script file.

That's it. Now just restart your bot.

I need to contact you for some reason, how?
If you want to contact me because you found a bug, you have an idea for the 
script or you just need someone to talk to :), 
send a mail to cfelde@powertech.no.
If (and ONLY if!) that email address doesn't work, 
please try cfelde@hotmail.com.

What if I just found this readme file somewhere, but not the script, 
where would I go find it?
This script has been uploaded to ftp.sodre.net, and should be in 
/pub/eggdrop/scripts1.3 
(if they don't change something, or something goes wrong).

Hope that's all the info you'll need.

Christian Felde