/Teta

An unfinished text adventure. Created to learn more about Ruby, RSpec and Domain-Specific-Languages.

Primary LanguageRuby

Teta is meant to become a Text Adventure at some point in the future
that uses an Internal Domain Specific Language to describe the game
data. Learning Ruby by Doing.

It uses:
  * ruby-sdl-ffi to play musicV
  * rb-readline for the command history
  * rspec for testing
  * ocra to create the stand-alone Windows executeable
  * metric_fu to capture various code quality metrics
  * simplecov to calculate spec coverage


## Installation ##
1. Install native SDL libraries

LINUX:
  apt-get install libsdl1.2-dev

Mac OS X:
  Install Homebrew if you don't already have it (see http://mxcl.github.com/homebrew/)
  brew install sdl_sound
  brew install sdl_mixer

WINDOWS:
  SDL.dll                     32-bit from http://www.libsdl.org/download-1.2.php
  SDL_mixer.dll and smpeg.dll 32-bit from http://www.libsdl.org/projects/SDL_mixer/
  
  libc++-6.dll                       from http://en.sourceforge.jp/projects/sfnet_hamilton/downloads/stdcpp6/2/2.0/dev-bin/libstdc++-6.dll/
  libgcc_s_dw2-1.dll                 from http://en.sourceforge.jp/projects/sfnet_openmarias/downloads/libgcc_s_dw2-1.dll/
  
  place the dlls in lib/ 
  and in / if you want to run specs


2. Install required gems:

gem install bundler
bundle install


## Code Specifications ##

Run specs  : rspec spec


## Code Metrics ##
The code metrics gem metric_fu is currently broken as of ruby 1.9.3p194.

Run metrics: rake metrics:all


## Credits ##
Music:
night.ogg - Quinn's Song: First Night 
Kevin MacLeod (incompetech.com) Licensed under Creative Commons "Attribution 3.0" http://creativecommons.org/licenses/by/3.0/"

rain.mp3 
Arctura (http://www.freesound.org/samplesViewSingle.php?id=39825)


This is free software.
by Paul Ennemoser