gemwarrior 0.9.34 → 0.9.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 523d98df545f5eaf8a9279b406d78dbfef8f24e3
-  data.tar.gz: bebad9e25fd49e38414971b4a00eae814ad47f30
+  metadata.gz: fc7bbe78afbe9851724a0e8407e87531e6bde82b
+  data.tar.gz: d7e658ba14076615e4bb4f17cfce0845a3373a5c
 SHA512:
-  metadata.gz: 0af08ecba64189fd0d0584e2083784aecca10fc9a19e988d986e4d7415f2867f3b129c9631db7377496b4d7819e5647e43ed49c4f3f59991c6877844e2f86d57
-  data.tar.gz: dc352fd0e448a78e6441a78601694a744afae6f3a3b62e18e2a9249bffe95d19bbff2d5ad40e762ca8593a40e956f59dc65f63b6684a3e57affed7bab024182e
+  metadata.gz: 29f39b6e22047dbe11d9bcb90fa7c8ac71799fa76dc972e3be9302d615f9e861767571083392991e4aae7fbc33a47be01d8cfc4109423ee5d93dce825ea9dd7a
+  data.tar.gz: 51c9317fc21bb2363c990862d591ae649d0037271ff2286efa3f310226f869e4aced2396f0ee45a3074bfea811b66213bcd5095ac80634f536ea0391e9c6fb2a

data/Rakefile

@@ -1 +1,10 @@
-require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/bin/gemwarrior

@@ -3,29 +3,35 @@
 require 'optparse'
 
 require_relative '../lib/gemwarrior/game'
+require_relative '../lib/gemwarrior/game_options'
 require_relative '../lib/gemwarrior/version'
 
+include Gemwarrior
+
 GAME_NAME = 'Gem Warrior'
 
 def parse_options_cli
   options = {
-    :beast_mode     => false, 
-    :debug_mode     => false, 
-    :god_mode       => false, 
-    :new_game       => false,
-    :sound          => false,
-    :use_wordnik    => false, 
-    :extra_command  => nil
+    beast_mode:     false, 
+    debug_mode:     false, 
+    god_mode:       false, 
+    new_game:       false,
+    sound_enabled:  false,
+    sound_volume:   0.3,
+    use_wordnik:    false, 
+    extra_command:  nil
   }
-  
+
   options_file = read_options_file
   
   unless options_file.nil?
-    sound_option = options_file[0][1].eql?('false') ? false : true
-    wordnik_option = options_file[1][1].eql?('false') ? false : true
+    sound_enabled_option    = options_file[0][1].eql?('false') ? false : true
+    sound_volume_option     = options_file[1][1].to_f
+    use_wordnik_option      = options_file[2][1].eql?('false') ? false : true
     
-    options[:sound] = sound_option
-    options[:use_wordnik] = wordnik_option
+    options[:sound_enabled] = sound_enabled_option
+    options[:sound_volume]  = sound_volume_option
+    options[:use_wordnik]   = use_wordnik_option
   end
 
   optparse = OptionParser.new do |opts|
@@ -46,7 +52,7 @@ def parse_options_cli
     end
     
     opts.on('-s', '--sound', 'Enable sound (experimental)') do
-      options[:sound] = true
+      options[:sound_enabled] = true
     end
 
     opts.on('-v', '--version', 'Display version number and exit') do
@@ -71,21 +77,17 @@ end
 def print_error(error)
   case error
   when OptionParser::InvalidOption
-    puts "#{$GAME_NAME}: illegal option #{error.args.join(' ')}"
+    puts "#{GAME_NAME}: illegal option #{error.args.join(' ')}"
   else
-    puts "An unexpected error occurred while running #{$GAME_NAME}:"
+    puts "An unexpected error occurred while running #{GAME_NAME}:"
     puts "  #{error}\n"
   end
 end
 
-def get_options_file_path
-  "#{Dir.home}/.gemwarrior_options"
-end
-
 def read_options_file
-  options = []
-  if File.exist?(get_options_file_path)
-    File.open(get_options_file_path).readlines.each do |line|
+  if File.exist?(GameOptions.data['options_file_path'])
+    options = []
+    File.open(GameOptions.data['options_file_path']).readlines.each do |line|
       options << line.chomp.split(':')
     end
     return options
@@ -94,6 +96,9 @@ def read_options_file
 end
 
 begin
+  GameOptions.add 'log_file_path', "#{Dir.home}/.gemwarrior_log"
+  GameOptions.add 'options_file_path', "#{Dir.home}/.gemwarrior_options"
+  
   options = parse_options_cli
 
   Gemwarrior::Game.new(options)

data/gemwarrior.gemspec

@@ -32,9 +32,17 @@ Gem::Specification.new do |spec|
   # gems for future features
   # spec.add_runtime_dependency 'hr', '~> 0.0.2'
 
-  spec.add_development_dependency 'pry-byebug', '~> 3.0'
   spec.add_development_dependency 'bundler', '~> 1.8'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  
   spec.add_development_dependency 'rubocop', '~> 0.29'
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-nc'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-remote'
+  spec.add_development_dependency 'pry-nav'
+  spec.add_development_dependency 'pry-byebug', '~> 3.0'
 end

data/lib/gemwarrior/battle.rb

@@ -2,6 +2,7 @@
 # Monster battle
 
 require_relative 'misc/player_levels'
