-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathdocumentation.html
More file actions
471 lines (386 loc) · 13 KB
/
documentation.html
File metadata and controls
471 lines (386 loc) · 13 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
<!DOCTYPE html>
<html>
<head>
<title>documentation</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<style type="text/css">
/* GitHub stylesheet for MarkdownPad (http://markdownpad.com) */
/* Author: Nicolas Hery - http://nicolashery.com */
/* Version: b13fe65ca28d2e568c6ed5d7f06581183df8f2ff */
/* Source: https://github.com/nicolahery/markdownpad-github */
/* RESET
=============================================================================*/
html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, ruby, section, summary, time, mark, audio, video {
margin: 0;
padding: 0;
border: 0;
}
/* BODY
=============================================================================*/
body {
font-family: Helvetica, arial, freesans, clean, sans-serif;
font-size: 14px;
line-height: 1.6;
color: #333;
background-color: #fff;
padding: 20px;
max-width: 960px;
margin: 0 auto;
}
body > *:first-child {
margin-top: 0 !important;
}
body > *:last-child {
margin-bottom: 0 !important;
}
/* BLOCKS
=============================================================================*/
p, blockquote, ul, ol, dl, table, pre {
margin: 15px 0;
}
/* HEADERS
=============================================================================*/
h1, h2, h3, h4, h5, h6 {
margin: 20px 0 10px;
padding: 0;
font-weight: bold;
-webkit-font-smoothing: antialiased;
}
h1 tt, h1 code, h2 tt, h2 code, h3 tt, h3 code, h4 tt, h4 code, h5 tt, h5 code, h6 tt, h6 code {
font-size: inherit;
}
h1 {
font-size: 28px;
color: #000;
}
h2 {
font-size: 24px;
border-bottom: 1px solid #ccc;
color: #000;
}
h3 {
font-size: 18px;
}
h4 {
font-size: 16px;
}
h5 {
font-size: 14px;
}
h6 {
color: #777;
font-size: 14px;
}
body > h2:first-child, body > h1:first-child, body > h1:first-child + h2, body > h3:first-child, body > h4:first-child, body > h5:first-child, body > h6:first-child {
margin-top: 0;
padding-top: 0;
}
a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4, a:first-child h5, a:first-child h6 {
margin-top: 0;
padding-top: 0;
}
h1 + p, h2 + p, h3 + p, h4 + p, h5 + p, h6 + p {
margin-top: 10px;
}
/* LINKS
=============================================================================*/
a {
color: #4183C4;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
/* LISTS
=============================================================================*/
ul, ol {
padding-left: 30px;
}
ul li > :first-child,
ol li > :first-child,
ul li ul:first-of-type,
ol li ol:first-of-type,
ul li ol:first-of-type,
ol li ul:first-of-type {
margin-top: 0px;
}
ul ul, ul ol, ol ol, ol ul {
margin-bottom: 0;
}
dl {
padding: 0;
}
dl dt {
font-size: 14px;
font-weight: bold;
font-style: italic;
padding: 0;
margin: 15px 0 5px;
}
dl dt:first-child {
padding: 0;
}
dl dt > :first-child {
margin-top: 0px;
}
dl dt > :last-child {
margin-bottom: 0px;
}
dl dd {
margin: 0 0 15px;
padding: 0 15px;
}
dl dd > :first-child {
margin-top: 0px;
}
dl dd > :last-child {
margin-bottom: 0px;
}
/* CODE
=============================================================================*/
pre, code, tt {
font-size: 12px;
font-family: Consolas, "Liberation Mono", Courier, monospace;
}
code, tt {
margin: 0 0px;
padding: 0px 0px;
white-space: nowrap;
border: 1px solid #eaeaea;
background-color: #f8f8f8;
border-radius: 3px;
}
pre > code {
margin: 0;
padding: 0;
white-space: pre;
border: none;
background: transparent;
}
pre {
background-color: #f8f8f8;
border: 1px solid #ccc;
font-size: 13px;
line-height: 19px;
overflow: auto;
padding: 6px 10px;
border-radius: 3px;
}
pre code, pre tt {
background-color: transparent;
border: none;
}
kbd {
-moz-border-bottom-colors: none;
-moz-border-left-colors: none;
-moz-border-right-colors: none;
-moz-border-top-colors: none;
background-color: #DDDDDD;
background-image: linear-gradient(#F1F1F1, #DDDDDD);
background-repeat: repeat-x;
border-color: #DDDDDD #CCCCCC #CCCCCC #DDDDDD;
border-image: none;
border-radius: 2px 2px 2px 2px;
border-style: solid;
border-width: 1px;
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
line-height: 10px;
padding: 1px 4px;
}
/* QUOTES
=============================================================================*/
blockquote {
border-left: 4px solid #DDD;
padding: 0 15px;
color: #777;
}
blockquote > :first-child {
margin-top: 0px;
}
blockquote > :last-child {
margin-bottom: 0px;
}
/* HORIZONTAL RULES
=============================================================================*/
hr {
clear: both;
margin: 15px 0;
height: 0px;
overflow: hidden;
border: none;
background: transparent;
border-bottom: 4px solid #ddd;
padding: 0;
}
/* TABLES
=============================================================================*/
table th {
font-weight: bold;
}
table th, table td {
border: 1px solid #ccc;
padding: 6px 13px;
}
table tr {
border-top: 1px solid #ccc;
background-color: #fff;
}
table tr:nth-child(2n) {
background-color: #f8f8f8;
}
/* IMAGES
=============================================================================*/
img {
max-width: 100%
}
</style>
</head>
<body>
<h1>Drunk Bird Documentation</h1>
<hr/>
<p><em>Name:</em> Drunk Bird</p>
<p><em>Authors:</em>
</p>
<ol>
<li>
<p>Vyara Hristova</p>
</li>
<li>
<p>Teodor Cholakov</p>
</li>
<li>
<p>Chavdar Angelov</p>
</li>
<li>
<p>Marin Marinov</p>
</li>
<li>
<p>Mihail Mitov</p>
</li>
<li>
<p>Vasil Pavlov</p>
</li>
<li>
<p>Ivan Nikolov</p>
</li>
<li>
<p>Georgi Georgiev</p>
</li>
</ol>
<p><em>Created:</em> 31/07/2015</p>
<p><em>Version:</em> 1.0.0</p>
<hr/>
<p>Thank you for your interest in our project! </p>
<p><a href="http://github.com/Spurch/TeamSazerac" alt="Project-Adress">Github for Team Sazerac</a></p>
<hr/>
<h2>Table of Contents</h2>
<ol>
<li>Game Description</li>
<li>HTML Structure</li>
<li>CSS Files</li>
<li>Javascript Files</li>
<li>Browser Compatibility</li>
</ol>
<hr/>
<h2>1. Game Description</h2>
<p>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.
</p>
<hr/>
<h2>2. HTML Structure</h2>
<p>The HTML Structure for each page is as follows:</p>
<ul>
<li>Meta</li>
<li>Title</li>
<li>Link to CSS Files</li>
<li>Header</li>
<li>
Content
<ul>
<li>SVG - Container</li>
<li>Result</li>
<li>Timer - Container</li>
<li>Stage container</li>
</ul>
</li>
<li>Link to Javascript Files</li>
<li>Footer</li>
</ul>
<hr/>
<h2>3. CSS Files</h2>
<p>There is one CSS file in this theme:</p>
<ul>
<li>style.css</li>
</ul>
<h5>style.css</h5>
<p>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.</p>
<hr/>
<h2>4. Javascript Files</h2>
<p>There are 8 Javascript files in this theme:</p>
<ul>
<li>kinetic-v5.1.0.js</li>
<li>background.js</li>
<li>homeScreen.js</li>
<li>optionsScreen.js</li>
<li>drunkbird.js</li>
<li>engine.js</li>
<li>gameObjects.js</li>
<li>timer.js</li>
</ul>
<h5>kinetic-v5.1.0.js</h5>
<p>The game uses kinetic.js as a game rendering engine.</p>
<h5>background.js</h5>
<p>Provides information about the background layer - definition as a Kinetic.Layer, sizing and functionalities.</p>
<h5>homeScreen.js</h5>
<p>Provides information about the home screen layer - definition as a Kinetic.Layer, buttons for game navigation, and
sizing.</p>
<h5>optionsScreen.js</h5>
<p>Provides information about the background layer - definition as a Kinetic.Layer and sizing.<strong>Functionalities
are not available at this moment.</strong></p>
<h5>drunkbird.js</h5>
<p>Holds information about the Player's object including attributes and class definition of the player instance.</p>
<h5>engine.js</h5>
<p>Provides the main functionalities for the project including:
<code>constants: Object</code><br/>
<em>Object: Contains the necessary constants.</em>
</p>
<p><code>stage: Kinetic.Stage</code><br/>
<em>Provides the stage for the rendering engine.</em></p>
<p><code>layers: Kinetic.Layer</code><br/>
<em>BirdLayer, DrinkLayer, ObstaclesLayer are the layers containing the different game objects.</em>
</p>
<p><code>timer: Timer</code><br/>
<em>Provides the functionality of the result calculation.</em></p>
<p><code>areColliding: Function</code><br/>
<em>Defines the collision functionalities.</em>
</p>
<p><code>randomNumberInInterval: Function</code><br/>
<em>Provides random numbers in order to create different instances in the game independently and in random
positions.</em></p>
<p><code>setSoftDrinkImage: Function</code>
<em>fills the Kintic object with a random image from pre-set array</em></p>
<p><code>generateDrinkObject: Function</code>
<em>creates a Kinetic object which is the graphic representation of an instance of gameObjects</em></p>
<h5>gameObjects.js</h5>
<p>Contains definition of drawable objects and its children - cocktail drinks, soft drinks, obstacles.</p>
<h5>timer.js</h5>
<p>Provides the functionality for the timer, which is the result generator.</p>
<hr/>
<h2>5. Browser Compatibility</h2>
<p><strong>IE 9+</strong></p>
<p><strong>Chrome</strong>
</p>
<p><strong>Firefox</strong></p>
<p><strong>Safari</strong></p>
<p><strong>Opera</strong></p>
<h4>Project by Team Sazerac</h4>
<p>Thank you for your interest in our project!
<a href="http://github.com/Spurch/TeamSazerac" alt="Project-Adress">Github for Team Sazerac</a></p>
</body>
</html>
<!-- This document was created with MarkdownPad, the Markdown editor for Windows (http://markdownpad.com) -->