@database TeaBot guide
@$VER: TeaBot Guide 2 (08-08-98)
@WORDWRAP


@NODE Main "TeaBot 0.97c © 97,98 Stephen P Evans, Ickle Fishie Software."


            @{b}TeaBot version @{"0.97d" LINK History} Aminet release.@{ub}
         © 97,98 Stephen Evans. @{b}TeaBot@{ub} Guide Version 2Beta.
                    

     

     @{" " LINK LIABILITY}      Liability
     @{" " LINK Introduction}      What is TeaBot ?
     @{" " LINK Installation}      Installation
     @{" " LINK Usage}      Usage
     @{" " LINK Commands}      Commands
     @{" " LINK Author}      About the author
     @{" " LINK Thanks}      Cast and Crew
     @{" " LINK History}      Program History
     @{" " LINK Bugs}      Known Bugs/To Do




@endnode

@node "Liability" "LIABILITY"
@{b}Liability:@{ub}


With the usage of TeaBot you agree to the following announcement-declaration:

    THERE IS NO LIABILITY TO THIS PROGRAM-PACKAGE,IN REFERENCE TO THE
    ASSERTED LAWS. THE COPYRIGHT OWNERS, AND/OR A  THIRD PARTY, PLACE
    THIS PROGRAM PACKAGE AT YOUR DISPOSAL "AS  IS" (EXCEPT WHERE THIS
    IS FIXED ANYWHERE ELSE IN A WRITTEN WAY) WITHOUT ANY GUARANTEE IN
    ANY  FORM (INDIRECT OR DIRECT FORM). THE FULL RISK OF QUALITY AND
    FUNCTIONALITY  OF THIS PROGRAM IS AT YOUR OWN. IF THE PROGRAM HAS
    A BUG, YOU HAVE TO PAY  ALL COSTS  OF THE NECESSARY SERVICE-WORKS
    AND REPAIRS FOR YOURSELF.

    UNDER  NO  CIRCUMSTANCES,  THE  COPYRIGHT OWNERS OR A THIRD PARTY 
    DISTRIBUTING THIS PROGRAM PACKAGE, AS ALLOWED, JUST  BEFORE,  CAN
    NOT  BE  HELD  RESPONSIBLE  FOR  ANY  DAMAGE CAUSED IN ANY USUAL,
    SPECIAL, OR ACCIDENTAL WAY OR BY THE PROGRAM PACKAGE (SURROUNDING
    BUT NOT RESTRICTED ARE THE LOSS OF DATA OR NOTCORRECTLY DISPLAYED
    DATA OR LOSSES CAUSED BY YOU OR A THIRD PARTY OR BY A FAULTY WORK
    OF THIS PROGRAM PACKAGE  WITH  OTHER PROGRAMS), ALSO IF THE OWNER
    OR A THIRD PARTY HAS BEEN POINTED AT SUCH POSSIBILITIES OF DAMAGE.

@{" Back to Index " LINK Main}
@endnode


@node Introduction "What is TeaBot ?"

@{b}What is TeaBot ?@{ub}


Easy to use, Friendly IRC Bot addon for Amirc, Written 100% in arexx.
Please don't shudder when you hear the word Arexx, TeaBot tries his best to NOT 
look like a Arexx based bot, in fact I ran this bot for 6 Months 
(While in development on #Amigacafe) and nobody noticed it was written in Arexx :)

Please have faith ;)

@{" Back to Index " LINK Main}

@endnode




@node Installation "TeaBot Installation."

@{b}So how do I install TeaBot ?@{ub}


Its easy I've tried to make it that way (I've seen people installing without reading the 
docs :)) 

Do this copy c-codes.txt, faqlist, fish, Hangtemp, Hangwords, JLog, MCP.gurudat all to S:

     
a) Load TeaBot his own copy of AmIRC.

a) Ensure Arexx is running. 

b) Load into AmIRC my provided Amirc config file, add any irc servers that you use.
   @{b}IMPORTANT copy TeaBot.arexx to Ram: !!@{ub} Don't even think of running it from HD.

c) Thats it TeaBot should make you instantly level 6 (More info on level later in this 
guide). If for some reason it doesn't edit by hand the ram:jlog file and change your level to 6.


Have fun ! :)

@{" Back to Index " LINK Main}
@ENDNODE

@NODE Usage "How to use TeaBot"

@{b}How to use TeaBot@{ub}

Probably the easiest bot to use !

TeaBot responds to @{"Commands" LINK Commands} issued in the channel or by 
private message e.g.,

^Showcommand

/Msg Tea Showcommand

