Hangman TV Game

By: Afshin Mokhtari, Aug 2013

Click here to see some pre-recorded games using github preview.

There are two distinct parts to this implementation:

• The game itself is written ruby and so runs in a ruby interpreter, it can be played all by itself. However, I 'broadcast' the game into the cloud using Firebase. You can watch a game live or pre-recorded from the browser. ( They are saved to my Firebase account.)

• This is a super-sized implmentation of the Hangman exercise from the Odin project: Details: TheOdinProject.com

To run my code,

• Clone this repo down to your local environment,

• To see a live or pre-recorged game, run the front-end... pull index.html into your browser

• For the backend (which lets u play & broadcast a live game), you need to run the ruby code...

-- You don't need a firebase account yourself, the code uses mine - for now. You will need to install the following gem: BigBertha - Ruby wrapper for the Firebase backend API

-- After you've pulled down the code, under the game directory, go in irb:

load "hangman.rb"

then to set the game up,

h = Hangman.new({ playerId => "Your Name"});

#	Here are all the options for .new(): 
#		:verbose => true 			To get debugging/interesting output
#  		:dict => "fname.txt"		Dictionary filename, defaults to "5desk.txt"
# 		:answer => "5to12charword"  Set your own word instead of relying on random word
#  		:turnLimit => number		How many turns before game is over, defaults to 10
#  		:debug => true				More verbose messages, sets :verbose to true too
#  		:push => true				Send live updates of each turn to Firebase as an event, default true
#  		:firebaseURI 				firebase is our data-store in the cloud, default below
# 		:id                         Used to namespace session in Firebase
#  		:playerId => string 		Name of player (broadcast to frontend)

broadcasting is automatic, now just :

h.play

Purpose:

I was going through the Odin curriculum, this project is part of an exercise in working with files and serializing data in Ruby. I wanted to add a little spice and play with the Firebase API at the same time, and so Hangman TV was born. I had fun making it. However, my goal was not to really make a full-blown game, there is plenty of room for improvement.

Tools:

• Ruby
• Javascript, HTML, CSS
• Firebase API (Both in Ruby and JS ends)

TODO:

• The game is pretty robust but there are edge cases I haven't addressed; like if your connection to the net is down, or if there are multiple people broadcasting at the same time. Also, there is no automatic deletion of old games; another reason to add the ability to use YOUR firebase account instead of mine!

---

Created by [Afshin Mokhtari](http://www.github.com/afshinator)