##############################################
## Introduction
##############################################

NOTE:  Once the script is uploaded, it will affect
       any hacks with the ability to use it.

Hello, and thank you for looking at the new feature from mods/hacks by
Nivisec.  All of the newest hacks will be coded with a version checking
feature, which will be transparent if not enabled.

It is very hectic to keep up with releases of all those hacks, so this
will help you keep track of ones by Nivisec a lot easier.  You can use
it as you would every day, except now it tells you if a newer version
is available upon every use.

Once installed you'll see a message on the admin panel page if a newer
version is available.

IMPORTANT:  This optional hack portion is not released under the GPL
            for security reasons.  It uses no phpBB data or code, as
            it only supplies data that phpBB and Nivisec.com hacks can
            use if they are enabled to do so.  This enables it to not
            fall under the GPL.
            
            This means that you may not modify and redistribute it in
            any form.  Doing so will violate my copyright of it.
            
            This does not mean you can't look at the source code and
            use sniplets of it if you would like.  This, of course,
            excludes anything pertaining to my website in particular.
            
            This must be done because the feature is customized to my
            website and hacks.  It must be kept in a controlled manner
            by myself because of this.
            
            The above only applies to the nivisec_version_check.php file
            and not the lang_nivisec_version_check.php file.  Translations
            of the language file are a needed thing and may be distributed
            freely.  Please send them to me also :)

##############################################
## How It Works
##############################################

Every time the hack is used, it will request a php file from Nivisec.com,
which is very small and fast.  The php file will be compiled server-side
and will send about 25 bytes of data back to you.  This data includes
all that is needed to tell you if your version is up to date.

If the small file can't be read from Nivisec.com for some reason, you'll
just recieve a message stating not being able to access the data.

Version Checker will also version check itself each time it is used in
case it had to be updated.  This is done all in one read from Nivisec.com
and the data is quickly parsed out afterwards to seperate it.

##############################################
## Installation
##############################################

Installation of the new Version Checker is much easier and requires
the uploading of two files as shown below.  Once both files are uploaded
the supported hacks will start taking advantage of it.

#-----[ UPLOAD ]------------------------------------------ 
#   If you are having trouble understanding this section, read
#   the goodies/understanding_upload.txt file.
#
nivisec_version_check.php to /
lang_nivisec_version_check.php to language/lang_english/

##############################################
## Disabling For A Certain Hack
##############################################

If for some reason you want to use the version checker, but not in
a particular hack, you can disable it on a case-by-case basis.  For
every supported hack, there will be a line simliar to this at the
top of the admin panel .php file.
-------------------------------------------------------------------------------------
/* If for some reason you need to disable the version check in THIS HACK ONLY,
change the blow to TRUE instead of FALSE.  No other hacks will be affected
by this change.
*/
define('DISABLE_VERSION_CHECK', FALSE);
-------------------------------------------------------------------------------------
To disable it for this hack simply change it to

define('DISABLE_VERSION_CHECK', TRUE);