+require_relative 'game_options'
 
 module Gemwarrior
   class Battle
@@ -23,16 +24,14 @@ module Gemwarrior
     end
 
     def start(is_arena = nil, is_event = nil)
-      if world.sound
-        Music::cue([
-          { frequencies: 'G4',  duration: 50 },
-          { frequencies: 'G#4', duration: 50 },
-          { frequencies: 'G4',  duration: 50 },
-          { frequencies: 'G#4', duration: 50 },
-          { frequencies: 'G4',  duration: 50 },
-          { frequencies: 'G#4', duration: 50 }
-        ])
-      end
+      Music::cue([
+        { frequencies: 'G4',  duration: 50 },
+        { frequencies: 'G#4', duration: 50 },
+        { frequencies: 'G4',  duration: 50 },
+        { frequencies: 'G#4', duration: 50 },
+        { frequencies: 'G4',  duration: 50 },
+        { frequencies: 'G#4', duration: 50 }
+      ])
 
       print_battle_line
 
@@ -77,21 +76,17 @@ module Gemwarrior
 
         # print health info
         print "#{player.name.upcase.ljust(12)} :: #{player.hp_cur.to_s.rjust(3)} HP"
-        if world.debug_mode
-          print " (LVL: #{player.level})"
-        end
+        print " (LVL: #{player.level})" if GameOptions.data['debug_mode']
         print "\n"
 
         print "#{monster.name.upcase.ljust(12)} :: "
-        if world.debug_mode || player.special_abilities.include?(:rocking_vision)
+        if GameOptions.data['debug_mode'] || player.special_abilities.include?(:rocking_vision)
           print "#{monster.hp_cur.to_s.rjust(3)}"
         else
           print '???'
         end
         print ' HP'
-        if world.debug_mode
-          print " (LVL: #{monster.level})"
-        end
+        print " (LVL: #{monster.level})" if GameOptions.data['debug_mode']
         print "\n"
         puts
 
@@ -122,18 +117,16 @@ module Gemwarrior
           puts "You attack #{monster.name}#{player.cur_weapon_name}!"
           dmg = calculate_damage_to(monster)
           if dmg > 0
-            if world.sound
-              Music::cue([{ frequencies: 'A4,E4,B5', duration: 75 }])
-            end
+            Music::cue([{ frequencies: 'A4,E4,B5', duration: 75 }])
+
             take_damage(monster, dmg)
             if monster_dead?
               result = monster_death
               return result
             end
           else
-            if world.sound
-              Music::cue([{ frequencies: 'A4', duration: 75 }])
-            end
+            Music::cue([{ frequencies: 'A4', duration: 75 }])
+
             puts 'You miss entirely!'.colorize(:yellow)
           end
         when 'defend', 'd'
@@ -145,7 +138,7 @@ module Gemwarrior
           print "#{monster.name}".colorize(:white)
           print " (#{monster.hp_cur}/#{monster.hp_max} HP): #{monster.description}\n"
           puts "It has some distinguishing features, too: face is #{monster.face}, hands are #{monster.hands}, and general mood is #{monster.mood}."
-          if world.debug_mode
+          if GameOptions.data['debug_mode']
             puts 'If defeated, will receive:'
             puts " >> XP   : #{monster.xp}"
             puts " >> ROX  : #{monster.rox}"
@@ -192,7 +185,7 @@ module Gemwarrior
           atk_range = base_atk_lo..base_atk_hi
 
           # beast mode modifier
-          if player.beast_mode
+          if GameOptions.data['beast_mode']
             atk_range = BEAST_MODE_ATTACK..BEAST_MODE_ATTACK
           # level 3 ability modifier
           elsif player.special_abilities.include?(:rock_slide)
@@ -250,14 +243,12 @@ module Gemwarrior
 
       dmg = calculate_damage_to(player)
       if dmg > 0
-        if world.sound
-          Music::cue([{ frequencies: 'B4,E#5,A5', duration: 75 }])
-        end
+        Music::cue([{ frequencies: 'B4,E#5,A5', duration: 75 }])
+
         take_damage(player, dmg)
       else
-        if world.sound
-          Music::cue([{ frequencies: 'B4', duration: 75 }])
-        end
+        Music::cue([{ frequencies: 'B4', duration: 75 }])
+
         puts "#{monster.name} misses entirely!".colorize(:yellow)
       end
     end
@@ -296,6 +287,7 @@ module Gemwarrior
             { frequencies: 'F#5', duration: 50 },
             { frequencies: 'G5',  duration: 1000 }
           ])
+
           puts monster.defeated_text
           gets
           return 'exit'
@@ -322,23 +314,14 @@ module Gemwarrior
 
     # PLAYER
     def player_near_death?
-      ((player.hp_cur.to_f / player.hp_max.to_f) < 0.10 && !player.god_mode)
+      ((player.hp_cur.to_f / player.hp_max.to_f) < 0.10 && !GameOptions.data['god_mode'])
     end
 
     def player_dead?
-      (player.hp_cur <= 0 && !player.god_mode)
+      (player.hp_cur <= 0 && !GameOptions.data['god_mode'])
     end
 
     def player_death
-      if world.sound
-        Music::cue([
-          { frequencies: 'D#5', duration: 100 },
-          { frequencies: 'A4',  duration: 150 },
-          { frequencies: 'F#4', duration: 200 },
-          { frequencies: 'F4',  duration: 1000 }
-        ])
-      end
-
       puts "You are dead, slain by the #{monster.name}!".colorize(:red)
       print_battle_line
     end

