This is the readme for Reflexive's GameCenterSolution Website Development Kit (WDK). The intent of the Website Development Kit is to provide current GameCenterSolution Affiliates with tools to build game pages from HTML templates and/or to integrate game data into their existing site. The WDK allows you to stream in the latest GameCenterSolution game releases & content available. *********** QUICK START *********** 1. Copy *ALL* files and directories included in the WDK into a subdirectory of your website's root directory. 2. Run "http://YourDomainName/SubDirectoryName/Manager/install.php" from your web browser. 3. Log into the WDK Manager you just intalled by going to "http://YourDomainName/SubDirectoryName/Manager/index.php", and then review all settings found on the pages under the "Accounts" -> "Settings" tab. 4. Preview and install an example website that you would like to start with for your site. That's all you have to do to get a default website up and running. Enjoy! ============================================================================================================================== The following sections provide information about the directories and files included in the WDK. *********** WDK MANAGER *********** The "Manager" directory contains the system that controls the entire development kit. Before using the WDK, you must first run the /Manager/install.php script from a web browser. The script will create the database tables and settings necessary to use the WDK for your affiliate account. *********** PHP LIBRARY *********** The "RADK" directory contains the PHP code library to process GameCenterSolution's syndication feeds from the GameCenterSolution servers, to process HTML site templates, and to manage the database structure needed to run the site. The library provides 2 major interfaces. The main one, the HTML Processor (RA_HTMLProcessor), is for the designer who is most comfortable with HTML and visual design tools such as Dreamweaver or FrontPage, and it operates on HTML templates. The Site Builder (RA_SiteBuilder) can be used by programmers who wish to write custom PHP pages instead of using HTML templates. We recommend that you do not modify the library, as it will make it difficult to upgrade to future versions. However, if you wish to write your own tools to import the game data and order feeds into your own database, you can use the library as a reference. The "RADK/jobs" directory contains scripts that can be run by the WDK Manager Jobs module. ************************* EXAMPLE TEMPLATE WEBSITES ************************* The "ExampleTemplateWebsites" directory contains example websites that were built using HTML templates. You should refer to these example websites if you want to use a visual design tool such as Dreamweaver or FrontPage, or if you do not want to do any PHP programming. The "ExampleTemplateWebsites/TemplateImages" directory contains placeholder images that can be referenced by site templates. The template processing will replace references to the placeholders with images from GameCenterSolution. The "ExampleTemplateWebsites/StoreFront" directory provides the templates and site-specific PHP files we use to build the Game Frame and Store Front sites that are hosted by GameCenterSolution. You are free to use and modify the templates and site-specific PHP files as you wish. The "ExampleTemplateWebsites/Simple" directory provides a simple set of sample templates. The template files can be viewed/edited in convential web tools (browsers, Dreamweaver, FrontPage, Notepad). Note that the samples are designed to be simple in order to demonstrate basic use of the WDK; they do not demonstrate more advanced features. *************************** EXAMPLE PROGRAMMER WEBSITES *************************** The "ExampleProgrammerWebsites" directory contains example websites that were built using custom PHP code. You should refer to these example websites if you plan on programming your website in PHP. The "ExampleProgrammerWebsites/Example1" directory provides a basic site using a PHP framework to display pages. The site accesses game data using the API provided by the WDK PHP Library. *********** NEWSLETTERS *********** The "Newsletters" directory contains example newsletters that you can use for your own site with the WDK Manager Newsletter Scheduler. You can send two types of newsletters: one-time static newsletters or recurring dynamic newsletters. The "ExampleNewsletter.html" file demonstrates how to create a static newsletter that you can send one time. No matter how many times you send the newsletter, it will contain the same content. The "ExampleRecurringNewsletter.html" file demonstrates how to create a dynamic newsletter that automatically changes its content every week; you can schedule to automatically send this type of newsletter every week. Please remember to include your physical address and a way for the user to unsubscribe in each newsletter that you send out. Never send unsolicited newsletters. In fact, you should only send out newsletters to users that have confirmed that they want to be subscribed to your newsletter. The system is already set up to do this for you. When a user subscribes to your newsletter, the system will automatically send the "NewsletterSignupConfirmation.html" template to the user. The user must confirm his signup before his email will be added to your newsletter list.