documentation.txt

#Drunk Bird Documentation
***
*Name:* Drunk Bird

*Authors:*   

1. Vyara Hristova

2. Teodor Cholakov

3. Chavdar Angelov

4. Marin Marinov

5. Mihail Mitov

6. Vasil Pavlov

7. Ivan Nikolov

8. Georgi Georgiev

*Created:* 31/07/2015

*Version:* 1.0.0
***
Thank you for your interest in our project! 

<a href="http://github.com/Spurch/TeamSazerac" alt="Project-Adress">Github for Team Sazerac</a>
***
##Table of Contents
1. Game Description
2. HTML Structure
3. CSS Files
4. Javascript Files
5. Browser Compatibility
***
##1. Game Description
A Flappy-bird like game, where your goal is to drink as much as possible cocktails in order to win the game. While performing this heroic task the player must avoid many obstacles and defy the increasing gravity pull by hitting the space button.
Soft drinks shrink the size of the bird, while cocktails enlarge it. Upon shrinking to a minimum size, the game ends. Obstacles move both on the upper and the lower end of the game screen. If the bird collides with an obstacle, it dies and the game ends.
***
##2. HTML Structure
The HTML Structure for each page is as follows:
 
* Meta
* Title
* Link to CSS Files
* Header
* Content
    * SVG - Container
    * Result
    * Timer - Container
    * Stage container
* Link to Javascript Files
* Footer
***
##3. CSS Files
There is one CSS file in this theme:
 
* style.css
 
#####style.css
This CSS file is the main stylesheet for the theme. It holds all the values for the different elements of theme and the default color scheme.
***
##4. Javascript Files
There are 8 Javascript files in this theme:
 
* kinetic-v5.1.0.js
* background.js
* homeScreen.js
* optionsScreen.js
* drunkbird.js
* engine.js
* gameObjects.js
* timer.js
 
#####kinetic-v5.1.0.js
The game uses kinetic.js as a game rendering engine.
#####background.js
Provides information about the background layer - definition as a Kinetic.Layer, sizing and functionalities.
#####homeScreen.js
Provides information about the home screen layer - definition as a Kinetic.Layer, buttons for game navigation, and sizing.
#####optionsScreen.js
Provides information about the background layer - definition as a Kinetic.Layer and sizing.**Functionalities are not available at this moment.**
#####drunkbird.js
Holds information about the Player's object including attributes and class definition of the player instance.
#####engine.js
Provides the main functionalities for the project including:
<code>constants: Object</code>  
*Object: Contains the necessary constants.*  
 
<code>stage: Kinetic.Stage</code>  
*Provides the stage for the rendering engine.*
 
 
<code>layers: Kinetic.Layer</code>  
*BirdLayer, DrinkLayer, ObstaclesLayer are the layers containing the different game objects.*  
 
<code>timer: Timer</code>  
*Provides the functionality of the result calculation.* 

<code>areColliding: Function</code>  
*Defines the collision functionalities.*  

<code>randomNumberInInterval: Function</code>  
*Provides random numbers in order to create different instances in the game independently and in random positions.*

<code>setSoftDrinkImage: Function</code>
*fills the Kintic object with a random image from pre-set array*

<code>generateDrinkObject: Function</code>
*creates a Kinetic object which is the graphic representation of an instance of gameObjects*

#####gameObjects.js
Contains definition of drawable objects and its children - cocktail drinks, soft drinks, obstacles.
#####timer.js
Provides the functionality for the timer, which is the result generator.
***
##5. Browser Compatibility
  
**IE 9+**

**Chrome**  

**Firefox** 
 
**Safari** 

**Opera**

####Project by Team Sazerac
Thank you for your interest in our project! 
<a href="http://github.com/Spurch/TeamSazerac" alt="Project-Adress">Github for Team Sazerac</a>