Update README and LICENSE files

3 files changed, 256 insertions, 317 deletions

diff --git a/license.txt b/LICENSE
index 05c6253..102c5f2 100755..100644
--- a/license.txt
+++ b/LICENSE
@@ -1,79 +1,79 @@
-Open Unreal Mod License 

-Version 1, March 2004

- 

- 0. Definitions

- "Program"       the work, either in binary or source form, that has a notice 

-                 attached to it stating that it has been released under this 

-                 license it by the copyright holder.

- "Modification"  a derivative of the Program or any other work based on the Program

- "Linking"       using parts of the Program, or using parts of any other work, 

-                 thus creating a direct dependency

- "You"           the licensee

- "Runtime Environment"

-                 the virtual machine or operating system required to run the 

-                 Program, as released by the Publisher or Creator of said

-                 runtime environment. This includes any extentions or updates

-                 for the runtime environment released by the Publisher or 

-                 Creator.

- 

- 1. License

- Herewith everybody is granted permission to copy and distribute verbatim copies 

- of this document. The only restriction lies on changing the content, with the 

- exception to translation of this license.

- 

- This license applies to the Program that has been released under this license. 

- The license only applies to copying, distribution and modification of the 

- Program. Execution or output of the Program are not covered by this license, 

- however the right for additional limitations on the use (that do not cover 

- copying, distribution or modification) is granted to the copyright holder.

- This license is only valid when all terms in this license comply with the 

- licenses of the dependecies of the Program. This includes the license of the

- possible required runtime envoirement.

- 

- 2. Copying and distribution

- You are granted to copy or distribute verbatim copies of the Program, on any 

- medium, or in any format as you see fit. You are not limited to charging a fee 

- for the physical act of transferring the copy, nor are you limited to provide 

- warranty for the Program in return of a fee. Unless this is prohibited by the

- license of the Runtime Envoirement.

- 

- Any distribution of the program should be accompanied with a verbatim copy of 

- this license.

- 

- 3. Modification

- You are allowed to modify the Program, or portions of it, therefore making it a 

- derivative of the Program. You are allowed to distribute your modifications under 

- the following conditions:

-         - You must clearly state that it is a modification or derivative of the 

-           Program

-         - The original copyright notice must be kept intact

-         - The modified files must contain notices of the changed made to it

-         - The Modification must be released under the same license as the Program

-         - Distribution happens in compliance with section 2

- 

- 4. Source

- The original source of the Program or Modification must be freely available on 

- request.

- 

- 5. Linking

- The Program or Modification may only link with other work that have been 

- released as free software.

- 

- The license grants exclusive right to link with any part of the Runtime 

- Environment, as provided by the publisher or creator of said Runtime 

- Environment. 

- Reusing pieces of source code available in the runtime environment in the 

- Program is only allowed under the following terms:

-         - the "borrowed" code is clearly marked to originate from the runtime

-           environment, quoting the original copyright.

-         - the following notice is added to the top of the file:

-           "This file contains portions of code from the runtime environment."

- 

- The right to "port" the Program to another runtime environment is reserved for 

- the copyright holder.

- 

- 6. NON WARRANTY

- THIS SOFTWARE DOES NOT COME WITH A WARRANTY OF ANY KIND, UNLESS NOTED OTHERWISE 

- BY THE COPYRIGHT HOLDER OR WARRANTY PROVIDER. THE ENTIRE RISK OF THE PERFORMANCE 

- AND QUALITY OF THE PROGRAM LIES WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, 