data/lib/gemwarrior/entities/location.rb

@@ -2,6 +2,7 @@
 # Place in the game
 
 require_relative 'entity'
+require_relative '../game_options'
 
 module Gemwarrior
   class Location < Entity
@@ -28,11 +29,11 @@ module Gemwarrior
       self.checked_for_monsters = false
     end
 
-    def status(debug_mode = false)
+    def status
       status_text =  name.ljust(30).upcase.colorize(:green)
       status_text << coords.values.to_a.to_s.colorize(:white)
-      status_text << " DL[#{danger_level.to_s.ljust(8)}] ".colorize(:white) if debug_mode
-      status_text << " MLR[#{monster_level_range.to_s.ljust(6)}] ".colorize(:white) if debug_mode
+      status_text << " DL[#{danger_level.to_s.ljust(8)}] ".colorize(:white) if GameOptions.data['debug_mode']
+      status_text << " MLR[#{monster_level_range.to_s.ljust(6)}] ".colorize(:white) if GameOptions.data['debug_mode']
       status_text << "\n#{description}\n".colorize(:white)
     end
 

data/lib/gemwarrior/entities/player.rb

@@ -3,6 +3,7 @@
 
 require_relative 'creature'
 require_relative '../battle'
+require_relative '../game_options'
 require_relative '../misc/formatting'
 require_relative '../misc/name_generator'
 require_relative '../misc/player_levels'
@@ -18,18 +19,16 @@ module Gemwarrior
     include PlayerLevels
     include Formatting
 
-    attr_accessor :stam_cur, :stam_max, :cur_coords, 
-                  :god_mode, :beast_mode, :use_wordnik, :special_abilities,
+    attr_accessor :stam_cur, :stam_max, :cur_coords, :special_abilities,
                   :monsters_killed, :items_taken, :movements_made, :rests_taken, :deaths
 
     def initialize(options)
       self.name               = generate_name
       self.description        = options.fetch(:description)
-      self.use_wordnik        = options.fetch(:use_wordnik)
 
-      self.face               = generate_face(use_wordnik)
-      self.hands              = generate_hands(use_wordnik)
-      self.mood               = generate_mood(use_wordnik)
+      self.face               = generate_face
+      self.hands              = generate_hands
+      self.mood               = generate_mood
 
       self.level              = options.fetch(:level)
       self.xp                 = options.fetch(:xp)
@@ -47,10 +46,6 @@ module Gemwarrior
       self.stam_cur           = options.fetch(:stam_cur)
       self.stam_max           = options.fetch(:stam_max)
       self.cur_coords         = options.fetch(:cur_coords)
-
-      self.god_mode           = options.fetch(:god_mode)
-      self.beast_mode         = options.fetch(:beast_mode)
-      
       self.special_abilities  = []
 
       self.monsters_killed    = 0
@@ -60,7 +55,7 @@ module Gemwarrior
       self.deaths             = 0
     end
 
-    def check_self(debug_mode = false, show_pic = true)
+    def check_self(show_pic = true)
       unless show_pic == false
         print_char_pic
       end
@@ -83,7 +78,7 @@ module Gemwarrior
         abilities = Formatting::upstyle(special_abilities.collect { |x| x.to_s }).join(', ')
       end
       self_text =  "NAME      : #{self.name}\n"
-      self_text << "POSITION  : #{self.cur_coords.values.to_a}\n" if debug_mode
+      self_text << "POSITION  : #{self.cur_coords.values.to_a}\n" if GameOptions.data['debug_mode']
       self_text << "WEAPON    : #{weapon_slot}\n"
       self_text << "LEVEL     : #{self.level}\n"
       self_text << "EXPERIENCE: #{self.xp}\n"
@@ -92,9 +87,10 @@ module Gemwarrior
       self_text << "DEXTERITY : #{self.dexterity}\n"
       self_text << "DEFENSE   : #{self.defense}\n"
       self_text << "ABILITIES : #{abilities}\n"
-      if debug_mode
-        self_text << "GOD_MODE  : #{self.god_mode}\n"
-        self_text << "BEAST_MODE: #{self.beast_mode}\n"
+      
+      if GameOptions.data['debug_mode']
+        self_text << "GOD_MODE  : #{GameOptions.data['god_mode']}\n"
+        self_text << "BEAST_MODE: #{GameOptions.data['beast_mode']}\n"
       end
 
       self_text << "\n"
@@ -162,7 +158,7 @@ module Gemwarrior
           self.hp_cur = self.hp_cur.to_i + rand(10..15)
           self.hp_cur = self.hp_max if self.hp_cur > self.hp_max
 
-          status_text = "You lie down somewhere quasi-flat and after a few moments, due to extreme exhaustion, you fall into a deep, yet troubled, slumber. Approximately #{hours} #{hours_text}, #{minutes} #{mins_text}, and #{seconds} #{secs_text} later, you wake up with a start. Upon getting to your feet you look around, notice you feel somewhat better, and wonder why you dreamt about #{WordList.new(world.use_wordnik, 'noun-plural').get_random_value}."
+          status_text = "You lie down somewhere quasi-flat and after a few moments, due to extreme exhaustion, you fall into a deep, yet troubled, slumber. Approximately #{hours} #{hours_text}, #{minutes} #{mins_text}, and #{seconds} #{secs_text} later, you wake up with a start. Upon getting to your feet you look around, notice you feel somewhat better, and wonder why you dreamt about #{WordList.new('noun-plural').get_random_value}."
           status_text << "\n>> You regain a few hit points."
 
           return status_text
