kolb 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in kolb.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,60 @@
+# KOLB 
+
+The aim of this project is to create a [Choose Your Own Adventure][CYOA]
+(CYOA) game engine that can be used to quickly create fun games. 
+
+So far all you can do is play a CYOA called "Kolb & The Dragon"
+(instructions below).
+
+This requires ruby >= 1.9.2
+
+## Instructions
+
+**To install**, type this into your terminal:
+
+    $ git clone git@github.com:ali/kolb.git
+    $ cd kolb
+
+You can also [download this game as a zip file][zip].
+
+[zip]: https://github.com/ali/kolb/zipball/master
+
+**To play**, type
+
+    $ cd kolb
+    $ ruby bin/kolb.rb
+
+**When playing**, you interact with the game by choosing between different actions to take. 
+
+> Enter the cold cave (17)  
+> Enter the windy cave (8)  
+> Walk up the trail (12)  
+
+Choose an action by typing the number you see in parenthesis and hitting enter.
+
+If you want to quit, just enter in `q` or `quit`.
+
+## What I'd like to do next
+
+Currently doing cleanup.
+
+* Gemify project  
+* Add tests  
+* Fix indentation, switch to snake\_case  
+* Games are now Ruby files ([at the recommendation of yorickpeterse](http://www.reddit.com/r/ruby/comments/pd6ur/i_made_a_cyoa_game_engine_in_ruby_need_some_help/c3ogmnq))   
+
+## Feedback
+
+This project has [a thread on Reddit](http://redd.it/pd6ur).
+
+
+## Kolb & The Dragon
+
+I found a [Choose Your Own Adventure][CYOA] book while playing [Skyrim][] called _[Kolb & The Dragon][Kolb]_.
+
+As a programming exercise, this morning (1/7/12) I decided to create a Choose Your Own Adventure program.
+
+[CYOA]: http://en.wikipedia.org/wiki/Choose_Your_Own_Adventure "Choose Your Own Adventure - Wikipedia"
+[Skyrim]: http://en.wikipedia.org/wiki/Skyrim "The Elder Scrolls V - Skyrim"
+[Kolb]: http://www.uesp.net/wiki/Skyrim:Kolb_%26_the_Dragon "Kolb & The Dragon"
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/example.rb

@@ -0,0 +1,129 @@
+#!/bin/env ruby
+
+# An example of how to create a game  using this gem.
+
+##########################################
+# Step 1: Require kolb
+##########################################
+require 'kolb'
+
+##########################################
+# Step 2: Create a book
+##########################################
+kolb = KOLB::Book.new("Kolb & The Dragon")
+
+
+##########################################
+# Step 3: Write pages, link actions.
+##########################################
+
+# 1
+kolb.pages[0] = "Kolb was a brave Nord warrior. One day his Chief asked Kolb to slay an evil dragon that threatened their village. \"Go through the mountain pass, Kolb\", his Chief said. \"You will find the Dragon on the other side.\"" # The test on page 0 (pages are 0-indexed)
+
+kolb.link(0, 1, "Turn to page") # Create a link on page 0, that goes to page 1, with some text
+
+# 2
+kolb.pages[1] = "Kolb took his favorite axe and shield and walked to the pass, where he found a cold cave, a windy cave, and a narrow trail."
+
+kolb.link(1, 16, "Enter the cold cave")
+kolb.link(1, 7, "Enter the windy cave")
+kolb.link(1, 11, "Walk up the trail")
+
+# 3
+kolb.pages[2] = "Kolb stepped onto a rocky hill. He could see the dragon sleeping below, and a tavern off a road nearby."
+
+kolb.link(2, 15, "Climb down")
+kolb.link(2, 13, "Visit tavern")
+
+# 4
+kolb.pages[3] = "Following the stench, Kolb found a filthy orc! The orc snarled and charged Kolb with his spiked club."
+
+kolb.link(3, 8, "Raise Shield")
+kolb.link(3, 12, "Swing Axe")
+
+# 5
+kolb.pages[4] = "Treading through the marsh, Kolb discovered a wailing ghost blocking his way."
+
+kolb.link(4, 14, "Attack Ghost")
+kolb.link(4, 9, "Give Gold")
+
+# 6
+kolb.pages[5] = "The head of the axe lodged itself in the tough, scaly neck of the beast. It wailed and thrashed, but Kolb held on and eventually sawed through the neck, killing the beast. Kolb returned home victorious, and his village was never bothered by the dragon again.
+THE END"
+
+# 7
+kolb.pages[6] = "Leaving the marsh behind him, Kolb could see the dragon's lair nearby, as well as a small, welcoming tavern."
+
+kolb.link(6, 15, "Go to the Lair")
+kolb.link(6, 13, "Go to Tavern")
+
+#8
+kolb.pages[7] = "A strong gust of wind blew Kolb's torch out, and knocked him into a pit where split [sic] his head and died.
+THE END"
+
+#9
+kolb.pages[8] ="The orc cackled as his club splintered Kolb's shield and smashed into his face. There Kolb died, and the orc had soup from his bones.
+THE END"
+
+# 10
+kolb.pages[9] = "Kolb remembered a story his Gran told him and tossed two gold chits for the ghost, and it faded away, allowing him to pass."
+
+kolb.link(9, 6, "Turn to Page")
+
+# 11
+kolb.pages[10] = "Kolb crept towards the belly of the beast, but no sooner had he taken his eyes off the head of the beast than it snapped him up and ate him whole, axe and all.
+THE END"
+
+# 12
+kolb.pages[11] = "Climbing up, Kolb found a camp. He met a wise man who shared bread and showed two paths to the dragon's lair. One went through the hills, the other through a marsh."
+
+kolb.link(11, 2, "Take the hills")
+kolb.link(11, 4, "Take the marsh")
+
+# 13
+kolb.pages[12] = "Before the orc could strike, Kolb swung his mighty axe. The orc's head and club fell uselessly to the floor."
+
+kolb.link(12, 2, "Turn to Page")
+
+# 14
+kolb.pages[13] = "Kolb stopped at the tavern to rest before fighting the dragon. High elves ran the tavern, however, and poisoned his mead so they could steal his gold.
+THE END"
+
+# 15
+kolb.pages[14] = "Kolb swung his axe as hard as he could, but the ghost hardly seemed to notice. The ghost drifted into Kolb, and a deep sleep took him over, from which he never awoke.
+THE END"
+
+# 16
+kolb.pages[15] = "Kolb found the lair where the dragon slept, tendrils of smoke wafting from it's [sic] nostrils. The air made Kolb's eyes sting, and he nearly slipped on the bones of men, picked clean. The beast lay on its side, the throat and belly both waiting targets."
+
+kolb.link(15, 5, "Strike the Neck")
+kolb.link(15, 10, "Strike the Belly")
+
+# 17
+kolb.pages[16] = "Kolb stepped into the frozen cave, but his Nord blood kept him warm. A smelly tunnel climbed ahead of him, and wind howled from another to his left. A ladder was nearby as well."
+
+kolb.link(16, 3, "Take the smelly tunnel")
+kolb.link(16, 7, "Take the windy tunnel")
+kolb.link(16, 11, "Climb the ladder")
+
+
+##########################################
+# Step 4: Create a Game, and call 'run'
+##########################################
+funtime = KOLB::Game.new(kolb)
+funtime.run
+
+
+##########################################
+# Step 5: Play!
+#
+#  a: Install the gem
+#    gem install kolb
+#  
+#  b: Find your game file (cd into its
+#     directory or download a game) 
+#    wget https://raw.github.com/ali/kolb/master/bin/example.rb
+#  
+#  c: Execute the ruby file
+#    ruby example.rb 
+##########################################

data/bin/kolb.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+gem_dir = File.join(File.expand_path(File.dirname(__FILE__)))
+
+require File.join(gem_dir,'..', 'lib', 'kolb')
+
+kolb_file = File.join(gem_dir, '..', 'config', 'kolb.yaml')
+
+
+################
+# Get the book #
+################
+
+# Get YAML
+file = File.open(kolb_file).read
+# Parse YAML
+kolb = KOLB::Book.from_yaml(file) 
+
+##################
+# Start the game #
+##################
+
+game = KOLB::Game.new(kolb)
+game.run

data/config/kolb.yaml

@@ -0,0 +1,121 @@
+# Kolb & The Dragon
+# An Adventure for Nord Boys
+---
+title: Kolb & The Dragon
+pages:
+- Kolb was a brave Nord warrior. One day his Chief asked Kolb to slay an evil dragon
+  that threatened their village. "Go through the mountain pass, Kolb", his Chief said.
+  "You will find the Dragon on the other side."
+- Kolb took his favorite axe and shield and walked to the pass, where he found a cold
+  cave, a windy cave, and a narrow trail.
+- Kolb stepped onto a rocky hill. He could see the dragon sleeping below, and a tavern
+  off a road nearby.
+- Following the stench, Kolb found a filthy orc! The orc snarled and charged Kolb
+  with his spiked club.
+- Treading through the marsh, Kolb discovered a wailing ghost blocking his way.
+- ! 'The head of the axe lodged itself in the tough, scaly neck of the beast. It wailed
+  and thrashed, but Kolb held on and eventually sawed through the neck, killing the
+  beast. Kolb returned home victorious, and his village was never bothered by the
+  dragon again.
+
+  THE END'
+- Leaving the marsh behind him, Kolb could see the dragon's lair nearby, as well as
+  a small, welcoming tavern.
+- ! 'A strong gust of wind blew Kolb''s torch out, and knocked him into a pit where
+  split [sic] his head and died.
+
+  THE END'
+- ! 'The orc cackled as his club splintered Kolb''s shield and smashed into his face.
+  There Kolb died, and the orc had soup from his bones.
+
+  THE END'
+- Kolb remembered a story his Gran told him and tossed two gold chits for the ghost,
+  and it faded away, allowing him to pass.
+- ! 'Kolb crept towards the belly of the beast, but no sooner had he taken his eyes
+  off the head of the beast than it snapped him up and ate him whole, axe and all.
+
+  THE END'
+- Climbing up, Kolb found a camp. He met a wise man who shared bread and showed two
+  paths to the dragon's lair. One went through the hills, the other through a marsh.
+- Before the orc could strike, Kolb swung his mighty axe. The orc's head and club
+  fell uselessly to the floor.
+- ! 'Kolb stopped at the tavern to rest before fighting the dragon. High elves ran
+  the tavern, however, and poisoned his mead so they could steal his gold.
+
+  THE END'
+- ! 'Kolb swung his axe as hard as he could, but the ghost hardly seemed to notice.
+  The ghost drifted into Kolb, and a deep sleep took him over, from which he never
+  awoke.
+
+  THE END'
+- Kolb found the lair where the dragon slept, tendrils of smoke wafting from it's
+  [sic] nostrils. The air made Kolb's eyes sting, and he nearly slipped on the bones
+  of men, picked clean. The beast lay on its side, the throat and belly both waiting
+  targets.
+- Kolb stepped into the frozen cave, but his Nord blood kept him warm. A smelly tunnel
+  climbed ahead of him, and wind howled from another to his left. A ladder was nearby
+  as well.
+actions:
+- page: 0
+  goto: 1
+  text: Turn to page
+- page: 1
+  goto: 16
+  text: Enter the cold cave
+- page: 1
+  goto: 7
+  text: Enter the windy cave
+- page: 1
+  goto: 11
+  text: Walk up the trail
+- page: 2
+  goto: 15
+  text: Climb down
+- page: 2
+  goto: 13
+  text: Visit tavern
+- page: 3
+  goto: 8
+  text: Raise Shield
+- page: 3
+  goto: 12
+  text: Swing Axe
+- page: 4
+  goto: 14
+  text: Attack Ghost
+- page: 4
+  goto: 9
+  text: Give Gold
+- page: 6
+  goto: 15
+  text: Go to the Lair
+- page: 6
+  goto: 13
+  text: Go to Tavern
+- page: 9
+  goto: 6
+  text: Turn to Page
+- page: 11
+  goto: 2
+  text: Take the hills
+- page: 11
+  goto: 4
+  text: Take the marsh
+- page: 12
+  goto: 2
+  text: Turn to Page
+- page: 15
+  goto: 5
+  text: Strike the Neck
+- page: 15
+  goto: 10
+  text: Strike the Belly
+- page: 16
+  goto: 3
+  text: Take the smelly tunnel
+- page: 16
+  goto: 7
+  text: Take the windy tunnel
+- page: 16
+  goto: 11
+  text: Climb the ladder

data/kolb.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "kolb/version"
+
+Gem::Specification.new do |s|
+  s.name        = "kolb"
+  s.version     = KOLB::VERSION
+  s.authors     = ["Ali Ukani"]
+  s.email       = ["ali.ukani@gmail.com"]
+  s.homepage    = "http://github.com/ali/kolb"
+  s.summary     = %q{A CYOA game engine}
+  s.description = %q{A CYOA game engine}
+
+  s.rubyforge_project = "kolb"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "psych"
+end

data/lib/kolb.rb

@@ -0,0 +1,8 @@
+$: << File.dirname(__FILE__)
+
+require 'kolb/version'
+require 'rubygems'
+require 'psych'
+require 'kolb/action'
+require 'kolb/book'
+require 'kolb/game'

data/lib/kolb/action.rb

@@ -0,0 +1,52 @@
+module KOLB 
+# Action
+# * page: The page number you'll find this action on
+# * goto: The page this action links to
+# * text: The text describing this action
+
+  class Action
+    attr_accessor :page, :goto, :text
+
+    def initialize(page, goto, text)
+      @page = page
+      @goto = goto
+      @text = text
+    end
+
+    # Returns this Action as a String
+    # Because @goto is 0-indexed, add 1 for the benefit of the user
+    def to_s
+      return "#{@text} (#{@goto + 1})"
+    end
+
+    # Returns this Action as a Hash
+    def to_hash
+      return {"page" => @page,
+              "goto" => @goto,
+              "text" => @text}
+    end
+
+    # Makes an Action from a Hash
+    def self.from_hash(hash)
+      # Verify
+      if hash.class == Hash && hash.has_key?("page") && hash.has_key?("goto") && hash.has_key?("text")
+        # Initialize
+        self.new(hash["page"], hash["goto"], hash["text"])
+      else
+        raise "Invalid hash\n\tGiven: #{hash}"
+      end
+    end
+
+    # # Returns this Action as YAML
+    # def to_yaml
+    #   # Use Pysch to create a YAML version of this Action as a Hash
+    #   return Psych.dump(to_hash)
+    # end
+
+    # # Creates an Action from YAML
+    # def self.from_yaml(yaml)
+    #   # Use Pysch to read a YAML version of an Action as a Hash
+    #   from_hash(Psych.load(yaml))
+    # end
+  end
+end

data/lib/kolb/book.rb

@@ -0,0 +1,73 @@
+module KOLB 
+
+# Represents the Choose Your Own Adventure book
+  class Book
+    attr_accessor :title, :pages, :actions
+
+    # Creats a Book
+    #   title must be a String
+    #   pages must be an Array of Strings
+    #   actions must be an Array of Actions
+    def initialize(title, pages = [], actions = [])
+      @title = title
+      @pages = pages
+      @actions = actions
+    end
+
+    # Returns a Page given its number.
+    # Word-wraps text by default.
+    def page(num, wrap = true, wraplength = 70)
+      if wrap
+        return wrap_text(@pages[num], wraplength)
+      else
+        return @pages[num]
+      end
+    end
+
+    # Creates an Action linking Page a to Page b
+    def link(a, b, text)
+      @actions << Action.new(a, b, text)
+    end
+
+    # Returns an array of all the Actions available
+    #  on a Page given its number
+    def actions_for_page(page)
+      return @actions.select { |a| a.page == page }
+    end
+
+    # Helper function to wrap text to a given length
+    # Source: http://blog.macromates.com/2006/wrapping-text-with-regular-expressions/
+    def wrap_text(txt, col = 70)
+      return txt.gsub(/(.{1,#{col}})( +|$\n?)|(.{1,#{col}})/,
+                      "\\1\\3\n")
+    end
+
+    # Returns this Book as a Hash
+    def to_hash
+      hash = {"title" => @title,
+              "pages" => @pages,
+              "actions" => @actions.collect { |a| a.to_hash }}
+      return hash
+    end
+
+    # Creates a Book from a Hash
+    def self.from_hash(hash)
+      # Verify the Hash
+      if hash.class == Hash && hash.keys == ["title", "pages", "actions"]
+        self.new(hash["title"],
+                 hash["pages"],
+                 hash["actions"].collect { |a| Action.from_hash(a) })
+      end
+    end
+
+    # Returns this Book as a YAML document
+    def to_yaml
+      return Psych.dump(to_hash)
+    end
+
+    # Creates a Book from a YAML document (of a Book as a Hash)
+    def self.from_yaml(yaml)
+      self.from_hash(Psych.load(yaml))
+    end
+  end
+end

data/lib/kolb/game.rb

@@ -0,0 +1,69 @@
+module KOLB
+
+# The interface which the user interacts with.
+  class Game
+
+    attr_accessor :book, :exits
+
+    def initialize(book)
+      @book = book
+      @exits = ["q", "quit", "exit", "end"] # Ways to quit out of the game
+    end
+
+    # Runs the game
+    def run
+      puts "You are now reading \"#{@book.title}\"."
+
+      loc = 0 # The page we're on
+      actions = [] # Available actions
+
+      while true
+        # Get info
+        page = @book.page(loc)
+        actions = @book.actions_for_page(loc)
+        choices = actions.collect { |a| a.goto }
+
+        # Print
+        puts "\n#{page}"
+        actions.each do |a|
+          puts a
+        end
+
+        # If we don't have any choices, end here.
+        break if choices.empty?
+
+        # Get input
+        input = get_input(choices, "You can't do that.\n#{actions.collect { |a| a.to_s }.join("\n")}")
+
+        if @exits.include?(input)
+          break
+        else
+          input = input.to_i - 1
+        end
+
+        # Turn to that page.
+        loc = input
+      end
+    end
+
+    # Gets the user's input and checks it against a list of valid input options.
+    # Choices is a list of valid input options (an array of page numbers as Integers).
+    # Errortext is a String that gets printed if an invalid choice is made.
+    def get_input(choices, errortext)
+      # Add 1 to the list of choices (they're 0-indexed, but what we show the user isn't)
+      # Also, append the exit commands.
+      valid = choices.collect { |c| (c + 1).to_s } + @exits
+
+      begin
+        # Get user input
+        input = gets.strip
+
+        # Helpful error message
+        puts errortext if !valid.include?(input)
+      end while !valid.include?(input) # Loop if invalid
+
+      return input
+    end
+  end
+
+end

data/lib/kolb/version.rb

@@ -0,0 +1,3 @@
+module KOLB 
+  VERSION = "0.0.1"
+end

data/test/action_test.rb

@@ -0,0 +1,24 @@
+require "test/unit"
+
+class ActionTest < Test::Unit::TestCase
+
+  # Called before every test method runs. Can be used
+  # to set up fixture information.
+  def setup
+    # Do nothing
+  end
+
+  # Called after every test method runs. Can be used to tear
+  # down fixture information.
+
+  def teardown
+    # Do nothing
+  end
+
+  # Fake test
+  def test_fail
+
+    # To change this template use File | Settings | File Templates.
+    fail("Not implemented")
+  end
+end

data/test/game_test.rb

@@ -0,0 +1,9 @@
+require './lib/cyoa/game'
+require "test/unit"
+
+class GameTest < Test::Unit::TestCase
+
+  def test_fails
+    fail
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: kolb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ali Ukani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: &70270677942540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70270677942540
+description: A CYOA game engine
+email:
+- ali.ukani@gmail.com
+executables:
+- example.rb
+- kolb.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- bin/example.rb
+- bin/kolb.rb
+- config/kolb.yaml
+- kolb.gemspec
+- lib/kolb.rb
+- lib/kolb/action.rb
+- lib/kolb/book.rb
+- lib/kolb/game.rb
+- lib/kolb/version.rb
+- test/action_test.rb
+- test/game_test.rb
+homepage: http://github.com/ali/kolb
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: kolb
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A CYOA game engine
+test_files:
+- test/action_test.rb
+- test/game_test.rb
+has_rdoc: