@database AmiBot.guide

@node main Documentation for AmiBot

                               AmiBot v0.85ß
                   960224, johan englund, na94jed@student.hgs.se

                            @{"Acknowledgements  " link ack}
                            @{"Introduction      " link whatis}
                            @{"Installation      " link install}
                            @{"Usage             " link using}
                            @{"Configuration     " link variables}
                            @{"Future plans      " link future}
                            @{"History           " link history}


            In case you wonder, this program has NO backdoors written
            by me. If there are any, they have been hacked into place
            by other low-life creatures. I have no interests in getting
            inside your amiga. Though, this is hard to prove without
            releasing the sourcecode, which I do not plan to do, so
            the best way for you to feel secure is to get it from my
            www, this way you will only have to trust me, and not all
            the couriers!
                                    Hey! I'm a nice guy!
@endnode

@node ack Acknowledgements

@{b}Thanks goes to:@{ub}

    Osma Ahvenlampi (tau) for the help with dcc send/move.

    All the people who helped me find BUGS, there were plenty of them,
    and still are, I suppose :).

@{b}Contact address@{ub}

    If I'm on the IRC I usually go under the nick Texas or TexasX.
    Feel free to chat with me there!

    Send your bugreports, comments, suggestions, requests, contributions
    etc. by email to <na94jed@student.hgs.se>

    The e-mail stated here in erlier versions was WRONG!
    na94jed@hgs.se do NOT work, na94jed@student.hgs.se WORKS!

    WWW: http://www.hgs.se/~na94jed
         This is where you can get the most recent version.

@endnode

@node whatis What is a Bot?

@{b}What is a Bot?@{ub}

    Definition ? not ready...

@endnode

@node install Installing

@{b}Installation instructions@{ub}

    Unpack the file (which you aparently done allready) into a dir of its
    own or wherever you would like it.

    No installation script provided, seems meaningless.

@endnode

@node using Using DCC.Send

@{b}So how do I use the bot ?@{ub}

    Start the bot from a shell or WB. The config and userfile currently
    has to be located in PROGDIR, ie. the same directory as the AmiBot binary.

@{b}Command line arguments@{ub}

    Currently only one.

    LOGFILE/S   If this argument is present AmiBot will open and keep a
                logfile in PROGDIR named AmiBot.log.
                This file will be feeded with error and some other messages.

@{b}Bot commands@{ub}

    The commands can currently only be issued through IRC, either with
    /msg or a DCC CHAT connection.

        help            - x - show some quick help (only through dcc chat)
        cd <dir>        - 3 - change directory to <dir>
        dir [<dir>]     - 3 - show <dir> (wildcards is supported)
        delete <d>      - 3 - remove the file/dir <d> in the current path
                              no wildcards supported yet.
        mkdir <dir>     - 3 - make directory <dir> in the current path
        send [<n>] <f>  - 3 - DCC SEND file <f> to <n> (optional)
        move [<n>] <f>  - 3 - DCC MOVE file <f> to <n> (optional)
        comment <f> <c> - 3 - Attach AmigaDOS filecomment <c> to file <f>
        dcclist         - 8 - Show list of all current dccs (only through
                              dcc chat)
        killdcc <id>    - 8 - kill the dcc with id <id>. Works only on dcc
                              chat connections yet!
        msg <d> <m>     - 8 - send message <m> to destination <d>
                              The destination can be either a channel or a nick.
                              If it is a channel it should have the prefix '#'.
        adduser <u> <n> - 8 - add the user <u> to userlist and give her axx <n>
        killuser <u>    - 8 - remove user <u> from userlist
        setaxx <u> <n>  - 8 - set the user <u>s axx to <n>
        getusers        - 8 - reread the userlist
        saveusers       - 8 - save the current userlist
        userlist        - 5 - show list of users (only through dcc chat)
        axx             - x - show access level
        time            - x - show local time
        join #<channel> - 8 - make the bot join <channel> (don't forget the #)
        part #<channel> - 8 - make the bot part <channel> (don't forget the #)
        nick <nick>     - 8 - change bots nick to <nick>
        shutdown        -15 - kill the bot
        

@endnode

@node variables Configuration of Amibot

@{b}The Bot Config File@{ub}

    The config file should be present in the PROGDIR dir as 'AmiBot.conf' at
    the moment.

    This file is binary and it should not be edited with a text editor. Use
    the MUI interface instead.

    Use the example AmiBot.conf file and alter it to suit your needs and it should
    work for ya without problems.

@{b}The Userfile@{ub}

    The userfile should be present in the PROGDIR dir as 'userlist' at the
    moment.

	Users are matched with help of the amiga wildcard expressions.

		Ex. You want to add the user

   		       ~mramiga@ppp17.gars.america.org

	       this could look like

	    	   #?mramiga@america.org

		    in the userlist file.


	User access levels: (These are not all implemented yet)

       -2 user will be kick/banned upon join
       -1 user will be kicked upon join
		3 files
		5 opped,files
		8 CoSys, join/part channel, msg, opped, files, setaxx, add/kill users,
          save userlist
		15 operator, may do everything

@endnode


@node future Future plans for AmiBot

@{b}What will happen to AmiBot?@{ub}

    New functions that should be added:

        Multi channel support
		SUGGESTIONS ?!??! Would a filechecker be nice ? or ?
        Mail me with sugg. I'm runnin out of ideas...

@endnode


@node history Changes in AmiBot

@{b}What has happened to AmiBot?@{ub}

@{i}0.85ß@{ui}
    New cmd: time, op, kick, ban
    ls changed into dir and wildcard compatibility was added
    New access levels, -1 and -2
    Fixed a nasty bug that made amibot close down if user requested a
      that didn't existed! Can't belive that I didn't notice this bug.
    General bug fixes

@{i}0.81ß@{ui}
    Bug fixes

@{i}0.8ß@{ui}
    Got rid of MUI, code got about 3k smaller and AmiBot uses about 250kb less mem,
      incl. MUI, and the GUI is noticible faster. The GUI is font sensitive but some
      features still has to be added.
    Last message now shows the 10 last messages

@{i}0.72ß@{ui}
    Added ability to send dccs to another nick
    Fixed bugs

@{i}0.7ß@{ui}
    Removed bug that made the bot to hang if killing a dcc on a bad occation
	Rewrote parts, made it more stable, I hope :)
    Added some more messages for the "Last message" in the mui

@{i}0.6ß@{ui}
    All DCC stuff are now internal!
    Ability to select buffer size for the dccs, the bigger the better...to a certain point :)
    New cmds: saveusers, adduser, killuser, setaxx.
    Rewrote a couple of functions in asm to make the cpu happier

@{i}0.5ß@{ui}
    Internal DCC MOVE
    GUI Implemented (MUI)
    Userdefined shutdown msg.

@{i}0.4ß@{ui}
    New cmds, mkdir, delete.
    No more Excess flood!
    Found a nasty bug in the comment cmd.

@{i}0.3ß@{ui}
    Debugged and enhanced the comment command
    Fixed directory compatibility
    Tries to reconnect to server if connection is lost.
    Debugged the msg command, now it works :)
    Fixed a bug that made enforcer hits when closing a dcc.

@{i}0.2ß@{ui}
    Still hunting bugs and inventing new ones.

@endnode
