documentation.lyx

   1 #LyX 1.5.5 created this file. For more info see http://www.lyx.org/
   2 \lyxformat 276
   3 \begin_document
   4 \begin_header
   5 \textclass article
   6 \language english
   7 \inputencoding auto
   8 \font_roman default
   9 \font_sans default
  10 \font_typewriter default
  11 \font_default_family default
  12 \font_sc false
  13 \font_osf false
  14 \font_sf_scale 100
  15 \font_tt_scale 100
  16 \graphics default
  17 \paperfontsize default
  18 \spacing single
  19 \papersize default
  20 \use_geometry true
  21 \use_amsmath 1
  22 \use_esint 1
  23 \cite_engine basic
  24 \use_bibtopic false
  25 \paperorientation portrait
  26 \secnumdepth 3
  27 \tocdepth 3
  28 \paragraph_separation indent
  29 \defskip medskip
  30 \quotes_language english
  31 \papercolumns 1
  32 \papersides 1
  33 \paperpagestyle default
  34 \tracking_changes false
  35 \output_changes false
  36 \author ""
  37 \author ""
  38 \end_header
  39
  40 \begin_body
  41
  42 \begin_layout Title
  43 Pool Simulation Game
  44 \end_layout
  45
  46 \begin_layout Author
  47 Jacek Caban
  48 \begin_inset ERT
  49 status open
  50
  51 \begin_layout Standard
  52
  53
  54 \backslash
  55
  56 \backslash
  57
  58 \end_layout
  59
  60 \end_inset
  61
  62 Piotr Caban
  63 \begin_inset ERT
  64 status open
  65
  66 \begin_layout Standard
  67
  68
  69 \backslash
  70
  71 \backslash
  72
  73 \end_layout
  74
  75 \end_inset
  76
  77 Jarek Sobiecki
  78 \end_layout
  79
  80 \begin_layout Enumerate
  81 Compilation
  82 \end_layout
  83
  84 \begin_deeper
  85 \begin_layout Standard
  86 The source code is provided with make-files used for compilation.
  87  Following libraries and packets are needed (in brackets version used by
  88  us):
  89 \end_layout
  90
  91 \begin_layout Itemize
  92 OGRE (1.4.8)
  93 \end_layout
  94
  95 \begin_layout Itemize
  96 CEGUI (0.6.0)
  97 \end_layout
  98
  99 \begin_layout Itemize
 100 OIS (1.2.0)
 101 \end_layout
 102
 103 \begin_layout Standard
 104 Additionally gcc, make and pkg-config is needed.
 105 \end_layout
 106
 107 \end_deeper
 108 \begin_layout Enumerate
 109 How to run the game
 110 \end_layout
 111
 112 \begin_deeper
 113 \begin_layout Standard
 114 The game can be run from bin directory by executing following command:
 115 \end_layout
 116
 117 \begin_layout Quote
 118 ./psg
 119 \end_layout
 120
 121 \begin_layout Standard
 122 Before running the game please check if path entered in plugin.cfg is correct.
 123  It should point to the directory containing RenderSystem_GL.so file.
 124  Ordinary the file should be provided with the game.
 125  In such a case we will have to prepare different versions for different
 126  architectures.
 127  The game should be shipped with OGRE, CEGUI and OIS library.
 128 \end_layout
 129
 130 \end_deeper
 131 \begin_layout Enumerate
 132 How to play
 133 \end_layout
 134
 135 \begin_deeper
 136 \begin_layout Standard
 137 This is a pool simulation game.
 138  We will describe how to use the program, the rules can be found on the
 139  Internet.
 140 \end_layout
 141
 142 \begin_layout Standard
 143 Game controls:
 144 \end_layout
 145
 146 \begin_layout Itemize
 147 mouse is used to navigate through menus
 148 \end_layout
 149
 150 \begin_layout Itemize
 151 1, 2, 3 keys are used to set the camera
 152 \end_layout
 153
 154 \begin_layout Itemize
 155 arrows or mouse with left button rotates camera
 156 \end_layout
 157
 158 \begin_layout Itemize
 159 w, a, s, d keys are used to set rotation when hitting white ball
 160 \end_layout
 161
 162 \begin_layout Itemize
 163 f, g, h, t keys are used to place white ball after a faul
 164 \end_layout
 165
 166 \begin_layout Itemize
 167 l key is used to toggle lights
 168 \end_layout
 169
 170 \begin_layout Itemize
 171 k key is used to toggle shadows
 172 \end_layout
 173
 174 \begin_layout Itemize
 175 space is used to make a shot
 176 \end_layout
 177
 178 \begin_layout Itemize
 179 c key switches between cameras
 180 \end_layout
 181
 182 \begin_layout Itemize
 183 -, = keys are used to set camera distance
 184 \end_layout
 185
 186 \begin_layout Standard
 187 It is possible to make a shot only if first camera is selected and all balls
 188  are stopped.
 189  After selecting force and pressing space the white ball will be hit.
 190  It will go to the direction camera is looking at.
 191  Current player and other informations are displayed on the top of the screen.
 192 \end_layout
 193
 194 \end_deeper
 195 \begin_layout Enumerate
 196 Used libraries description
 197 \end_layout
 198
 199 \begin_deeper
 200 \begin_layout Itemize
 201 OGRE - as it is stated on the project page OGRE (Object-Oriented Graphics
 202  Rendering Engine) is a scene-oriented, flexible 3D engine written in C++
 203  designed to make it easier and more intuitive for developers to produce
 204  applications utilising hardware-accelerated 3D graphics.
 205  The class library abstracts all the details of using the underlying system
 206  libraries like Direct3D and OpenGL and provides an interface based on world
 207  objects and other intuitive classes.
 208 \end_layout
 209
 210 \begin_layout Itemize
 211 Crazy Eddie's GUI System is a free library providing windowing and widgets
 212  for graphics APIs / engines where such functionality is not natively available,
 213  or severely lacking.
 214  The library is object orientated, written in C++, and targeted at games
 215  developers who should be spending their time creating great games, not
 216  building GUI sub-systems!
 217 \end_layout
 218
 219 \begin_layout Itemize
 220 OIS - Object-Oriented Input System, this library is used for getting mouse
 221  and keyboard events from user.
 222 \end_layout
 223
 224 \begin_layout Standard
 225 All libraries used by the game are free, open-source.
 226  The libraries are available for Linux and Microsoft Windows systems (maybe
 227  other systems as well).
 228 \end_layout
 229
 230 \end_body
 231 \end_document