- YOU WILL ASSUME ALL COSTS FOR REQUIRED REPAIR OR CORRECTION.
\ No newline at end of file
+Open Unreal Mod License
+Version 1, March 2004
+
+ 0. Definitions
+ "Program"       the work, either in binary or source form, that has a notice
+                 attached to it stating that it has been released under this
+                 license it by the copyright holder.
+ "Modification"  a derivative of the Program or any other work based on the Program
+ "Linking"       using parts of the Program, or using parts of any other work,
+                 thus creating a direct dependency
+ "You"           the licensee
+ "Runtime Environment"
+                 the virtual machine or operating system required to run the
+                 Program, as released by the Publisher or Creator of said
+                 runtime environment. This includes any extensions or updates
+                 for the runtime environment released by the Publisher or
+                 Creator.
+
+ 1. License
+ Herewith everybody is granted permission to copy and distribute verbatim copies
+ of this document. The only restriction lies on changing the content, with the
+ exception to translation of this license.
+
+ This license applies to the Program that has been released under this license.
+ The license only applies to copying, distribution and modification of the
+ Program. Execution or output of the Program are not covered by this license,
+ however the right for additional limitations on the use (that do not cover
+ copying, distribution or modification) is granted to the copyright holder.
+ This license is only valid when all terms in this license comply with the
+ licenses of the dependencies of the Program. This includes the license of the
+ possible required runtime environment.
+
+ 2. Copying and distribution
+ You are granted to copy or distribute verbatim copies of the Program, on any
+ medium, or in any format as you see fit. You are not limited to charging a fee
+ for the physical act of transferring the copy, nor are you limited to provide
+ warranty for the Program in return of a fee. Unless this is prohibited by the
+ license of the Runtime Environment.
+
+ Any distribution of the program should be accompanied with a verbatim copy of
+ this license.
+
+ 3. Modification
+ You are allowed to modify the Program, or portions of it, therefore making it a
+ derivative of the Program. You are allowed to distribute your modifications under
+ the following conditions:
+         - You must clearly state that it is a modification or derivative of the
+           Program
+         - The original copyright notice must be kept intact
+         - The modified files must contain notices of the changed made to it
+         - The Modification must be released under the same license as the Program
+         - Distribution happens in compliance with section 2
+
+ 4. Source
+ The original source of the Program or Modification must be freely available on
+ request.
+
+ 5. Linking
+ The Program or Modification may only link with other work that have been
+ released as free software.
+
+ The license grants exclusive right to link with any part of the Runtime
+ Environment, as provided by the publisher or creator of said Runtime
+ Environment.
+ Reusing pieces of source code available in the runtime environment in the
+ Program is only allowed under the following terms:
+         - the "borrowed" code is clearly marked to originate from the runtime
+           environment, quoting the original copyright.
+         - the following notice is added to the top of the file:
+           "This file contains portions of code from the runtime environment."
+
+ The right to "port" the Program to another runtime environment is reserved for
+ the copyright holder.
+
+ 6. NON WARRANTY
+ THIS SOFTWARE DOES NOT COME WITH A WARRANTY OF ANY KIND, UNLESS NOTED OTHERWISE
+ BY THE COPYRIGHT HOLDER OR WARRANTY PROVIDER. THE ENTIRE RISK OF THE PERFORMANCE
+ AND QUALITY OF THE PROGRAM LIES WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE,
+ YOU WILL ASSUME ALL COSTS FOR REQUIRED REPAIR OR CORRECTION.
diff --git a/install.txt b/README.md
index 7d2cd4d..da3674e 100755..100644
--- a/install.txt
+++ b/README.md
@@ -1,186 +1,177 @@
-UTStats

