		Makeroom Addon for e_Chat v4.1 - Installation Instructions.

INSTALLATION INSTRUCTIONS

	1.) NOTE: Before installing mkroom41.cgi, chmod your chat's "parent directory" (usually called echat41) to 777.

	2.) Now you're ready to configure mkroom41.cgi.

		a. The path to perl (top line) should match your other scripts.

		b. $pass is the password you'll use to access the admin functions of mkroom40.cgi.  It can consist of from one to eight characters of any kind.

		c. If $autonuke is set to yes, old rooms are deleted automatically every time that mkroom40.cgi is run.  If set to 'no', you'll have to delete old rooms manually, but you can check room logs this way, in case there's trouble.

		d. $roomtimeout is the number of seconds that a room can be inactive before it is "autonuked".  Default is 600 (10 minutes).  The script checks the last modification time for the appropriate message.htm.

	3.) Upload mkroom41.cgi to the directory where your other cgi scripts are, and chmod 755.

NOTE: For UNIX servers, there is no need to add any links to echat41.cgi.  If this script is in the same directory as echat.cgi, it will be detected and a link will be provided.  To run on NT servers, you need to make the follow change.  In echat41.cgi, find the line:

$makeroom = '';

and change it to:

$makeroom = '1';


Using mkroom41.cgi

	Users need to log on to the main room to access this service.  This way, banned users can't make rooms, and you have the users entry on your main log in case you need it later.

	After they log on, users can click the [Create Private Room] link, and they will see a form.  They type in the room name, and select from a list of current occupants from the main room to invite to their private room.  Each "invitee" will receive a private message, informing them that such-and-such is inviting them to [room name].  The room name will display as a link to the private room.  All they have to do is click it, and the private room will start in a new browser window (for most users), so they won't necessarily have to leave the main room to enter the new room.  All room functions are available in private rooms.  Another user can even create a room off the private room if they want.

	However, each user is only allowed one private room at a time.  If they try to create another, they'll get a screen that offers a link back to their current room, or an offer to delete that room, and build a new one.  This way, you'll never have more rooms than you have users.  At least, you won't if you enable $autonuke (='yes').

	Administrative Functions.

	Admin can access these functions two ways.  If you're logged on, you can click the [Create Room] button, and type your password ($pass) into the room name box.  You will access the admin page then, which lists the private rooms, allows you to select rooms for deletion, and supplies links to the admin frameset for existing private rooms.

	If you're not logged on, you can access the admin functions by typing an URL using the following format in your browser's location box:

		http://www.domain.com/cgi-bin/mkroom41.cgi?newroom=pass

replacing the front part with the complete URL to mkroom41.cgi, and replacing 'pass' with your admin password ($pass in mkroom41.cgi).  Make sure that both the ? and the = are where they should be.  If this seems a bit confusing, don't worry.  It's supposed to.  Once you access the page, just bookmark it, and you won't have to type that URL again.

	NOTE: If you set $autonuke to 'yes', you probably won't need to access this page much.  The system will delete old rooms for you.

One last point, if your header.html still includes the name of the public room, and that name is still the same as the name of your public directory (probably 'public'), then the room name in the new header.htm will be changed to the new name when that room is created.  But this works ONLY if the name shown on header.htm is identical to that room's directory name (default 'public').  Case doesn't matter (public, Public, or PUBLIC will all work).

In Case of Errors

If you're sure you've got it set up right, but get an error whenever you try to set up a room, you may need to change "mkdir" and "rmdir" in the script.  Sometimes these commands need to include the path (Ex. /bin/mkdir, /bin/rmdir).  Find out from your provider what the correct paths are, or try the ones shown here.  This may also be necessary for "chdir."


Well, I think that's everything.  If you have problems with this, or something isn't clear, just email me at mb@e-scripts.com, and I'll help.

Good luck!

Mike