_/_/_/    _/    _/_/
                            _/        _/_/  _/    _/
                             _/_/      _/      _/
                                _/    _/    _/
                         _/_/_/      _/  _/_/_/_/

                                               Readme
 

Introduction
============

S12 is a game based on the model of BridgeBuilder. 
The goal is to construct a bridge over a valley which is robust enough for a
train to be able to cross it without causing it to collapse.
 

Requirements
============

  * OpenGL
  * SDL [1]

  
Running S12
===========

Run S12 from the command line using the following syntax: 

  Usage: S12 [-b <bridgeFile>] [-t <trainFile>] [-f]
  Options:
    -b <bridgeFile> use bridge described in <bridgeFile> instead of default
                    bridge
    -t <trainFile>  use train described in <trainFile> instead of default
                    train
    -f              start in full screen mode

For instance, to run S12 with the bridge data/level3.brg and use the train
data/steamer1.trn in full screen mode type: 

  ./S12 -b data/level3.brg -t data/steamer1.trn -f


Interaction
===========

  * create new bridge edges using drag & drop with the left mouse button
  * delete bridge edges and vertices using the right mouse button
  * press Ctrl+[1..4] to save the current bridge to one of the 4 storage
    locations
  * press [1..4] to retrieve a saved bridge
  * press c to clear the current bridge
  * press s to start/stop the simulation
  * press t to start/stop the train
  * press escape to quit


Building S12
============

S12 can be built under Linux, Windows (under MSYS and the MinGW compiler [2]) or
Mac OS X (using the Fink SDL package [3]) using the respective Makefile. You
might have to adjust it to your personal needs...


Technical features
==================

  * mass spring systems to simulate the bridge and the train
  * particle systems to simulate smoke and "puffs" in the event of a broken
    bridge edge
  * leap frog integration
  * point damping
  * see doc/html/index.html for a complete source code documentation
 

Authors
=======

Markus Liechti (liechtim@student.ethz.ch)
Yoshimi Takano (yoshi@student.ethz.ch)
Stefan Wismer (swismer@student.ethz.ch)



--
[1] http://www.libsdl.org
[2] http://www.mingw.org
[3] http://fink.sourceforge.net/pdb/package.php/sdl