README file for Ncohafmuta 1.1.1pl1 Talker program
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This file is in the current directory "ncohafmuta"

Compiling-------->  "make"  compiles the talker code
                    "make test" makes a.out test binary from .c file
                    "make clean" removes a.out, core, and syslo* files
                    "make logclean" removes syslo* and lib/lastlogs
                    "make dist" makes the distribution in tar.gz format
                    "make distuu" makes the dist. in uuencoded text format

***** MAKE SURE YOU MODIFY THE Makefile FOR YOUR SYSTEM  *****
***** BEFORE YOU TYPE "make" TO COMPILE                  *****

The following directories and files exist underneath..
Makefile         - This file makes/compiles the talker code (type: make)
alertdir         - Directory containing userdata for the .alert command
authuser.h       - Library code file (should not be touched)
backup           - Script to backup all data files.
backupd          - Where the backup archives reside
bot              - Where all the robot files reside
config           - Directory containg room descriptions, atmospheres, and
                   the talker INIT file. There is a README file in this
                   directory to tell about the format used in init_data.
config/birthday     - Room desc for a user's birthday to go in main room.
config/<room_name>  - A room's room description (ascii text)
config/<room_name>.atmos
                    - A room's atmospherics
config/init_data    - File containing the room connections and names.
                      Read the README file for more information.

linux_fortune    - Linux version of the "fortune" program for .quote
                   (if your system doesn't have it)
gagdir           - Directory containing userdata for the .gag command
helpfiles        - Directory containing the talker's help files.
helpfiles/map    - The map for the talker's .map
helpfiles/TOP    - Script to update the helpfiles list. READ this.
helpfiles/birthday - Birthday file for the month
constants.h      - Library code file
text.h           - Another Library code file
junk             - Directory used to hold temp storage files
lastcommand      - File containing the last command before a crash.
lib              - Directory containg the MOTD, FAQ, WIZLIST, etc..
lib/CHANGES      - All technical changes made to the talker!
lib/motd0        - First random MOTD
lib/motd1        - Second random MOTD
lib/faqfile      - FAQ file
lib/newsfile     - Talker news. File read for  .news
lib/wizlist      - talker's wizard list
lib/schedule     - file used in .schedule
lib/downchat.txt - text file shown during the "down" program
lib/down         - Script that should be up/running when talker is down.
lib/announce     - Program run from "down" script
lib/make_announce- Script that compiles the announce program on your host
lib/exempts      - File containing users exempt from .expire
lib/namebans     - File containing names that are banned from use
lib/agreefile    - File new users see before confirming their password.
lib/activity     - File login activity is appended to by the talker at
                   the end of each day.
lib/votefile     - File containing current vote issue for .vote
Do a ".vote -c" as ROOT_ID to start or reset a vote. THEN do a
.vote -d to enter the vote topic. Don't do it the other way around!
Shouldn't touch the following 2 files.
lib/votetallies  - File containing the tally of votes        (don't touch)
lib/voteusers    - File containing the users that have voted (don't touch)

macrodir         - Directory containing users macro files
maildir          - Directory containing users mail
messboards       - Directory containging all rooms message boards
messboards/gripes   - Gripes/Complaint board
messboards/suggs    - Suggestion board
messboards/wizmess  -  Wizard message board
newrestrict      - Directory containg sites banned from making new users
picture          - Directory containing .preview, .picture, and .ptell files
prodir           - Directory containing users profiles
restart          - Script to restart the talker
restrict         - Directory containing sites banned from all logins
server           - Actual talker program that gets runned (cannot be edited)
server.c         - Actual code file (should only be edited by programmer)
syslog           - Logging file for the talker
syslog.<date>    - Syslog from last talker reboot till this reboot.
users            - Directory containing all users main data files
utils            - Directory containing talker utilities (if any)
utils/README     - Readme file for talker utilities in utils/ directory
wizinfo          - Directory containing wizard information (emails, etc..)
warnings/        - Directory containing logs for problem users (made from
                   .wlog)
www/             - Directory containing a **JAVA** telnet client for the
                   talker if the server the talker is on is a www server.
www/README       - Readme file for the java client, if you can use this.

  -Cygnus  7-3-97  cygnus@misty.com

Basic notes for other talkers using this code
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Change variables in constants.h, esp. SYSTEM_NAME, Rank descriptions,
  , ROOT_ID, mail & fortune paths if necessary.
* Change fight odds in text.h based on how many ranks you set up.
* Change BOTS_ROOT_ID and BOT_ID if you plan on using the bot
  in bot/
* Also for the bot, read the README in the bot directory, that will
  tell you about that stuff.
* Change motd0, motd1, faqfile, wizlist, newsfile, config/init_data,
  agreefile, config/atmos's.
* Run lib/comp_announce
* Edit lib/down for the port number the talker usually runs on, so when
  you use down to start announce it runs on the same port the talker is
  set at.
* Read README file in config/ directory.
* In .c file, change .<ROOT_ID> command to your ROOT_ID
