[dRUNkEN] Announce! 0.4 -NON PUBLIC BETA-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
(C)2001 Rezine/dRUNkEN (rezine@criminology.de)



1. What's this?
~~~~~~~~~~~~~~~
Announce 0.4 is a simple set of tools for DayDream/*NIX BBS and EggDrop 1.6.x
which allows your Eggdrop bot to announce your BBS users logon's, logoff's
and new file uploads to an IRC channel in which the bot sits in.

It laid all around in my drawers until today :) And, doh, I restarted it from
scratch, in say, 3 hours, so don't expect too much ;)

2. Installation
~~~~~~~~~~~~~~~

- Compile the door. Usually this may be done through just running "make" in
  the directory where you unpacked the sources.
  
- Copy the binary ("announce") to your $DAYDREAM/doors directory.

- Copy the TCL script ("ann.tcl") into your bot's script directory

- Copy the configuration file ("dkn-announce.cfg") to $DAYDREAM/configs

- Edit the configuration file AND the TCL script to fit your needs.

- Create a new group on your system (man groupadd). If you go with defaults,
  name this group "announce" (This documents refers to the freshly created
  group's name as "announce" from now on, if you used another name for the
  group, just substitute "announce" with "yourgroupname")

- Make this group a SECONDARY group of the users "bbs" and the user your
  eggdrop bots run within. Do not let any other user join this group. This
  group is _only_ for the bot and the BBS user.

- Create a directory ("/tmp/dkn" e.a.). Chown this directory to "root.announce"
  and chmod it 770 (e.a. make it GROUP WRITEABLE by the group "announce") This
  directory is the one you have stated in your dkn-announce.cfg on line 2.
  In this directory, creat a file called "stay" and chown it to root.announce
  (touch /tmp/dkn/stay && chmod 644)

- Add two menu entries in your daydream.cfg to run a door :

   DOOR_COMMAND.. ANNLOGON
   DOOR_TYPE..... 1
   DOOR_SECURITY. 10
   DOOR_EXECUTE.. /home/bbs/doors/announce %N LOGON
   DOOR_CONFS1... XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   DOOR_CONFS2... XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   +
   DOOR_COMMAND.. ANNLOGOFF
   DOOR_TYPE..... 1
   DOOR_SECURITY. 10
   DOOR_EXECUTE.. /home/bbs/doors/announce %N LOGOFF
   DOOR_CONFS1... XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   DOOR_CONFS2... XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   
   Save the file and compile it with the "utils/ddcfg" tool. This will announce
   Logons and Logoffs.
   
   Don't forget to call this doors at logon and logoff (e.a. "$DAYDREAM/data/
   logindoors.dat" and "$DAYDREAM/display/iso/goodbye.gfx" respectively)
   

- To have uploaded files announced, put for each conference you want the uploads
  to be announced in a line in the file "examine.dat"
  E.a. put in "$DAYDREAM/confs/[confname]/examine.dat" the following line :

     /home/bbs/doors/announce %N

  NOTE: Newfile announcing is done on a per-conference base.

- Have your EggDrop load the script "ann.tcl" by default and restart (or rehash)
  it.
  
- Voila, you're all set. Your bot will now do announces minutely.
  

3. Customization
~~~~~~~~~~~~~~~~

To customize what your bot will say edit $DAYDREAM/configs/dkn-announce.cfg

You can customize the logon, logoff and the newfile announce with so called
TAGS.

In the LOGON and LOGOFF announce you may use the following TAGS :

	@USER:L0@ 		- Will be replaced with the nick of the user logged on.
	@GROUP:L0@		- Will be replaced with the group of the user logged on.
	@NODE:L0@		- Will be replaced with the node the user logged on to.

Additionally, you can use the following two tags in the LOGOFF announce :

	@UPPED:L0@		- Replaced by the bytes uploaded this session.
	@LEECHED:L0@	- Replaced by the bytes downloaded this session.

In the Newfile announce you may use the tags as in LOGON and LOGOFF as well
as the following TAGS :

	@FILE:L0@		- Replaced by the name of the uploaded file.
	@CONFNR:L0@		- Replaced by the number of conference in which was uploaded.
	@CONFNAME:L0@	- Replaced by the name of the conference.

For questions about the tags and formatting please see the comments in the
"parseme.c" file included with this NON-PUBLIC beta release ;)


BUGS!!
~~~~~~
There is a known bug in the parser routine. Your logon/logoff/upload strings,
as defined in the dkn-config.cfg, may _NOT_ contain any "@" characters other
than the one which are surrounding the tagnames. Likely, when you have a user
on your system which nick or groupname contains an "@" sign, the door will
NOT announce that event and will exit with a coredump. Hopefully I manage
to fix that until release ;)

That's all for now.
Have fun and cheers,
rezine (rezine@criminology.de)

Send bug reports!!!!!!

Drunken's website : http://www.criminology.de/drunken/
It's WU motherfucker.	