@@ -193,7 +189,7 @@ module Gemwarrior
       inventory.list_contents
     end 
 
-    def go(locations, direction, sound)
+    def go(locations, direction)
       case direction
       when 'north', 'n'
         self.cur_coords = {
@@ -224,7 +220,7 @@ module Gemwarrior
         }
         direction_text = '<<<'
       end
-      print_traveling_text(direction_text, sound)
+      print_traveling_text(direction_text)
 
       # stats
       self.movements_made += 1
@@ -324,29 +320,18 @@ module Gemwarrior
     private
 
     def player_death
-      if world.sound
-        Music::cue([
-          { frequencies: 'D#5', duration: 100 },
-          { frequencies: 'A4',  duration: 150 },
-          { frequencies: 'F#4', duration: 200 },
-          { frequencies: 'F4',  duration: 1000 }
-        ])
-      end
-      
       puts 'Your actions have reduced you to death.'.colorize(:red)
       puts 'Somehow, however, your adventure does not end here. Instead, you are whisked back home via some magical force, a bit worse for the weary and somewhat poorer, but ALIVE!'.colorize(:yellow)
       return 'death'
     end
 
     # TRAVEL
-    def print_traveling_text(direction_text, sound)
-      if sound
-        Music::cue([
-          { frequencies: 'C4', duration: 75 },
-          { frequencies: 'D4', duration: 75 },
-          { frequencies: 'E4', duration: 75 }
-        ])
-      end
+    def print_traveling_text(direction_text)
+      Music::cue([
+        { frequencies: 'C4', duration: 75 },
+        { frequencies: 'D4', duration: 75 },
+        { frequencies: 'E4', duration: 75 }
+      ])
       Animation::run(phrase: "* #{direction_text} *", oneline: false)
     end
 
@@ -372,18 +357,18 @@ module Gemwarrior
       NameGenerator.new('fantasy').generate_name
     end
 
-    def generate_face(use_wordnik)
-      face_descriptors = WordList.new(use_wordnik, 'adjective')
+    def generate_face
+      face_descriptors = WordList.new('adjective')
       face_descriptors.get_random_value
     end
 
-    def generate_hands(use_wordnik)
-      hand_descriptors = WordList.new(use_wordnik, 'adjective')
+    def generate_hands
+      hand_descriptors = WordList.new('adjective')
       hand_descriptors.get_random_value
     end
 
-    def generate_mood(use_wordnik)
-      mood_descriptors = WordList.new(use_wordnik, 'adjective')
+    def generate_mood
+      mood_descriptors = WordList.new('adjective')
       mood_descriptors.get_random_value
     end
   end

data/lib/gemwarrior/evaluator.rb

@@ -2,6 +2,7 @@
 # Evaluates prompt input
 
 require_relative 'arena'
+require_relative 'game_options'
 
 module Gemwarrior
   class Evaluator
@@ -110,12 +111,12 @@ module Gemwarrior
       param3 = tokens[3]
 
       # dev commands
-      if world.debug_mode
+      if GameOptions.data['debug_mode']
         case command
         when 'god', 'gd'
-          return world.player.god_mode = !world.player.god_mode
+          return GameOptions.data['god_mode'] = !GameOptions.data['god_mode']
         when 'beast', 'bs'
-          return world.player.beast_mode = !world.player.beast_mode
+          return GameOptions.data['beast_mode'] = !GameOptions.data['beast_mode']
         when 'vars', 'v'
           world.print_vars
         when 'list', 'ls'
@@ -267,7 +268,7 @@ module Gemwarrior
       case command
       when 'character', 'c'
         # bypass puts so it prints out with newlines properly
-        print world.player.check_self(world.debug_mode)
+        print world.player.check_self(GameOptions.data['debug_mode'])
       when 'inventory', 'i'
         if param1
           world.player.inventory.describe_item(param1)
@@ -541,7 +542,7 @@ module Gemwarrior
 
     def try_to_move_player(direction)
       if world.can_move?(direction)
-        world.player.go(world.locations, direction, world.sound)
+        world.player.go(world.locations, direction, GameOptions.data['sound_enabled'], GameOptions.data['sound_volume'])
         world.location_by_coords(world.player.cur_coords).checked_for_monsters = false
         world.describe(world.location_by_coords(world.player.cur_coords))
       else
@@ -550,6 +551,13 @@ module Gemwarrior
     end
 
     def player_death_resurrection
+      Music::cue([
+        { frequencies: 'D#5', duration: 100 },
+        { frequencies: 'A4',  duration: 150 },
+        { frequencies: 'F#4', duration: 200 },
+        { frequencies: 'F4',  duration: 1000 }
+      ])
+
       puts 'Somehow, though, your adventure does not end here!'.colorize(:yellow)
       puts 'Instead, you are whisked back home via some magical force.'.colorize(:yellow)
       puts 'A bit worse for the weary and somewhat poorer, but you are ALIVE!'.colorize(:yellow)
@@ -577,7 +585,7 @@ module Gemwarrior
       end
       print_separator
 