The ^ prefix isn't required when issuing commands via private messages.

TeaBot has a built-in wealth of @{"Commands" LINK Commands}  which are all 
available to the Level 6 operators.

How to Add Faq's @{"offline" LINK Offline} !

@{" Back to Index " LINK Main}
@ENDNODE

@NODE Commands "TeaBots Commands"

     @{" " LINK Info}      Info
     @{" " LINK Slap}      Slap
     @{" " LINK Punch}      Punch
     @{" " LINK Nachos}      Nachos
     @{" " LINK Country}      Country
     @{" " LINK Url}      Url
     @{" " LINK Say}      say
     @{" " LINK Me}      Me
     @{" " LINK Fish}      Fish
     @{" " LINK Guru}      Guru
     @{" " LINK Nut}      Nut
     @{" " LINK SView}      SView
     @{" " LINK Quit}      Quit
     @{" " LINK Nick}      Nick
     @{" " LINK Hug}      Hug
     @{" " LINK Fart}      Fart
     @{" " LINK Tryme}      TryMe
     @{" " LINK Op}      Op
     @{" " LINK DeOp}      DeOp
     @{" " LINK Topic}      Topic
     @{" " LINK SetGreet}      SetGreet
     @{" " LINK ViewGreet}      ViewGreet
     @{" " LINK DelGreet}      DelGreet
     @{" " LINK HangR}      Hangr (Hangman Reset)
     @{" " LINK Hang}      Hang (Hangman)
     @{" " LINK FServAssign}      FServAssign
     @{" " LINK FServAccess}      FServAccess
     @{" " LINK Status}      Status

     @{" " LINK Main}      Main Index

@EndNode

@NODE Info
INFO

Shows current TeaBot version and local time.
@EndNode

@{" Back to Index " LINK commands}
@NODE SLAP
SLAP

A fun command, Slap a user with a random fish
usage Slap <Nick> 

@{" Back to Index " LINK commands}
@ENDNODE
@NODE PUNCH
PUNCH

A fun command, Punch a user in the face
usage Punch <Nick>

@{" Back to Index " LINK commands}
@ENDNODE
@NODE NACHOS
NACHOS

A fun command, buy Nachos for all on the current channel and send the bill to 
<nick>
usage Punch <Nick>

@{" Back to Index " LINK commands}
@ENDNODE
@NODE COUNTRY
COUNTRY

Convert Internet country codes to there real country name
usage Country [Country-Code]
E.g. ^Country CZ

TeaBot will respond with 

TeaBot:  cz is Czech Republic

@{" Back to Index " LINK commands}
@ENDNODE
@NODE URL
URL 

TeaBot grabs and stores URLs off the current channel, this command privately 
messages you all the URLs

@{" Back to Index " LINK commands}
@ENDNODE
@NODE SAY
SAY

Make TeaBot Talk,
usage ^Say [Message]

Eg ^Say Hello peeps

@{" Back to Index " LINK commands}
@ENDNODE
@NODE ME

ME

Make TeaBot send a action to the channel
usage ^Me [Message]

@{" Back to Index " LINK commands}
@ENDNODE
@NODE FISH

FISH

Another Fun command just try it :)

usage ^Fish [Nick]

@{" Back to Index " LINK commands}
@ENDNODE
@NODE GURU

GURU

Makes TeaBot convert Guru Numbers

usage ^Guru [Guru number]

Thanks to AlienDesign for the GuruList.

@{" Back to Index " LINK commands}
@ENDNODE
@NODE NUT

NUT

Another Fun command just try it :)

usage ^Nut [Nick]

@{" Back to Index " LINK commands}
@ENDNODE
@NODE SVIEW

SVIEW

Shows users Status on TeaBot, shows netmasks and their levels.

usage ^Sview <Nick>

Level 4+ is required to specify a nick.

@{" Back to Index " LINK commands}
@ENDNODE
@NODE QUIT

QUIT

Quit TeaBot off irc, this MUST be used to ensure the latest userlist is saved to Hard 
Disk.

@{" Back to Index " LINK commands}
@ENDNODE
@NODE NICK

NICK

Change TeaBots Nick

usage ^Nick <Nick>

@{" Back to Index " LINK commands}
@ENDNODE
@NODE HUG

HUG

Have TeaBot hug a IRC user :)

usage ^Hug [Nick]

@{" Back to Index " LINK commands}
@ENDNODE
@NODE FART

FART

Guess ;-)

@{" Back to Index " LINK commands}
@ENDNODE
@NODE TRYME

TRYME