-Copyright (C) 2004/2005 azazel, )°DoE°(-AnthraX and toa

-

-This program is free software; you can redistribute and/or modify

-it under the terms of the Open Unreal Mod License.

-See license.txt for more information.

-

-===============================================================================

-Contents

-===============================================================================

-

-1. Installing the Server Actor

-2. Installing the web stuff (new install and upgrade)

-3. Importing Logs

-4. Known Bugs/Issues Still

-5. License

-

-===============================================================================

-1. UTStats Actor Install Information

-===============================================================================

-

-From the System folder in the zip file, copy to your UTServer\System folder the

-following files:

-

-UTSAccuBeta4_2.u

-UTStatsBeta4_2.u

-

-Remove any previous entries for UTStats and UTSAccuBeta from [Engine.GameEngine]

-

-Add to [Engine.GameEngine] the following lines:

-

-ServerPackages=UTSAccuBeta4_2

-ServerActors=UTStatsBeta4_2.UTStatsSA

-

-Under the [Engine.GameInfo] check for:

-bLocalLog=True or bLocalLog=False

-

-This line HAS to be:

-bLocalLog=False

-

-Setting it to True will not give you complete logs (don't ask why it just won't).

-

-Log files are recorded to the UTServer\Logs folder.

-

-

-===============================================================================

-2. UTStats Web Install Information

-===============================================================================

-

-UPGRADING from Version 4.2 and newer

--------------------------------------------------------------------------------

-The current install is compatible with the database of version 4.2 and later.

-However bunny track stats are only available from version 4.2.5.

-

-Just remove all the files/folders (apart from the logs folder, if you wish to

-keep your backup logs), and upload all the files in the html folder to your

-webserver.

-

-Then visit the admin area and click "Check Server Settings" near the bottom of

-the list. This will install databases if they're missing and fix the Bunny

-Track captimes to the new format if needed.

-

-If you use your old config.php make sure the following section is included:

-

-// ================ START OF ADDITINAL CONFIG.PHP OPTIONS =====================

-// Screenshot files start with...

-$import_utdc_screenshot_start = "[UTDC]";

-

-// Screenshot files end with...

-$import_utdc_screenshot_extension = ".enc";

-

-// UTStats can download and manage your ACE logs

-// Enable downloading of ACE logs?

-$import_ace_download_enable = false;

-

-// Log files start with...

-$import_ace_log_start = "[ACE]";

-

-// Log files end with...

-$import_ace_log_extension = ".log";

-

-// Log files start with...

-$import_ace_screenshot_start = "[ACE]";

-

-// Log files end with...

-$import_ace_screenshot_extension = ".jpg";

-

-// Compress ACE logfiles after download? [compress/gzip/no]

-// (see $import_log_backup for available options)

-$import_ace_log_compress = "compress";

-

-// Purge old ACE logs after x days. 0 to disable.

-$import_ace_log_purge_after = 0;

-// ================= END OF ADDITINAL CONFIG.PHP OPTIONS ======================

-

-UPGRADING from older versions:

--------------------------------------------------------------------------------

-Firstly we don't advise using any old logs, you will not benefit from any new 

-features AND it will likely mess up some page data.

-We apologise for not being able to save this information but there are a 

-massive amount of new features that are well worth ditching the old logs for :)

-

-If you do wish to keep the old logs you need to do a full install anyway, so 

-drop all the tables you had and remove all the 