-      if world.debug_mode
+      if GameOptions.data['debug_mode']
         puts ' DEBUG COMMANDS'
         print_separator
         i = 0
@@ -594,7 +602,7 @@ module Gemwarrior
       command = tokens[0]
       commands_and_aliases = commands | aliases | extras
 
-      if world.debug_mode
+      if GameOptions.data['debug_mode']
         commands_and_aliases = commands_and_aliases | devcommands | devaliases | devextras
       end
 

data/lib/gemwarrior/game.rb

@@ -13,6 +13,7 @@ require_relative 'world'
 require_relative 'evaluator'
 require_relative 'repl'
 require_relative 'inventory'
+require_relative 'game_options'
 
 module Gemwarrior
   class Game
@@ -29,16 +30,18 @@ module Gemwarrior
     attr_accessor :world, :evaluator, :repl
 
     def initialize(options)
+      # set game options
+      GameOptions.add 'beast_mode', options.fetch(:beast_mode)
+      GameOptions.add 'debug_mode', options.fetch(:debug_mode)
+      GameOptions.add 'god_mode', options.fetch(:god_mode)
+      GameOptions.add 'sound_enabled', options.fetch(:sound_enabled)
+      GameOptions.add 'sound_volume', options.fetch(:sound_volume)
+      GameOptions.add 'use_wordnik', options.fetch(:use_wordnik)
+      
       # create new world and player
-      self.world            = World.new
-
-      start_stats = PlayerLevels::get_level_stats(1)
+      start_stats  = PlayerLevels::get_level_stats(1)
 
-      world.debug_mode      = options.fetch(:debug_mode)
-      world.use_wordnik     = options.fetch(:use_wordnik)
-      world.sound           = options.fetch(:sound)
-      world.new_game        = options.fetch(:new_game)
-      world.extra_command   = options.fetch(:extra_command)
+      self.world   = World.new
 
       world.player = Player.new({
         description:  PLAYER_DESC_DEFAULT,
@@ -52,38 +55,27 @@ module Gemwarrior
         atk_hi:       start_stats[:atk_hi],
         defense:      start_stats[:defense],
         dexterity:    start_stats[:dexterity],
-        inventory:    world.debug_mode ? PLAYER_INVENTORY_DEBUG : PLAYER_INVENTORY_DEFAULT,
-        rox:          world.debug_mode ? PLAYER_ROX_DEBUG : PLAYER_ROX_DEFAULT,
-        cur_coords:   world.location_coords_by_name('Home'),
-
-        god_mode:     options.fetch(:god_mode),
-        beast_mode:   options.fetch(:beast_mode),
-        use_wordnik:  options.fetch(:use_wordnik)
+        inventory:    GameOptions.data['debug_mode'] ? PLAYER_INVENTORY_DEBUG : PLAYER_INVENTORY_DEFAULT,
+        rox:          GameOptions.data['debug_mode'] ? PLAYER_ROX_DEBUG : PLAYER_ROX_DEFAULT,
+        cur_coords:   world.location_coords_by_name('Home')
       })
 
       # create options file if not existing
-      update_options_file(world)
+      update_options_file
       
       # create the console
       self.evaluator  = Evaluator.new(world)
       self.repl       = Repl.new(self, world, evaluator)
 
       # enter Jool!
-      repl.start('look', world.extra_command)
-    end
-
-    def get_log_file_path
-      "#{Dir.home}/.gemwarrior_log"
-    end
-
-    def get_options_file_path
-      "#{Dir.home}/.gemwarrior_options"
+      repl.start('look', options.fetch(:extra_command),  options.fetch(:new_game))
     end
 
-    def update_options_file(world)
-      File.open(get_options_file_path, 'w') do |f|
-        f.puts "sound:#{world.sound}"
-        f.puts "use_wordnik:#{world.use_wordnik}"
+    def update_options_file
+      File.open(GameOptions.data['options_file_path'], 'w') do |f|
+        f.puts "sound_enabled:#{GameOptions.data['sound_enabled']}"
+        f.puts "sound_volume:#{GameOptions.data['sound_volume']}"
+        f.puts "use_wordnik:#{GameOptions.data['use_wordnik']}"
       end
     end
   end

data/lib/gemwarrior/game_options.rb

@@ -0,0 +1,15 @@
+# lib/gemwarrior/game_options.rb
+# Gem Warrior Global Game Options
+
+module Gemwarrior
+  module GameOptions
+    def self.add key, value
+      @@data ||= {}
+      @@data[key] = value
+    end
+
+    def self.data
+      @@data ||= {}
+    end
+  end
+end

data/lib/gemwarrior/misc/music.rb

@@ -1,48 +1,52 @@
 # lib/gemwarrior/misc/music.rb
-# Music cues using win32-sound
+# Music cues using win32-sound or feep, depending on platform
+
+require_relative '../game_options'
 
 module Gemwarrior
   module Music
     def self.cue(sequence)
-      # if Windows, use superior win32-sound library
-      if OS.windows?
-        require 'win32/sound'
-        require_relative 'musical_notes'
+      if GameOptions.data['sound_enabled']
+        # if Windows, use superior win32-sound library
+        if OS.windows?
+          require 'win32/sound'
+          require_relative 'musical_notes'
         