This command only works if TeaBot has Operator status on the current channel.
You can play a game like Russian Roulette, if you lose instead of a bullet you get 
kicked off the channel :)

usage ^tryme

@{" Back to Index " LINK commands}
@ENDNODE
@NODE OP

OP

OP yourself or another user,

usage ^op <nick>

Specify no nick and TeaBot will OP you.

@{" Back to Index " LINK commands}
@ENDNODE
@NODE DEOP

DEOP

DEOP yourself or another user,

usage ^deop <nick>

Specify no nick and TeaBot will DEOP you.

@{" Back to Index " LINK commands}
@ENDNODE
@NODE TOPIC

TOPIC

Change the current channels topic if TeaBot has Operator Status,

usage ^Topic <what you want the topic to be>

@{" Back to Index " LINK commands}
@ENDNODE
@NODE SETGREET

SETGREET

TeaBot can greet user joins 

usage ^SetGreet [Nick] [Greet]

@{" Back to Index " LINK commands}
@ENDNODE
@NODE VIEWGREET

VIEWGREET

Show the greet for the specified user

usage ^ViewGreet [Nick]

@{" Back to Index " LINK commands}
@ENDNODE
@NODE DELGREET

DELGREET

Delete the greet for the specified user

usage ^DelGreet [Nick]

@{" Back to Index " LINK commands}
@ENDNODE
@NODE HANGR

HANGR

This is short for Hangman Reset, TeaBot can play a one player game of Hangman, 
but it must be rest first

usage ^HangR <Nick> <Word>

Specify no nick and the game is setup for you. If no work is specified TeaBot picks 
its own random word.

@{" Back to Index " LINK commands}
@ENDNODE
@NODE HANG

HANG

Play hangman ! If you don't know the rules ... :)

usage ^Hang <letter or complete guess>

The game must be setup with the HangR command.

@{" Back to Index " LINK commands}
@ENDNODE
@NODE FSERVASSIGN

FSERVASSIGN

Change the FSERV assign, can only be changed localy and requires Level 6 access.

@{" Back to Index " LINK commands}
@ENDNODE
@NODE FSERVACCESS

FSERVACCESS

Turn on/off access to FServ file server. Requires level 6.

@{" Back to Index " LINK commands}
@ENDNODE
@NODE STATUS

STATUS

Tells you if Fserv/OpsProtection is on or off.

@{" Back to Index " LINK commands}



@ENDNODE

@NODE Author "About the Author"

@{b}About the Author@{ub}

After months of work (well on and off :)) TeaBot is here, if you read the code you'll 
see that I'm a greater spotted newbie when it comes to arexx (TeaBot is my first 
Arexx project).

If you want to get in touch, perhaps to tell me how bad I am at Arexx or perhaps 
even to thank me, Just drop me a Email to;

Ste@Inorbit.Com

or perhaps if you feel like a one to one chat try to find me on irc on #Henry or #AmigaCafe
on the undernet, I hang about as MrQue :)



See ya peeps !

@{" Back to Index " LINK Main}
@ENDNODE

@node Offline "Adding Faqs off line."

Its simple really but you must do it right otherwise 
I don't know what TeaBot will do.

Below is a sample FaqList Database file
    
                                       <--- Database starts with a blank line
@{"@" LINK @}Bots                      <--- This is a faq drawer all drawers start with a @
Ilona The better bot =)                <--- Ilona is the faq topic and the rest is the faq
                                       <--- Blank line seperates Faq Drawers
@{"@" LINK @}Users                     <--- Another drawer (starts with a @)
Dibbs the magic hair dude              <--- Guess
Nikki extremely damn cute floridian :) <--- Guess
				

		
Easy eh ! Just follow those rules and you'll have no problems. 
You'll find the faqlist in s: enjoy yourself :)


@{" Back to Index " LINK Main}
@endnode

@node Thanks "Cast and Crew"
@TOC Main

Who made this ?

Stephen 'MrQue' EVANS - Me ! The guy who made TeaBot. Mail me at 
Ste@Inorbit.com
David 'Dibbs' HANDSAKER - The one and only Beta tester, he also came up with a few 
good ideas which is quite strange for him :)
Michael 'Skeletor' RUSHTON - Wrote the File Serve script that TeaBot can launch :)
Nicholas 'Nich' PIPER - Got me into Arexx, also supplied me with some very cool Arexx guides.
Dave 'Hedgie' CUSICK - For the kind words in @{b}Amiga Format@{ub}. And for also liking Kebabs ;)
Tom 'Fosters' BAMPTON - For loads of testing and ideas on his Undernet channel #Liberty.
Pascal 'Logix' GLOOR - For writing Espresso (Another bot) which I nicked ideas from.
Tristan 'Merc' GREAVES - Found a little bug that I never saw :)
Jan 'Mamlason' HLAVATY - For fixing my HD and making Blizzmagic for my 040.
ALIENDESIGN - For letting me included the MCP.Gurudat file.
Rainer Hilmer - For letting me know that I'd missed stuff out of the ^showcommands list (Thanks :)).

