tuvi 0.0.13 → 0.0.14

data/README.md

@@ -14,69 +14,74 @@ Here is a basic example program followed by an explanation:
 
     require 'tuvi'
 
-    step 1 do
-      say "Welcome to KrazyMaze. Will you ever get out? BWAAHAAA! You have a choice to make: Go right or left"
-      response "right" => 2
-      response "left" => 3
+    step "start" do
+      say "You have just woken up from a fitful sleep. You get out of your bed ... and you realize that you are not in your bedroom. As your eyes take in your surroundings, you realize that you are in some sort of dungeon. 'How did I get here?' you wonder. You see a small table with with a key on it."
+      response "take key" => "door"
     end
 
-    step 2 do
-      say "You're in the middle of the maze. Go right or left or straight."
-      response "right" => 3
-      response "left" => 4
-      response "straight" => 3
+    step "door" do
+      say "You're holding the key. In front of you is a locked door with 3 locks. One is painted red, one is painted blue, and one is painted black. Which lock do you want to try the key on?"
+      response "red" => "locked door"
+      response "blue" => "locked door"
+      response "black" => "open door"
     end
 
-    step 3 do
-      say "You've encountered a monster! You can either go straight, or punch the monster."
-      response "straight" => 2
-      response "punch" => 5
+    step "locked door" do
+      say "Hmmm. That didn't work. Perhaps the key would work on a different lock..."
+      response "red" => "locked door"
+      response "blue" => "locked door"
+      response "black" => "open door"
     end
 
-    step 4 do
-      say "Drat. You've reached the end of the maze! I'll get you next time..."
+    step "open door" do
+      say "It worked! The door swings open slowly, and you enter what seems to be a dark hallway. Eventually the hallway comes to a pair of staircases, one of which goes up, and the other of which goes down. You hear footsteps on the floor above you, and you wonder which staircase you should take."
+      response "up" => "second floor"
+      response "down" => "basement"
+    end
+
+    step "second floor" do
+      say "You walk up the stairs and see a strange creature. It comes towards you with its mouth gaping open and..."
       stop
     end
 
-    step 5 do
-      say "The monster was stronger than you! You died."
+    step "basement" do
+      say "There's an open door in front of you, and you make your escape from the haunted castle!"
       stop
     end
 
 First, create a ruby file and on the first line require the Tuvi library with `require 'tuvi'`
 
-From here on in, the Tuvi language is used. As you can see, the program is divided into steps, which represent a step in the program where the program provides some instructions, and either prompts the user for input or simply exits.
+From here on in, the Tuvi language is used. As you can see, the program is divided into Steps, which represent a step in the program where the program provides some instructions, and either prompts the user for input or simply exits.
 
 Every step needs a `say`, which sets the computer's instructions for that step.
 
-Every step can establish one or more lines declaring an `response` which is followed first by a valid user response, a hashrocket arrow, and then by the step number that that particular user response should lead to.
+Every step can establish one or more lines declaring a `response` which is followed first by a valid user response, a hashrocket arrow, and then by the Step title (as a string) that that particular user response should lead to.
 
-Some steps, instead of having responses, can simply end the program using the `stop` keyword.
+Some steps, instead of having responses, can simply `say` a message and then end the program using the `stop` keyword.
 
 You can run this file like any other Ruby file, using `ruby filename.rb`.
 
-You can also add any custom Ruby code by placing it block passed to the `code` method. Also note that variables should be set as globals. For example:
+You can also add arbitrary Ruby code by placing it in a block passed to the `code` method. If you set a variable, you'll have to do it as global variable. For example:
 
-    step 1 do
-      code {$steps = 1}
+    step "start" do
+      code {$points = 0}
       say "Welcome to KrazyMaze. Will you ever get out? BWAAHAAA! You have a choice to make: Go right or left"
-      response "right" => 2
-      response "left" => 3
+      response "right" => "middle"
+      response "left" => "east end"
     end
 
-    step 2 do
+    step "middle" do
       code do
-        $steps += 1
-        puts "You have taken #{$steps} steps."
+        $points += 1
+        puts "You have #{$points} points."
       end
       say "You're in the middle of the maze. Go right or left or straight."
-      response "right" => 3
-      response "left" => 4
-      response "straight" => 3
+      response "right" => "west end"
+      response "left" => "start"
+      response "straight" => "dungeon"
     end
 
-
-## Contributing
+## Contributing (please do!)
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/example_program.rb

@@ -1,20 +1,36 @@
 require_relative 'lib/tuvi.rb'
 
-step 1 do
-  code {$x = "hello"}
-  say "This is Step 1. Type yes to go to Step 2. Type no to go to Step 3."
-  response "Yes" => 2
-  response "No" => 3
+step "start" do
+  say "You have just woken up from a fitful sleep. You get out of your bed ... and you realize that you are not in your bedroom. As your eyes take in your surroundings, you realize that you are in some sort of dungeon. 'How did I get here?' you wonder. You see a small table with with a key on it."
+  response "take key" => "door"
 end
 
-step 2 do
-  code {puts $x}
-  say "This is Step 2. Type hi to go to Step 3. Type bye to go to step 1."
-  response "Hi" => 3
-  response "Bye" => 1
+step "door" do
+  say "You're holding the key. In front of you is a locked door with 3 locks. One is painted red, one is painted blue, and one is painted black. Which lock do you want to try the key on?"
+  response "red" => "locked door"
+  response "blue" => "locked door"
+  response "black" => "open door"
 end
 
-step 3 do
-  say "You've reached the end!"
+step "locked door" do
+  say "Hmmm. That didn't work. Perhaps the key would work on a different lock..."
+  response "red" => "locked door"
+  response "blue" => "locked door"
+  response "black" => "open door"
+end
+
+step "open door" do
+  say "It worked! The door swings open slowly, and you enter what seems to be a dark hallway. Eventually the hallway comes to a pair of staircases, one of which goes up, and the other of which goes down. You hear footsteps on the floor above you, and you wonder which staircase you should take."
+  response "up" => "second floor"
+  response "down" => "basement"
+end
+
+step "second floor" do
+  say "You walk up the stairs and see a strange creature. It comes towards you and..."
   stop
 end
+
+step "basement" do
+  say "There's an open door in front of you, and you make your escape from the haunted castle!"
+  stop
+end

data/lib/tuvi/application_runner.rb

@@ -5,7 +5,8 @@ class ApplicationRunner
   end
 
   def run
-    current_step_id = 1
+    puts "Welcome! Type 'exit' to quit at any time."
+    current_step_id = "start"
     while true do
       current_step_id = execute_step(current_step_id)
     end

data/lib/tuvi/step.rb

@@ -28,7 +28,7 @@ class Step
   end
 
   def formatted_responses
-    "You can type one of the following: [#{@response_paths.keys.join(", ")}]. Enter 'exit' to quit."
+    "Choose a command: [#{@response_paths.keys.join(", ")}]"
   end
 
   def code(&block)

data/lib/tuvi/version.rb

@@ -1,3 +1,3 @@
 module Tuvi
-  VERSION = "0.0.13"
+  VERSION = "0.0.14"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tuvi
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-27 00:00:00.000000000 Z
+date: 2014-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 920541473869891771
+      hash: 1645267499597312688
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 920541473869891771
+      hash: 1645267499597312688
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25