Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Expanded readme with feature list.

  • Loading branch information...
commit c4df2869180c78bc4aeae6059f6079f69ac48cea 1 parent aec08f5
@Spooner authored
Showing with 24 additions and 3 deletions.
  1. +24 −3 README.md
View
27 README.md
@@ -4,19 +4,40 @@ Ruby Armor
A graphical front-end for [RubyWarrior](https://github.com/ryanb/ruby-warrior). Make sure your Ruby Warrior is wearing Ruby Armor!
* Author: Spooner / Bil Bas (bil.bagpuss@gmail.com)
-* License: MIT
+* License: [MIT](http://opensource.org/licenses/MIT)
* Website: http://spooner.github.com/games/ruby_armor/
* Project: https://github.com/Spooner/ruby_armor
+Features
+--------
+
+RubyArmor has all the features of [RubyWarrior](https://github.com/ryanb/ruby-warrior), but with a more friendly, graphical interface. It also adds some unique features:
+
+### Extended functionality
+
+* After a level has been finished (completed or failed) the user can drag a slider to see what the state was during each turn.
+* Records code and score when each level is completed. This code can be reviewed at any point later, which can be used to see how your code evolved during play.
+* Speed of playback can be changed while watching the game being played (from one turn per display frame, up to one turn per second). Preferred playback speed is saved with the profile.
+* At any point, user can reset the level back to the start, without having to wait to see it played out to the end.
+* The text log can be viewed as individual turns rather than the normal stream of turns. This can make it easier to follow.
+
+### Purely cosmetic additions
+
+* The rogue-like ASCII game display is also displayed with colourful graphics in a pixelated style.
+* Floating numbers appear when damage is taken or healed.
+* Can choose whether you play as a Valkyrie, Mercenary, Monk or Burglar (This difference is entirely cosmetic, since it just changes the graphics used for the warrior).
+
Installation
------------
- gem install ruby_armor --pre
+RubyArmor requires Ruby 1.9.2 or higher (sorry!). It is still in an alpha state, so must be installed using `--pre`
+
+ > gem install ruby_armor --pre
Play
----
- ruby_armor
+ > ruby_armor
Credits
-------
Please sign in to comment.
Something went wrong with that request. Please try again.