Lamer Reporter
FOR : UT 436-440-451 Windows/Linux >DEDICATED< Servers
Version 1.38 - January, 2007
Created By MSuLL
WebSite: http://www.atomicunreal.com/msull/



Requirements -
Windows or Linux >DEDICATED< UT Server
Web Components Require PHP 4/5 (optional)



Information:
***************

Take the time to read through this file, and it will
save you and I both a lot of time.

THIS MOD IS FOR UT (UNREAL TOURNAMENT 1999 / GOTY) ONLY!
IT DOES NOT WORK WITH UT2003, UT2004, or, UT2007!




About:
*********

Everyone has those players which, from time to time,
cause disruptions on the server.  Also, every admins knows
that sometimes, server settings can get totally messed up.
Players will many times try and help out by reporting these
issues, but then comes the confusion of having to look over
all the logs and figure out when the event occured, because
many times players do not note the time of day.

This mod will solve the problem.  When there is an issue
on your server, a player can simply say aloud "!report",
and a window will open for them which provides them with
the ability to specify a player, and give a reason as to
why they are reporting the offender.  Upon submission,
the report can either be:
1) Saved as a log on the server (to the path of your choosing)
2) E-Mailed to you
3) Posted on a phpBB forum
4) Both 2 and 3 at the same time


Lamer Reporter provides two great features:

1.) Accurate reporting.  Player IPs are instantly recorded and posted.

2.) Simple log referencing.  Each report is given a timestamp which
can be cross referenced to logs that use the same timestamp filename format.
These include: UTStats, NGStats, UTDC, ASC, Advanced Chat Log System, and more




About This BETA Software:
****************************

This software should be considered BETA software.
I cannot be held responsible for any damage done
to your server(s) while you attempt to install or
run this mod or any of its components.
This mod's web component has been tested extensively,
but an incorrect configuration by a server admin
could yeild undesired behavior.

This software's web component has been tested on
a Linux-based webserver running Apache 2 and PHP 4.
phpBB posting has only been tested on a forum
running phpBB 2.0.22.  It has not yet been tested
on "nuke" platforms (PostNuke, phpNuke)

If planning to participate in the testing of this mod,
and you succeed in getting the web component of the mod
working with other platforms or webserver / PHP builds
other than those already mentioned above, please let me know.

If anyone is willing to port this to vBulletin (vB),
Invision Power Board (IPB), or Simple Machines Forum (SMF),
please let me know - I'd be glad to include compatability
in the final release.




Installation:
****************
Upload to your server:
./ut_files/System/LamerReporter_138.u


Shut down your server and open your server's INI
(usually UNREALTOURNAMENT.INI or SERVER.INI).
Find the section for [Engine.GameEngine]



Add the following lines:
ServerActors=LamerReporter_138.LamerReporter
ServerPackages=LamerReporter_138

Now go to the end of this file, and add the following section:

[LamerReporter_138.LamerReporter]
SubmitMethod=0
ServerIP=
ReporterServer=www.examplehost.com
ReporterPath=/examplepath/reporter.php
ReporterPort=80
ServerKey=mykey
LogTo=../Logs
bIncludeMap=True
bIncludeName=False
LogFileHeading=[LamerReporter]
BlockedSenders[0]=
BlockedSenders[1]=
BlockedSenders[2]=
BlockedSenders[3]=

Change any values you desire in the
[LamerReporter_138.LamerReporter] section
(their options are found in the next section)

Save your changes.

Start your server up, and enjoy!




How To Use:
**************
It's very easy. Tell your players to simply say:

!report

...and a window will automatically open for them.
Also, the console command 'mutate report' will do the same.
Even though the player says !report, nobody will know.

This mod will block other players from knowing that
anyone has opened the Lamer Reporter window.
(they will not be able to see it if someone says !report)
The mod is 100% silent to clients on the server.





Settings Explained:
**************************

+ SubmitMethod=
Set to 0 for external logging
Set to 1 for webserver functions (E-Mail or phpBB posting)

+ ServerIP=
This mod will need to use your server's IP address so that
it can provide information pertaining to what server
a report is filed from (in case you have multiple servers)
If left blank, the mod will attempt to auto-detect the server IP.
However if this does not work correctly, you can specify it manually here.
Leave off the port number.

+ ReporterServer=
The domain name or IP address of the webserver running the
Lamer Reporter PHP files (no http:// and no slashes!)
[Only used if SubmitMethod is set to 1]

+ ReporterPath=
The path to the Lamer Reporter PHP files (have a slash at the beginning)
[Only used if SubmitMethod is set to 1]

+ ServerKey=
The password to be able to have UT contact the webserver
and send reports.
--
[IMPORTANT] THIS MUST MATCH THE KEY YOU ENTER INTO THE CONFIG.PHP FILE [IMPORTANT]
--
[Only used if SubmitMethod is set to 1]

+ LogTo=
Folder in which to place the log files? (no trailing slash!)
[Only used if SubmitMethod is set to 0]

+ bIncludeMap=
This adds/removes the map's name from your log's filename.
[Only used if SubmitMethod is set to 0]

+ bIncludeName=
This adds/removes the server's name from your log's filename.
[Only used if SubmitMethod is set to 0]

+ LogFileHeading=
Logs will be saved with a tag in their filename to identify them as
Lamer Reporter logs.  If you wish to change this tag, or remove it
entirely, you should change this.

+ BlockedSenders[i]=
If you have trouble with people making bogus reports, you can block
them from being able to use this mod by adding their IP address
into one of these fields.
You may use masks to specify IP ranges, for example: 192.168.1.*
There you can have up to BlockedSenders[255] filled.




Setting Up The Webserver For SubmitMethod 1:
***********************************************
Upload all the files in the ./webserver_files/reporter directory to
a directory on the webserver.  Be sure to set ReporterServer and ReporterPath
correctly so that they point to this location.  Open CONFIG.PHP and
follow the configuration instructions in there.




Copywrites:
**************
email() function and email.php by Jason Jacques - http://poss.sourceforge.net/email
phpBB by phpBB Group - http://www.phpbb.com
NewPhpbbTopic() function by Mike Placentra - http://www.website-tech.com



Changelog:
*************
----------------
| Version 1.38 |
----------------
- Official Relase (Public Beta)


----------------
| Version 1.00 |
----------------
- Initial Relase (Private Beta)






+-------------+
|  Thanks To  |
+-------------+
- The players of WhartHog's PigPen

- UnrealAdmin.org - my little base of operations.

- Those mentioned in the copywrites section for
  being kind enough to let the world use their
  creations at no cost.






----------------
| MSuLL - 2007 |
----------------