-        Thread.start do
-          sequence.each do |seq|
-            threads = []
-            seq[:frequencies].split(',').each do |note|
-              threads << Thread.new do
-                Win32::Sound::play_freq(Notes::NOTE_FREQ[note], seq[:duration], 0.5)
+          Thread.start do
+            sequence.each do |seq|
+              threads = []
+              seq[:frequencies].split(',').each do |note|
+                threads << Thread.new do
+                  Win32::Sound::play_freq(Notes::NOTE_FREQ[note], seq[:duration], GameOptions.data['sound_volume'])
+                end
               end
+              threads.each { |th| th.join }
             end
-            threads.each { |th| th.join }
           end
-        end
-      # otherwise, use inferior feep library
-      else
-        require 'feep'
+        # otherwise, use inferior feep library
+        else
+          require 'feep'
 
-        feep_defaults = {
-          frequencies:  '440',
-          waveform:     'sine',
-          volume:       0.3,
-          duration:     500,
-          notext:       true
-        }
+          feep_defaults = {
+            frequencies:  '440',
+            waveform:     'sine',
+            volume:       GameOptions.data['sound_volume'],
+            duration:     500,
+            notext:       true
+          }
       
-        Thread.start do
-          sequence.each do |seq|
-            seq = feep_defaults.merge(seq)
+          Thread.start do
+            sequence.each do |seq|
+              seq = feep_defaults.merge(seq)
 
-            Feep::Base.new({
-              freq_or_note: seq[:frequencies],
-              waveform:     seq[:waveform],
-              volume:       seq[:volume],
-              duration:     seq[:duration],
-              notext:       seq[:notext]
-            })
+              Feep::Base.new({
+                freq_or_note: seq[:frequencies],
+                waveform:     seq[:waveform],
+                volume:       seq[:volume],
+                duration:     seq[:duration],
+                notext:       seq[:notext]
+              })
+            end
           end
         end
       end

data/lib/gemwarrior/misc/wordlist.rb

@@ -4,6 +4,8 @@
 require 'http'
 require 'json'
 
+require_relative '../game_options'
+
 module Gemwarrior
   class WordList
     STATIC_ADJECTIVE_VALUES = [
@@ -19,10 +21,9 @@ module Gemwarrior
       'accentuate', 'accompany', 'blatter', 'bully', 'collide', 'crusade', 'disallow', 'entitle', 'infest', 'lateral', 'micturate', 'mourn', 'munge', 'numb', 'outdraw', 'overstep', 'plummet', 'refill', 'refurnish', 'reroute', 'rumple', 'scupper', 'smoosh', 'spifflicate', 'straighten', 'synthesize', 'terrorize', 'unshift', 'vociferate'
     ]
 
-    attr_accessor :use_wordnik, :type, :limit, :words, :error
+    attr_accessor :type, :limit, :words, :error
 
-    def initialize(use_wordnik = false, type = 'noun', limit = 10)
-      self.use_wordnik  = use_wordnik
+    def initialize(type = 'noun', limit = 10)
       self.type         = type
       self.limit        = limit
       self.words        = populate_words(type, limit)
@@ -45,7 +46,7 @@ module Gemwarrior
       url = 'http://api.wordnik.com:80/v4/words.json/randomWords'
       api_key = ENV['WORDNIK_API_KEY']
 
-      unless api_key.nil? || use_wordnik == false
+      unless api_key.nil? || GameOptions.data['use_wordnik'] == false
         case type
         when 'noun', 'noun-plural', 'adjective', 'verb'
         else

data/lib/gemwarrior/repl.rb

@@ -10,6 +10,7 @@ require 'github_api'
 require_relative 'misc/timer'
 require_relative 'misc/wordlist'
 require_relative 'evaluator'
+require_relative 'game_options'
 require_relative 'version'
 
 module Gemwarrior
@@ -31,15 +32,15 @@ module Gemwarrior
       self.evaluator    = evaluator
     end
 
-    def start(initial_command = nil, extra_command = nil)
-      setup_screen(initial_command, extra_command)
+    def start(initial_command, extra_command, new_game)
+      setup_screen(initial_command, extra_command, new_game)
 
       clocker = Clocker.new
 
       at_exit do
         pl = world.player
         duration = clocker.stop
-        game.update_options_file(world)
+        game.update_options_file
         log_stats(duration, pl)
       end
 
@@ -71,7 +72,7 @@ module Gemwarrior
     end
 
     def read_line
-      prompt_text = world.debug_mode ? ' GW[D]> ' : ' GW> '
+      prompt_text = GameOptions.data['debug_mode'] ? ' GW[D]> ' : ' GW> '
       Readline.readline(prompt_text, true).to_s
     end
 
@@ -83,7 +84,7 @@ module Gemwarrior
       puts '/-+-+-+ +-+-+-+-+-+-+-\\'.colorize(:yellow)
       puts '|G|E|M| |W|A|R|R|I|O|R|'.colorize(:yellow)
       puts '\\-+-+-+ +-+-+-+-+-+-+-/'.colorize(:yellow)
-      puts '[[[[[[[DEBUGGING]]]]]]]'.colorize(:white) if world.debug_mode
+      puts '[[[[[[[DEBUGGING]]]]]]]'.colorize(:white) if GameOptions.data['debug_mode']
     end
 
     def print_splash_message
@@ -95,9 +96,9 @@ module Gemwarrior
     end
 
     def print_fortune
