README.TXT
plugin_sank_consgreet
November 15, 2002
FOr AdminMod version 2.50.50 or newer.
http://www.adminmod.org


Table of Contents:
===============================================================================
1. Files Included
2. Plugin Description
3. Plugin Commands
4. Installation Instructions
5. Advanced Instructions
6. snd-list.cfg Help Guide
7. Troubleshooting
8. Revision History


1. Files Included:
===============================================================================
README.TXT - This file.
plugin_sank_consgreet.sma - Plugin source.
plugin_sank_consgreet.amx - Compiled win32 version.
plugin_sank_consgreet_l.amx - Complied linux version.
consgreet.txt - sample file.


2. Plugin Description:
===============================================================================

This plugin take the contents of a text file and print it to the user
when they connect. The text file can have "macros" that will get replaced
with real data as it prints to the client.


3. Plugin Commands:
===============================================================================

admin_console_greet
 Prints the console greeting message to the console, incase you couldn't read
 it all when you connected.
 Usage: admin_console_greet
 Access required: ACCESS_ALL


4. Installation Instructions:
===============================================================================

Linux guys be sure to specify the -a flag when unzipping the text files so that
the line ends are converted properly.

1.) Put the plugin_sank_consgreet.amx (plugin_sank_consgreet_l.amx if you run
linux) file in your mod's addons\adminmod\scripts directory, as described in
the Admin Mod installation guide, and modify your
addons\adminmod\config\plugin.ini file to include the line,
"addons\adminmod\scripts\plugin_sank_consgreet.amx"
(plugin_sank_consgreet_l.amx if you run linux) also as described in the Admin
Mod installation guide.  The antiflood plugin should be the very first entry in
the plugin.ini file for maximum effectiveness.

2.) Put the consgreet.txt file in your Admin Mod's config directory, for
example, "..\half-life\cstrike\addons\adminmod\config\consgreet.txt" or
"..\hlserver\%MOD%\addons\adminmod\config\consgreet.txt"

3.) There is one CVAR that affects this plugin: file_access_read.  It is
required to be set at 1.

4.) That's It!


5. consgreet.txt help guide:
===============================================================================

The script reads in one line at a time. Lines beginning with a '#' or '//' are
ignored.  If a "macro" is found in the line, it is replaced with real-time
actual information.  Here is the list of macros supported and what they mean:

%USER%          Client Name
%IP%            Client IP address
%AUTHID%        Client Auth ID (only works from "admin_console_greet")
%MAP%           Current Map
%NEXTMAP%       Next Map
%PLAYERS%       Number of players
%MAXPLAYERS%    Number of max players
%TEAM=n%        Number of players on team n where n is a number
%MONTH%         Current month  ie. January
%DATE%          Current date   ie. 15
%DAY%           Current day    ie. Monday
%TIME%          Current time   ie. 17:00
%YEAR%          Current year   ie. 2001
%CVAR=n%        Value of n where n is a CVAR  ex: CVAR=hostname
%TIMEINTO%      Time into the current map in minutes
%TIMELEFT%      Time left on the current map in minutes

Please see the sample included consgreet.txt file for example usage.


6. Revision History
===============================================================================
 * July 7, 2001 - Began writing
 * July 16, 2001 - First released version?
 * November 15, 2002 - Updated path to consgreet file to follow new
 *  directory structure.  Removed capability for displaying files other than
 *  the consgreet file because it was a security issue.  Also removed code
 *  to reset file_access_read CVAR, also a security issue.

That should give you the details to be an expert, if you have any questions or
bug reports, contact info is in the Plugin Description section.

Luke Sankey
sank@spu.edu