-files/folders (making sure you don't delete the logs backups).

-When you edit config.php make sure to change the option:

-$import_incompatible_logs=false;

-to 

-$import_incompatible_logs=true;

-

-If you are wisely going to ditch the old logs just clear out your old install 

-and all the tables and start from here.

-

-FULL INSTALL:

--------------------------------------------------------------------------------

-From the html folder in the zip file, upload all the files to your webserver 

-wherever you like.  I suggest under a folder called utstats.

-After the files have uploaded browse to the stats folder where you should see 

-the following folders:

-

-\images

-\import

-\includes

-\logs

-\pages

-

-Now edit the config.php file.

-

-Enter in your mysql database, hostname, username and password at the top.

-You must set an adminkey in here or you won't be able to import/use the admin 

-feature.

-Check all the other options to see if they are as you wish (they are set to 

-what we consider the best options).

-If you are going to use ftp transferring of log files amend the FTP connection 

-as required.

-

-Now visit the admin area and click "Check Server Settings" near the bottom.

-This will setup the database, if the tables allready exist it will keep the

-old tables. It will also check the file permissions. If it can't set

-the file permissions you'll have to do it yourself,

-

-Using whatever means (usually the ftp client) you need to CHMOD the logs folder 

-to 777.

-Now go into the logs folder.

-Now CHMOD the backups, utdc, ac and ace folders to 777.

-

-Now go back a level and into the includes folder.

-CHMOD the file ftptimestamp.php to 777.

-

-=================

-3. Importing Logs

-=================

-

-Depending on the level of access you have and how competent you are you can do this 4 ways.

-*** Important *** 

-Make sure you edit config.php and set an adminkey at the top!

-

-Way 1:

-If you don't have ftp access to your UT server or allowed to use ftp via php then upload your 

-logs manually to the logs folder and then run the importer via the Import link.

-

-Way 2:

-If you have ftp access and can do ftp via php, edit the config.php file and input your UT servers ftp

-information into there.

-Now run the importer via the Import link.

-

-Way 3:

-Automate the process using a cron job or scheduled task.

-Just get this to run cd to the root of stats (where import.php is) and execute the import.php file

-with php.

-

-Way 4:

-Automate the web process using a web service cron job.

-

-====================

-4. Known Bugs/Issues

-====================

-

-If you find any bugs or issues please post them at our forums:

-http://www.unrealadmin.org/forums/forumdisplay.php?f=173

-

-====================

-5. License

-====================

-

-This product includes GeoLite data created by MaxMind, available from http://www.maxmind.com/.
\ No newline at end of file
+# UTStats
+UTStats is a Serverside Actor and websystem for the original Unreal Tournament
+that generates statistics from custom NGStats log files.
+It was originally created by azazel, AnthraX and toa, with additions by Skillz, killereye, Enakin, Loki and rork.
+This is a modified version that addresses some bugs and deprecation warnings.
+
+#### Requirements:
+- Access to the Unreal Tournament log files
+- PHP & MySQL enabled webserver
+- PHP needs to allow ftpconnect etc. if you wish to use auto-ftp of logs
+
+#### Installation:
+This readme will guide you through the installation process.
+
+1. Installing the Server Actor
+2. Installing the Web stuff (full install and update)
+3. Importing Logs
+
+## 1. UTStats Actor Installation
+
+From the System folder in the zip file, copy to your UTServer\System folder the
+following files:
+
+UTSAccuBeta4_2.u
+UTStatsBeta4_2.u
+
+Remove any previous entries for UTStats and UTSAccuBeta from `[Engine.GameEngine]`.
+
+Add to `[Engine.GameEngine]` the following lines:
+
+```ini
+ServerPackages=UTSAccuBeta4_2
+ServerActors=UTStatsBeta4_2.UTStatsSA
+```
+
+Under the [Engine.GameInfo] check for:
+`bLocalLog=True` or `bLocalLog=False`
+
+This line HAS to be:
+```ini
+bLocalLog=False
+```
+
+Setting it to True will not give you complete logs (don't ask why it just won't).
+
+Log files are recorded to the UTServer\Logs folder.
+
+## 2. UTStats Web Installation
+
+From the html directory in the zip file, upload all the files to your webserver
+wherever you like. I suggest under a directory called utstats.
+
+Now edit the **config.php** file.
+Enter in your **mysql database**, **hostname**, **username** and **password** at the top.
+You must set an **adminkey** in here or you won't be able to import/use the admin
+feature.
+Check all the other options to see if they are as you wish (they are set to
+what we consider the best options).
+If you are going to use ftp transferring of log files amend the FTP connection
+as required.
+
+Now visit the **admin page** and click **"Check Server Settings"** near the bottom.
+This will setup the database, if the tables already exist it will keep the
+old tables. It will also check the file permissions. If it can't set the file
+permissions you'll have to do it yourself,
+
+Using whatever means (usually the ftp client) you need to CHMOD the **logs** folder to 777.  
+Now go into the logs folder and CHMOD the **backup**, **utdc**, **ac** and **ace** folders to 777.  
+Now go back a level and into the includes folder and CHMOD the file **ftptimestamp.php** to 777.
+
+```shell
+chmod 777 logs
+chmod 777 logs/backup
+chmod 777 logs/utdc
+chmod 777 logs/ac
+chmod 777 logs/ace
+chmod 777 includes/ftptimestamp.php
+```
+
+### Update from version 4.2 and newer
+
+The current install is compatible with the database of version 4.2 and later.
+However bunny track stats are only available from version 4.2.5.
+
+Just remove all the files/folders (apart from the logs folder, if you wish to
+keep your backup logs), and upload all the files in the html folder to your
+webserver.
+
+Then visit the admin area and click "Check Server Settings" near the bottom of
+the list. This will install databases if they're missing and fix the Bunny
+Track captimes to the new format if needed.
+
+If you use your old config.php make sure the following section is included:
+
+```php
+// Screenshot files start with...
+$import_utdc_screenshot_start = "[UTDC]";
+
+// Screenshot files end with...
+$import_utdc_screenshot_extension = ".enc";
+
+// UTStats can download and manage your ACE logs
+// Enable downloading of ACE logs?
+$import_ace_download_enable = false;
+
+// Log files start with...
+$import_ace_log_start = "[ACE]";
+
+// Log files end with...
+$import_ace_log_extension = ".log";
+
+// Log files start with...
+$import_ace_screenshot_start = "[ACE]";
+
+// Log files end with...
+$import_ace_screenshot_extension = ".jpg";
+
+// Compress ACE logfiles after download? [compress/gzip/no]
+// (see $import_log_backup for available options)
+$import_ace_log_compress = "compress";
+
+// Purge old ACE logs after x days. 0 to disable.
+$import_ace_log_purge_after = 0;
+```
+
+### Update from versions older than 4.2:
+
+Firstly we don't advise using any old logs, you will not benefit from any new
+features AND it will likely mess up some page data.
+We apologize for not being able to save this information but there are a
+massive amount of new features that are well worth ditching the old logs for :)
+
+If you do wish to keep the old logs you need to do a full install anyway, so
+drop all the tables you had and remove all the
+files/folders (making sure you don't delete the logs backups).
+When you edit config.php make sure to change the option:
+
+```php
+$import_incompatible_logs=false;
+```
+to
+```php
+$import_incompatible_logs=true;
+```
+
+If you are wisely going to ditch the old logs just clear out your old install
+and all the tables and start from here.
+
+## 3. Importing Logs
+
+First make sure you edit config.php and set an **adminkey** at the top!
+Depending on the level of access you have and how competent you are you can do this 4 ways.
+
+**Option 1:**
+If you don't have ftp access to your UT server or allowed to use ftp via php then upload your
+logs manually to the logs folder and then run the importer via the Import link.
+
+**Option 2:**
+If you have ftp access and can do ftp via php, edit the config.php file and input your UT servers ftp
+information into there. Now run the importer via the Import link.
+Additionally you can use [UTStats Trigger](http://ut.fuzzeh.com/serverfiles/UTSTATS_Trigger.zip)
+Server Mutator, which triggers UTStats import after every map switch.
+
+**Option 3:**
+Automate the process using a cron job or scheduled task.
+Just get this to run cd to the root of stats (where import.php is) and execute the import.php file with php.
+
+**Option 4:**
+Automate the web process using a web service cron job.
+
+## License
+
+Copyright (C) 2004/2005 azazel, AnthraX and toa.
+
+This program is free software; you can redistribute and/or modify
+it under the terms of the Open Unreal Mod License.
+See LICENSE for more information.
diff --git a/info.txt b/info.txt
deleted file mode 100755
index ef1f220..0000000
--- a/info.txt
+++ /dev/null
@@ -1,52 +0,0 @@
-UTStats

-Copyright (C) 2004/2005 azazel, )°DoE°(-AnthraX and toa

-

-This program is free software; you can redistribute and/or modify

-it under the terms of the Open Unreal Mod License.

-See license.txt for more information.

-

-===================

-UTStats Information

-===================

-

-What Is It

-----------

-UTStats is a Serverside Actor and websystem for the original Unreal Tournament 

-that generates statistics from a custom NGStats log file.

-

-

-What Does It Record

--------------------

-Lots of stuff

-

-

-What Will I Need

-----------------

-Access to the logs

-PHP & MySQL enabled website

-PHP needs to allow ftpconnect etc if you wish to use auto-ftp of logs

-

-

-What Game Types Does it Support

--------------------------------

-All the official game types.

-

-

-Do You Have A Preview Site?

--------------------------------

-Yes. http://utstats.unrealadmin.org/

-

-

-Why Beta?/Any New Stuff to Come

--------------------------------

-Possible new stuff, but until we're happy its 100% stable it stays as beta :)

-

-

-I Want to Help What Can I Do?

------------------------------

-When the Beta is released please check the pages.

-They might be able to be done more efficiently or other things could be added.

-If you work something out, let us know, share, don't be one of the selfish people 

-in life who keeps it to themselves.

-Remember, the maps you likely play, the mods you use, someone shared them. 

-If you can, now is your opportunity to share back.
\ No newline at end of file