-      noun1_values = WordList.new(world.use_wordnik, 'noun-plural')
-      noun2_values = WordList.new(world.use_wordnik, 'noun-plural')
-      noun3_values = WordList.new(world.use_wordnik, 'noun-plural')
+      noun1_values = WordList.new('noun-plural')
+      noun2_values = WordList.new('noun-plural')
+      noun3_values = WordList.new('noun-plural')
 
       puts "* Remember: #{noun1_values.get_random_value} and #{noun2_values.get_random_value} are the key to #{noun3_values.get_random_value} *\n\n"
       puts
@@ -123,25 +124,37 @@ module Gemwarrior
       puts
       puts 'Gem Warrior Options'.colorize(:yellow)
       puts '======================='.colorize(:yellow)
-      puts 'Toggle whether sound is played, or Wordnik (system must have a working WORDNIK_API_KEY environment variable) is used to generate more dynamic descriptors of entities'
+      puts 'Toggle whether sound is played, what the game\'s volume is, or whether Wordnik is used to generate more dynamic descriptors of entities (valid WORDNIK_API_KEY environment variable must be set)'
       puts
-      puts " (1) SOUND ENABLED: #{world.sound}"
-      puts " (2) USE WORDNIK  : #{world.use_wordnik}"
+      puts " (1) SOUND ENABLED : #{GameOptions.data['sound_enabled']}"
+      puts " (2) SOUND VOLUME  : #{GameOptions.data['sound_volume']}"
+      puts " (3) USE WORDNIK   : #{GameOptions.data['use_wordnik']}"
       puts
       puts '======================='
       puts
-      puts 'Enter option number to toggle value, or any other key to return to main menu.'
+      puts 'Enter option number to change value, or any other key to return to main menu.'
       print 'Option? '
       answer = STDIN.getch
 
       case answer
       when '1'
         print answer
-        world.sound = !world.sound
+        GameOptions.data['sound_enabled'] = !GameOptions.data['sound_enabled']
         print_options
       when '2'
         print answer
-        world.use_wordnik = !world.use_wordnik
+        print "\n"
+        print 'Enter a volume from 0.0 to 1.0: '
+        new_vol = gets.chomp.to_f.abs
+        if new_vol >= 0.0 and new_vol <= 1.0
+          GameOptions.data['sound_volume'] = new_vol
+        else
+          puts 'Not a valid volume.'
+        end
+        print_options
+      when '3'
+        print answer
+        GameOptions.data['use_wordnik']= !GameOptions.data['use_wordnik']
         print_options
       else
         print answer
@@ -150,8 +163,8 @@ module Gemwarrior
     end
 
     def display_log
-      if File.exist?(game.get_log_file_path)
-        File.open(game.get_log_file_path).readlines.each do |line|
+      if File.exist?(GameOptions.data['log_file_path'])
+        File.open(GameOptions.data['log_file_path']).readlines.each do |line|
           print "#{line}"
         end
         puts
@@ -232,7 +245,7 @@ module Gemwarrior
       when 'e', 'x'
         puts choice
         puts MAIN_MENU_QUIT_MESSAGE
-        game.update_options_file(world)
+        game.update_options_file
         exit
       else
         run_main_menu(show_choices = false)
@@ -258,27 +271,25 @@ module Gemwarrior
       puts '######################################################################'
 
       # log stats to file in home directory
-      File.open(game.get_log_file_path, 'a') do |f|
+      File.open(GameOptions.data['log_file_path'], 'a') do |f|
         f.write "#{Time.now} #{pl.name.rjust(10)} - V:#{Gemwarrior::VERSION} LV:#{pl.level} XP:#{pl.xp} $:#{pl.rox} KIL:#{pl.monsters_killed} ITM:#{pl.items_taken} MOV:#{pl.movements_made} RST:#{pl.rests_taken} DTH:#{pl.deaths}\n"
       end
     end
 
     def play_intro_tune
-      if world.sound
-        Music::cue([
-          { frequencies: 'A3,E4,C#5,E5',  duration: 300 },
-          { frequencies: 'A3,E4,C#5,F#5', duration: 600 }
-        ])
-      end
+      Music::cue([
+        { frequencies: 'A3,E4,C#5,E5',  duration: 300 },
+        { frequencies: 'A3,E4,C#5,F#5', duration: 600 }
+      ])
     end
 
-    def setup_screen(initial_command = nil, extra_command = nil)
+    def setup_screen(initial_command = nil, extra_command = nil, new_game = false)
       # welcome player to game
       clear_screen
       print_logo
 
       # main menu loop until new game or exit
-      if world.new_game
+      if new_game
         play_intro_tune
         print_splash_message
         print_fortune
@@ -293,7 +304,7 @@ module Gemwarrior
 
     def prompt
       prompt_template = "\n[LV:%2s][XP:%3s][ROX:%3s] [HP:%3s/%-3s][STM:%2s/%-2s] [%s @ %s]"
-      if world.debug_mode
+      if GameOptions.data['debug_mode']
         prompt_template += "[%s, %s, %s]"
       end
       prompt_vars_arr = [
@@ -307,7 +318,7 @@ module Gemwarrior
         world.player.name,
         world.location_by_coords(world.player.cur_coords).name
       ]
-      if world.debug_mode
+      if GameOptions.data['debug_mode']
         prompt_vars_arr.push(world.player.cur_coords[:x], world.player.cur_coords[:y], world.player.cur_coords[:z])
       end
       print (prompt_template % prompt_vars_arr).colorize(:yellow)

