*********************************
** Introduction                **
*********************************

The Gameroom is a follow up to the Casino product for vBulletin.  It features games that can be played alone, against a computer dealer as well as live multiplayer games.  Cash for the betting games comes can be gained through doing the things that help your board, such as making posts and starting threads. 

Multiplayer games are played live, with chat and in the case of Texas Hold'em can have up to 10-players at one table. 


*********************************
** Installation                **
*********************************

1) Upload the contents of the "framework.zip" folder into your vBulletin folder, there are 2 files in it and they are required to run the gameroom.  

2) Upload the contents of the "upload" folder into your vBulletin folder.

3) Import the "product-gameroom.xml" file through the Product manager in your adminCP

4) Modify the navbar template as follows:

Find
	<td class="vbmenu_control"><a href="calendar.php$session[sessionurl_q]">$vbphrase[calendar]</a></td>

Add Below it 
	
	<td class="vbmenu_control"><a style='color:#FFC0C0' href="gameroom.php?$session[sessionurl]">Gameroom [$playersInGameroom]</a></td>


5) Go to the Gameroom and open the "Admin" tab, the user that installed the product is the only user that has permission to do this at this point.  Edit your settings to suit your board.  Ensure the proper users are listed as admins, mods and the proper usertypes are allowed access.

6) This part adds the cash amount to the postbits, if you are using another currency or don't want this, skip this step.

       In the postbit & postbit_legacy Templates

       FIND


               *************************************************

               $vbphrase[posts]: $post[posts]

               *************************************************



       BELOW that ADD


               *************************************************

               <br /><a href='gameroom.php'>Gameroom cash</a>: $$post[gameroom_cash]

               *************************************************


This part adds a box below your navbar showing how many players are in the multiplayer games, "callouts" from with in the gameroom and how many open events are in the Betting component.  There are two banners available, a flash one and a html one.  To switch between the two go to the plugin manager and enable the one you want to use, and dissable the other. 


       In navbar Template, at the very bottom or bottom add:


               *************************************************

               $gameroomBanner

               *************************************************

The html banner will not display if it has nothing to show.  If you want it to display a default message edit the "Default_Message" phrase in the "banner" language group.

*********************************
** Update from Casino          **
*********************************

In order to transfer you statistics, betting events and cash from the Casino application upload the "updateCasino.php" file from the tools folder too your forum folder and navigate to the file.  Once the process is complete, delete the file from your server.

** NOTE:  If you are going to update you should make sure you do so right away, once the gameroom starts to gather its own information this import will throw errors.  If you have used it, and want to transfer data clear the tables by uninstalling and reinstalling the product file.


*****************************************
** Integrating with other cash systems **
*****************************************

Integrating with other cash systems

This is fairly simple to do, you just need to change the cash type field in the settings.

* VB Plaza - Change to "vbbux"
* iCash - Change to "Money"
* VB Credits - Change to "Credits"

You should also dissable the bonus plugins if they are not needed.  For any other package you need to find out what field in the user table it uses and change the settings to that field.


*********************************
** Language                    **
*********************************

Language and help files can be edited to suite your site.  The game language can all be edited from the admin tab within the game by Gameroom Administrators, the help files that come up when you push the Help button are storred in the "rules" folder.  If you change them, make sure you don't overwrite them when updating.


*********************************
** Common Problems             **
*********************************

Non-english letters are not working properly

	This is a problem with flash player and has been in there bug tracker for a long time.  The workaround is to 
	edit the "gameroom" template, remove the line that ways "wmode='transparent'", the downside it your popup menus
	will come up behind the flash box, rather then in front of it.
	
Images are working in IE, but not in Firefox

	You likely have some form of image hot linking turned on, it is causing the requests for the images to be blocked.

Locked self out of admin panel

	In the tools folder there is a file called 'makemeadmin.php', upload this and go to that page.  It will make you admin,
	don't leave it on your server when you are done.

Updated and it is acting funny

	Make sure all of your files are up to date.  When you update ensure that all files are overwritten.  Having mix matched files
	will cause funny behaviour.  You may also have to clear your cache and reload the page after uploading a new gameroom.swf file.
	

*********************************
** Uninstall                   **
*********************************

If you want to uninstall the following procedure will get you through it without tossing any DB errors:

1) Dissable the product, this shuts down all the plugins. If the files are removed and plugins are still active you may see errors on your site.

2) Undo the template changes, changes where made to the navbar template and the postbit / postbit legacy template.

3) Delete all files.  If the files are still present and you remove the database entries by uninstalling the product anyone that attempts to access one of them will cause a error.  The Flash Banner could cause many as it could still be making calls after the template changes are undone.

	gameroom.php
	gameroom.swf
	gameroomBanner.swf
	gameroom/*
	includes/cron/gameroom_nightly.php

4) Uninstall the product file, which removes all database entries, that means the following are removed:
	
	tables with 'gameroom_' as a prefix
	gameroom_cash field within the user table
		
*********************************
** Support                     **
*********************************

For support issues please use the forums at vbgaming.org



(c)2009 Andrew Green
http://vbgaming.org
