Bandit Files

README.TXT bandit.v2.1.3.beta.tar.gz Released April 14th, 2011

TOC
1) Description
2) Credits
3) Change Log
4) Todo List
5) Requirements
6) Install
7) Misc Notes

1) Description
          Bandit is multiplayer, real-time, role playing, mobster game based 
     PHP/MySQL, similar in game play to Mafia Wars by Zynga.

          Gamers play as gangsters building their own gang. The players fight
     other players online and complete tasks to gain rewards and strength in
     the game. Game revolves around fighting other players and doing jobs to
     earn cash, items and experience, with the goal of establishing and
     advancing one's criminal empire. Players create gangs by paying a nominal
     (in game) fee then, recruiting other players. Players can also improve 
     their stats by visiting the marketplace to buy weapons, armor, vehicles,
     property, etc. Additional perks can be gained by donating real-world money,
     in varying sponsorship levels, to the game site, via links (in shopping
     cart fashion) to PayPal.
     
          Tested on Ubuntu 8.10 Intrepid Ibex (http://www.ubuntu.com/) & 
     Microsoft Window 7 with WampServer 2.1d (http://www.wampserver.com/en/).
     Currently not portable to WAMP (not scheduled untill version 2.1.5.beta).

2) Credits
     Written & Maintained by Pavel Florin until version 2.1.1
     Maintained by Joseph L Colburn III 

3) Change Log
     Version 2.1.3 Released April 14th, 2011
          1. Fixed captcha_verify.php (using Googles' reCaptcha)
     Version 2.1.2 Released April 13th, 2011
          1. Cronjob fix (not connecting to mysql server)
     Version 2.1.1 Released April 10th, 2011
          1. joeg33k (Joseph L Colburn III) added to development team
          2. Minor bug (typographical errors) fix
          3. Addition of readme/install file

4) Todo List - with projected version numbers (Fixes before Improvements)
     -=Fixes=-  (in order of priority)
     A. Change donation process			     (version 2.1.4.beta)
     B. Remove DB class (unportable to WAMP)      (version 2.1.5.beta)
          (1241 lines of DB class references, lord
           only knows how many variables reley on
           these clases)
     C. Fix & improve installation automation 	(version 2.1.6.beta)
     D. Clean up unnessacary files                (version 2.1.6.beta)
     -=Improvements=-  (in order of priority)
     A. database prefixes 					(version 2.1.7.beta)
     B. Create at least a demo size sql dump 	(version 2.1.8.beta)
     C. Setup Demo Site
     D. Add live chat rooms 				(version 2.1.9.production.stable)
     E. UI improvements 					(version 2.2.beta)
     F. change to or add OpenID login 		(version 2.2.1.beta)
     
5) Requirements
     MySQL
     PHP
     Its assumed you have an operational LAMP (linux, apache, mysql, php) OR 
          WAMP (Windows, apache, mysql, php) box running. 

6) Install
     For brevity, I'll assume your running Ubuntu (as its the most popular
          linux distro right now).  A pound sign (#) will precede a console 
          command. A greater than sign (>) will precede a mysql command.
     A. Unpackage
          1) Extract the tarball into your web server root (fear not, it'll
          create a sub directory).
               # sudo mv bandit.v2.1.1.beta.tar.gz /var/www/
               # cd /var/www/
               # sudo tar -zxvvf bandit.v2.1.3.beta.tar.gz
          2) Chage permissions
               # sudo chmod -R 777 /var/www/bandit
               # cd bandit/
     B. Config File
          Edit config.php with your favorite text editor to refelect the
               host, user, and databases.  
          Create a set of reCaptcha keys at Google 
               (https://www.google.com/recaptcha/admin/create), enter your
               public & private keys in the config.php file.
     C. MySQL
          1) Create database & user for your Bandit install
               # mysql -u root -p 
                    (you'll be prompted for your mysql root password (most 
                    likely it'll be your system's root password)
               > create database bandit;
               > grant all privileges on bandit.* to 'bandit'@'localhost' identified by 'bandit_password' with grant option;
               > grant all privileges on bandit.* to 'bandit'@'127.0.0.1' identified by 'bandit_password' with grant option;
               > quit;
          2) Insert tables & data from database.sql
               # mysql -u root -p bandit < dbdata.sql
          3) Open http://www.yourwebaddy.com/bandit/index.php and create a 
               user (to be used as an administative ("staff") account.
          4) Manually change the user account to a staff account.
               This is assuming the first account you created (if you created
                    more than one) is to be your staff account.
               # mysql -u root -p bandit
               > update users set user_level = 2 where userid = 1;
               > quit;
     D. Cronjobs
          # crontab -e
          Enter the following lines:
               */5 * * * * lynx -dump http://www.yourwebaddy.com/bandit/cron_fivemins.php
               0 * * * *  lynx -dump http://www.yourwebaddy.com/bandit/cron_hour.php
               * * * * *  lynx -dump http://www.yourwebaddy.com/bandit/cron_minute.php
               0 0 * * *  lynx -dump http://www.yourwebaddy.com/bandit/cron_day.php
          Quit the editor.
     E. That's it. Enjoy!

7) Misc Notes (& rants)
     A. Why use Googles' reCaptcha?
          Personaly I'm not into publicly supporting causes.  I think 
          supporting causes should be up to the individual.  However, I use
          allot of Google products and my long term plans for this project
          will use allot of Google APIs.  So, since your using Google, register
          your site for reCaptcha, and give back!  Don't like it?  Well turn
          Captcha off via the Staff Panel -> General -> Basic Settings.
     B). Plan on writing your own application?
          Please, please, please, leave the next guy documentation!