Home

Setting up + running the app

Step 1: Clone the git repo

Instructions for this are here (Skip step 1 (forking). The url for the repo is: https://github.com/sana-malik/famine-gameJS )

Step 2: Download & Install TideSDK

Download and install both "TideSDK 1.3.1 beta" and "TideSDK Developer" from here (click the big orange button: "Download v.1.3.1 beta").

The documentation for setting up TideSDK is here (scroll down to "Alright, Let's Get Going").

On Steps 3-4 in the documentation, replace the "HelloWorld" stuff with wherever you put the famine-gameJS folder.

Step 3: Edit the app

All the app files are inside the "Resources" folder.

• index.html -- main page
• css/ -- all css files go here
  • main.css -- stylesheet for the entire app
• data/ -- all data files go here
• images/ -- all images for the app
  • gui/ -- any gui elements (e.g., close icon, button icons, etc)
  • team_icons/ -- these are just team icons
• model/ -- all the Object definitions for the various classes.
• RunApp.js -- "main" method for the javascript. This is where the start point of the JS code is
• utils/ -- various utilities
• view/ -- all the views for the app. This is where dynamic html is defined.

Everything acts like normal HTML/JS/CSS running with Webkit. It won't work in a normal browser though, since it uses Tide's file structure for reading/writing data, so make sure to run it with the TideSDK.