All on #Henry and #Amigacafe for testing and stuff :)

@{" Back to Index " LINK Main}
@endnode




@node History "So how many versions of TeaBot ? :)"

History :


Version 0.96 First Aminet release. 
(05-02-98)

Version 0.96a/b  Removed DCC chat launch of FServ, whoops it doesn't work ! :)
(06-02-98)

Version 0.96c  Added pointer for FServ: to a Env varible, to save people doing assigns =)
(07-02-98)     TeaBot pops up a requester if Fserv assign isn't there. Use ^FservAssign to
               Change the assign after its already set (localy only).

Version 0.96d  Rewrote level code, now requires the user to be on channel or
(19-02-98)     a user supplied usermask, should be _MUCH_ safer :)
               Added Error messages to FServassign and help messages to FServ/FServassign.
               Made TeaBot see more invalid CTCP messages (Just for fun).
               Made TeaBots DCC resume work with different setups (I hope).

Version 0.96e  Added Basic OPS protection to TeaBot, Default setting is OFF, can be toggled on/off
(20-02-98)     with ^OpsProtect command. Hows it works, ok if a op with a level less than 4
               deops another Op (any level) Teabot Reops the op and deops the -4 op :)
               Is that clear I think not :^)

Version 0.96f  Fixed problem with FServ and AmIRC 2.0x (it didn't work), Added Auto 
(28-03-98)     UserDatabase at last (every five minutes it writes the userdatabase back to HD).             
               Hangman now allows any word eg ^hangr MrQue MyNewWord 
               (idea by Philip Goddard, thanks :)) Changed Tryme a little, some of the 
               code cleaned up a bit. Explained in Guide how to Add Faq's @{"offline" LINK Offline} (also PG).
               Amirc doesn't like RAW joins/Parts changed to /Says.
               ===REMEMBER TO REPLACE YOUR FSERV.AMIRX even if you don't use Amirc 2.0x===

Version 0.97   Added Mass change Level to 1 command, use with care, changes the WHOLE of the database
(02-04-98)     (It leaves your hostmask at current level). Changed the welcome to TeaBot message.
               Loads of Cosmetic changes and code optimizations. Fixed the creation of the 
               Faqlist. TeaBot will notify you (If your local to TeaBot) when FServ is connected 
               to or Hangman is setup or a user is added to the database or a level is changed
               (You are Private messaged a notice) :)  Combined FServ into Teabot. Teabot 
               will launch FServ if it gets a ctcp XDCC. Fixed some stuff that I should 
               had done ages ago (too lazy ;)). Fixed a problem (I hope) with Auto database 
               backup not working after midnight. Fixed some stuff in ^Part.  

Version 0.97a Fixed (I hope) join message on startup. And other small stuff.
(12-05-98)

Version 0.97b  FServ can now be disabled with new ^FServAccess command, toggles on/off.
(20-05-98)     Database files are auto-updated, On first run of this new version TeaBot sets
               Fserv to OFF. Updated Guide a bit :)

Version 0.97c  Ever wanted to know if opsprotection or fserv was on/off ^status commands
(14-07-98)     will tell you :)  FServ can now only be launched once per user (will save
               of cpu time etc.). Fserv now only auto quits if no dcc sends are active
               (sending) to current user. More code cleaned up. Fixed typos in this readme ;)
               Updated the guide file.


@{b}Version 0.97d@{ub} Added Tell command.
(08-08-98)    *Special beta-tester birthday edition ;)*


@{" Back to Index " LINK Main}

<>< a ickle fishy.
@endnode


@node Bugs "What bugs ! :)"

Known Bugs.

a) Faq is a little buggy in places.

b) Hangman can't handle flooding, I'm lame ! :)

c) Sort of 2 channel support is coded into TeaBot but it doesn't work very good, 
   and i've stopped supporting this feature in some of the new commands. Sorry ;)


-To do

ReWrite Guide !!!
ReWrite All greet commands, Fix joining message :(
Your ideas ?
Rewrite the whole of the greet commands.
Recode SView command & Add news command.
Learn 'C' and recode it (Never seen any good 'C' guides so it _WON'T_ happen).

@{" Back to Index " LINK Main}
@endnode
 