data/lib/gemwarrior/version.rb

@@ -1,6 +1,6 @@
-# lib/gemwarrior/misc/version.rb
+# lib/gemwarrior/version.rb
 # Version of Gem Warrior
 
 module Gemwarrior
-  VERSION = '0.9.34'
+  VERSION = '0.9.35'
 end

data/lib/gemwarrior/world.rb

@@ -3,6 +3,7 @@
 
 require 'yaml'
 
+require_relative 'game_options'
 require_relative 'entities/item'
 require_relative 'entities/location'
 
@@ -17,8 +18,7 @@ module Gemwarrior
     ERROR_LIST_PARAM_INVALID = 'That is not something that can be listed.'
     ERROR_LOCATION_DESCRIBE_ENTITY_INVALID  = 'You do not see that here.'
 
-    attr_accessor :monsters, :locations, :player,
-                  :debug_mode, :use_wordnik, :sound, :new_game, :extra_command
+    attr_accessor :monsters, :locations, :player
 
     def initialize
       self.monsters   = init_monsters
@@ -69,7 +69,7 @@ module Gemwarrior
       0.upto(WORLD_DIM_WIDTH - 1) do |count_x|
         print "#{count_x}  "
       end
-      if debug_mode
+      if GameOptions.data['debug_mode']
         puts
         puts
         puts "Current level: #{player.cur_coords[:z]}"
@@ -116,7 +116,7 @@ module Gemwarrior
       when 'locations'
         puts "[LOCATIONS](#{locations.length})".colorize(:yellow)
         if details
-          locations.map { |l| print l.status(self.debug_mode) }
+          locations.map { |l| print l.status }
           return
         else
           ">> #{locations.map(&:name).join(', ')}"
@@ -148,7 +148,7 @@ module Gemwarrior
       desc_text = ''
       desc_text << "[>>> #{point.name.upcase} <<<]".colorize(:cyan)
 
-      if debug_mode
+      if GameOptions.data['debug_mode']
         desc_text << " DL[#{point.danger_level.to_s}] MLR[#{point.monster_level_range.to_s}]".colorize(:yellow)
       end
 
@@ -162,7 +162,7 @@ module Gemwarrior
       desc_text << "\n >> Thing(s):   #{point.list_items.join(', ')}".colorize(:white) unless point.list_items.empty?
       desc_text << "\n >> Path(s):    #{point.list_paths.join(', ')}".colorize(:white)
 
-      if debug_mode
+      if GameOptions.data['debug_mode']
         desc_text << "\n >>> Actionable words: "
         desc_text << point.list_actionable_words.colorize(:white)
       end
@@ -176,7 +176,7 @@ module Gemwarrior
       if point.has_item?(entity_name)
         point.items.each do |i|
           if i.name.downcase.eql?(entity_name)
-            if debug_mode
+            if GameOptions.data['debug_mode']
               return i.describe
             else
               return i.description
@@ -186,7 +186,7 @@ module Gemwarrior
       elsif point.has_monster?(entity_name)
         point.monsters_abounding.each do |m|
           if m.name.downcase.eql?(entity_name)
-            if debug_mode
+            if GameOptions.data['debug_mode']
               return m.describe
             else
               return m.description
@@ -196,7 +196,7 @@ module Gemwarrior
       elsif point.has_boss?(entity_name)
         point.bosses_abounding.each do |b|
           if b.name.downcase.eql?(entity_name)
-            if debug_mode
+            if GameOptions.data['debug_mode']
               return b.describe
             else
               return b.description

data/spec/gemwarrior_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Gemwarrior do
+  it 'has a version number' do
+    expect(Gemwarrior::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -1,2 +1,3 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'rubywarrior'
+require 'pry'
+require 'gemwarrior'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gemwarrior
 version: !ruby/object:Gem::Version
-  version: 0.9.34
+  version: 0.9.35
 platform: ruby
 authors:
 - Michael Chadwick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-12 00:00:00.000000000 Z
+date: 2015-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -143,75 +143,159 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.12.4
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.29'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.29'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.29'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.29'
+        version: '3.0'
 description: A fun text adventure in the form of a RubyGem!
 email: mike@codana.me
 executables:
@@ -288,6 +372,7 @@ files:
 - lib/gemwarrior/entities/player.rb
 - lib/gemwarrior/evaluator.rb
 - lib/gemwarrior/game.rb
+- lib/gemwarrior/game_options.rb
 - lib/gemwarrior/inventory.rb
 - lib/gemwarrior/misc/animation.rb
 - lib/gemwarrior/misc/formatting.rb
@@ -300,7 +385,7 @@ files:
 - lib/gemwarrior/repl.rb
 - lib/gemwarrior/version.rb
 - lib/gemwarrior/world.rb
-- spec/rubywarrior_spec.rb
+- spec/gemwarrior_spec.rb
 - spec/spec_helper.rb
 homepage: http://rubygems.org/gems/gemwarrior
 licenses:
@@ -326,4 +411,6 @@ rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: RubyGem text adventure
-test_files: []
+test_files:
+- spec/gemwarrior_spec.rb
+- spec/spec_helper.rb

data/spec/rubywarrior_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-describe Rubywarrior do
-  it 'has a version number' do
-    expect(Rubywarrior::VERSION).not_to be nil
-  end
-
-  it 'does something useful' do
-    expect(false).to eq(true)
-  end
-end