smash_and_grab 0.0.3alpha → 0.0.5alpha

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smash_and_grab (0.0.3alpha)
+    smash_and_grab (0.0.5alpha)
       chingu (~> 0.9rc7)
       fidgit (~> 0.1.10)
       gosu (~> 0.7.41)

data/README.md

@@ -7,29 +7,29 @@ Smash and Grab
 Description
 -----------
 
-_Smash and Grab!_ is a retro isometric supervillainous turn-based hiest game.
+_Smash and Grab!_ is a retro isometric, super-villainous, turn-based heist game.
 
 Requirements
 ------------
 
 ### Windows
 
-If running <tt>smash_and_grab.exe</tt>, there are no other requirements.
+If running `smash_and_grab.exe`, there are no other requirements.
 
 ### OS X
 
-If running OS X, use the executable (<tt>SmashAndGrab.app</tt>), which has no dependencies.
+If running OS X, use the executable (`SmashAndGrab.app`), which has no dependencies.
 
 ### Source for Linux (or Windows/OS X if not using the executable)
 
-If running from source, users must install the Ruby interpreter and some rubygems. Linux users must also install some "extra dependencies](https://github.com/jlnr/gosu/wiki/Getting-Started-on-Linux for Gosu.
+If running from source, users must install the Ruby interpreter and some rubygems. Linux users must also install some [extra dependencies](https://github.com/jlnr/gosu/wiki/Getting-Started-on-Linux) for Gosu.
 
 #### Dependencies
 
 * Ruby 1.9.2 (Install via package manager or rvm). Ruby 1.9.3 recommended though, since loading is significantly faster.
-** Gosu gem 0.7.32 (Dependencies: "Linux only](https://github.com/jlnr/gosu/wiki/Getting-Started-on-Linux)
-** A number of other rubygems, which can be installed automatically using Bundler (see below).
-** Linux Only: <tt>xsel</tt> or <tt>xcopy</tt> command to allow access to the system clipboard:
+* Gosu gem 0.7.32 - Dependencies: [Linux only](https://github.com/jlnr/gosu/wiki/Getting-Started-on-Linux)
+* A number of other rubygems, which can be installed automatically using Bundler (see below).
+* Linux Only: <tt>xsel</tt> or <tt>xcopy</tt> command to allow access to the system clipboard:
 <pre>    sudo apt-get install xsel</pre>
 
 #### Using Bundler to install gems
@@ -61,22 +61,37 @@ Move your supervillains around until you win!
 
 ### Implemented game features
 
+* Your Villains can:
+    - move around.
+    - melee with enemies (Goodies or Bystanders).
+    - sprint to get extra movement (sacrificing all actions for that turn).
+    - get reactive melee attacks from ZoC.
+
+* Zones of Control:
+    - Enemies project a ZoC into adjacent tiles IF they have enough actions left to melee.
+    - Entering or leaving a ZoC triggers a melee attack, which will occur before the mover can attack!
+
+* Goodies will:
+    - attack if they can or wander aimlessly in their turn.
+    - Get reactive melee attacks from ZoC.
+
+* Bystanders will wander aimlessly in their turn.
+
 * Scroll map with keyboard arrows; zoom with mouse wheel.
-* Your Villains can move around.
-* Your Villains can melee with enemies (Goodies or Bystanders).
-* You can activate _Sprint_ ability to give a Villain extra movement (sacrificing all actions for that turn).
-* Goodies and Bystanders will take a turn (very trivial AI) when you end yours.
-* Editor works, but some bugs with placing Vehicles over other objects.
 * Saving/loading (F5/F6) of state in Editor & Game.
 * Undo/Redo (Ctrl-Z/Ctrl-Shift-Z)support in both Editor and Game (can't take back attacks though, since they are non-deterministic).
 
+### Implemented editor features
+
+* Editor works, but some bugs with placing Vehicles where there are existing objects.
+
 ### Saved data
 
 Save games and configuration are saved into (Windows):
 
     C:\Users\<your-username>\AppData\Roaming\Smash And Grab\
 
-or (OS X / Linux)
+or (OS X / Linux):
 
     /home/<your-username>/.smash_and_grab/
 
@@ -91,12 +106,12 @@ Many thanks to:
 Third party tools and assets used
 ---------------------------------
 
-* Original music by [Maverick (Brian Peppers)](http://polyhedricpeppers.weebly.com/). [![http://i.creativecommons.org/l/by-sa/3.0/88x31.png](CC BY-SA)](http://creativecommons.org/licenses/by-sa/3.0/)
+* Original music by [Maverick (Brian Peppers)](http://polyhedricpeppers.weebly.com/). [![CC BY-SA](http://i.creativecommons.org/l/by-sa/3.0/88x31.png)](http://creativecommons.org/licenses/by-sa/3.0/)
 * Original sprites created with [GIMP](http://www.gimp.org/) and Graphics Gale [Free Edition]
-* Sound effects created using [bfxr](http://www.bfxr.net/) and converted using [Audacity](http://audacity.sourceforge.net/
+* Sound effects created using [bfxr](http://www.bfxr.net/) and converted using [Audacity](http://audacity.sourceforge.net/)
 * [Unmasked font](http://www.blambot.com/font_unmasked.shtml) by "Nate Piekos" [Free for personal use]
 * [Gosu](http://libgosu.org/) game development library
 * [Chingu](http://ippa.se/chingu) game library (extending Gosu)
 * [Fidgit](https://github.com/Spooner/fidgit) gui library (extending Chingu)
-* [Texplay](http://banisterfiend.wordpress.com/2008/08/23/texplay-an-image-manipulation-tool-for-ruby-and-gosu/ image manipulation library for Gosu.
+* [Texplay](http://banisterfiend.wordpress.com/2008/08/23/texplay-an-image-manipulation-tool-for-ruby-and-gosu/) image manipulation library for Gosu.
 * [R18n](http://r18n.rubyforge.org/) i18n library

data/config/gui/schema.yml

@@ -54,8 +54,9 @@
     :background_color: ?very_dark_blue
     
   :ScrollBar: # < Composite
-    :rail_width: 20
+    :rail_width: 14
     
   :ScrollWindow: # < Composite
-    :scroll_bar_thickness: 20
+    :scroll_bar_thickness: 14
+    :border_color: ?dark_blue
 

data/config/map/entities.yml

@@ -16,12 +16,12 @@
   :abilities:
     -
       :type: :melee
-      :skill: 4
+      :skill: 3
     -
       :type: :ranged
-      :skill: 1
-      :range: 3
-      :action_cost: 2
+      :skill: 2
+      :min_range: 2
+      :max_range: 5
     -
       :type: :sprint
       :skill: 4
@@ -56,12 +56,12 @@
   :faction: :baddies
   :spritesheet_position: [1, 4]
   :movement_points: 8
-  :action_points: 3
+  :action_points: 2
   :health: 15
   :abilities:
     -
       :type: :melee
-      :skill: 5
+      :skill: 4
     -
       :type: :sprint
       :skill: 1
@@ -70,13 +70,12 @@
   :faction: :baddies
   :spritesheet_position: [0, 4]
   :movement_points: 5
-  :action_points: 3
+  :action_points: 1
   :health: 10
   :abilities:
     -
       :type: :melee
-      :skill: 4
-      :action_cost: 1
+      :skill: 5
     -
       :type: :sprint
       :skill: 1
@@ -99,7 +98,7 @@
   :faction: :baddies
   :spritesheet_position: [7, 4]
   :movement_points: 7
-  :action_points: 1
+  :action_points: 2
   :health: 10
   :abilities:
     -
@@ -139,6 +138,11 @@
     -
       :type: :melee
       :skill: 1
+    -
+      :type: :ranged
+      :skill: 2
+      :min_range: 2
+      :max_range: 6
     -
       :type: :sprint
       :skill: 2
@@ -153,6 +157,11 @@
     -
       :type: :melee
       :skill: 2
+    -
+      :type: :ranged
+      :skill: 2
+      :min_range: 2
+      :max_range: 8
     -
       :type: :sprint
       :skill: 2
@@ -167,6 +176,11 @@
     -
       :type: :melee
       :skill: 2
+    -
+      :type: :ranged
+      :skill: 2
+      :min_range: 2
+      :max_range: 8
     -
       :type: :sprint
       :skill: 2
@@ -181,6 +195,11 @@
     -
       :type: :melee
       :skill: 1
+    -
+      :type: :ranged
+      :skill: 3
+      :min_range: 3
+      :max_range: 9
     -
       :type: :sprint
       :skill: 2
@@ -195,6 +214,11 @@
     -
       :type: :melee
       :skill: 1
+    -
+      :type: :ranged
+      :skill: 4
+      :min_range: 4
+      :max_range: 8
 
 # - Superheroes -
 
@@ -272,7 +296,7 @@
   :faction: :goodies
   :spritesheet_position: [3, 1]
   :movement_points: 8
-  :action_points: 3
+  :action_points: 2
   :health: 15
   :abilities:
     -
@@ -305,7 +329,7 @@
   :abilities:
     -
       :type: :melee
-      :skill: 5
+      :skill: 4
     -
       :type: :sprint
       :skill: 2

data/lib/smash_and_grab/abilities/ability.rb

@@ -2,11 +2,16 @@ module SmashAndGrab::Abilities
   # @abstract
   class Ability
     attr_reader :skill, :owner
+    SKILL_LEVEL_DESCRIPTIONS = %w[Fair Good Excellent Heroic Legendary]
 
     def can_be_undone?; true; end
     def action_cost; @action_cost == :all ? owner.max_action_points : @action_cost; end
     def type; Inflector.underscore(Inflector.demodulize(self.class.name)).to_sym; end
 
+    def tip
+      "#{SKILL_LEVEL_DESCRIPTIONS[skill - 1]} #{type.capitalize} (#{'*' * skill})"
+    end
+
     protected
     def initialize(owner, data)
       @owner = owner

data/lib/smash_and_grab/abilities/melee.rb

@@ -7,16 +7,22 @@ module SmashAndGrab::Abilities
 
     def target_valid?(tile); tile.object.is_a?(Objects::Entity) and tile.object.enemy?(owner); end
 
+    def tip
+      "#{super} attack in hand-to-hand combat"
+    end
+
     def initialize(owner, data)
       super(owner, data.merge(action_cost: 1))
     end
 
-    def action_data(target_tile)
-      super(target_tile).merge(
+    def action_data(target)
+      super(target.tile).merge(
           damage: random_damage
       )
     end
 
+    def target(data); owner.map.object_by_id(data[:target_id]); end
+
     def random_damage
       # 1..skill as damage in a bell-ish curve.
       (skill - 1).times.find_all { rand(2) == 1 }.size + 1
@@ -25,13 +31,13 @@ module SmashAndGrab::Abilities
     def do(data)
       super(data)
 
-      owner.map.object_by_id(data[:target_id]).health -= data[:damage]
+      owner.melee(target(data), data[:damage])
     end
 
     def undo(data)
-      target = owner.map.object_by_id(data[:target_id])
-      target.health += data[:damage]
+      target = target(data)
       target.tile = owner.map.tile_at_grid(data[:target_position]) unless target.tile
+      owner.melee(target(data), -data[:damage])
 
       super(data)
     end

data/lib/smash_and_grab/abilities/ranged.rb

@@ -2,10 +2,30 @@ require_relative "ability"
 
 module SmashAndGrab::Abilities
   class Ranged < TargetedAbility
+    attr_reader :min_range, :max_range
+
     def can_undo?; false; end
 
+    # TODO: Take into account min/max range and LOS.
     def target_valid?(tile); !!(tile.object.is_a?(Objects::Entity) and tile.object.enemy?(owner)); end
 
+    def initialize(owner, data)
+      super(owner, data.merge(action_cost: 1))
+      @max_range = data[:max_range] || raise(ArgumentError, "no :max_range specified")
+      @min_range = data[:min_range] || raise(ArgumentError, "no :min_range specified")
+    end
+
+    def tip
+      "#{super} attack in ranged combat, at range #{min_range}..#{max_range}"
+    end
+
+    def to_json(*args)
+      super.merge(
+          min_range: @min_range,
+          max_range: @max_range,
+      ).to_json(*args)
+    end
+
     def action_data(target_tile)
       super(target_tile).merge!(
           damage: random_damage

data/lib/smash_and_grab/abilities/sprint.rb

@@ -21,6 +21,10 @@ module SmashAndGrab::Abilities
       [bonus.floor, 1].max
     end
 
+    def tip
+      "#{super} gain #{movement_bonus} movement points at cost of all actions"
+    end
+
     def action_data
       super().merge(
           movement_bonus: movement_bonus

data/lib/smash_and_grab/abilities.rb

@@ -4,7 +4,9 @@ module SmashAndGrab::Abilities
   # Create an ability based on class name.
   # @param owner [Entity]
   # @option data :type [String] underscored name of Ability to create.
-  def self.ability(owner, data); const_get(Inflector.camelize data[:type]).new(owner, data); end
+  class << self
+    def ability(owner, data); const_get(Inflector.camelize data[:type]).new(owner, data); end
+  end
 end
 
 

data/lib/smash_and_grab/fidgit_ext/event.rb

@@ -0,0 +1,77 @@
+module Fidgit
+  module Event
+    # Returned by {#subscribe} and can be used to {#unsubscribe}
+    class Subscription
+      attr_reader :publisher, :event, :handler
+
+      def initialize(publisher, event, handler)
+        @publisher, @event, @handler = publisher, event, handler
+      end
+
+      def unsubscribe
+        @publisher.unsubscribe self
+      end
+    end
+
+    class << self
+      def new_event_handlers
+        # Don't use Set, since it is not guaranteed to be ordered.
+        Hash.new {|h, k| h[k] = [] }
+      end
+    end
+
+    # @return [Subscription] Definition of this the handler created by this subscription, to be used with {#unsubscribe}
+    def subscribe(event, method = nil, &block)
+      raise ArgumentError, "Expected method or block for event handler" unless !block.nil? ^ !method.nil?
+      raise ArgumentError, "#{self.class} does not handle #{event.inspect}" unless events.include? event
+
+      @_event_handlers ||= Event.new_event_handlers
+      handler = method || block
+      @_event_handlers[event] << handler
+
+      Subscription.new self, event, handler
+    end
+
+    # @overload unsubscribe(subscription)
+    #   Unsubscribe from a #{Subscription}, as returned from {#subscribe}
+    #   @param subscription [Subscription]
+    #   @return [Boolean] true if the handler was able to be deleted.
+    #
+    # @overload unsubscribe(handler)
+    #   Unsubscribe from first event this handler has been used to subscribe to..
+    #   @param handler [Block, Method] Event handler used.
+    #   @return [Boolean] true if the handler was able to be deleted.
+    #
+    # @overload unsubscribe(event, handler)
+    #   Unsubscribe from specific handler on particular event.
+    #   @param event [Symbol] Name of event originally subscribed to.
+    #   @param handler [Block, Method] Event handler used.
+    #   @return [Boolean] true if the handler was able to be deleted.
+    #
+    def unsubscribe(*args)
+      @_event_handlers ||= Event.new_event_handlers
+
+      case args.size
+        when 1
+          case args.first
+            when Subscription
+              # Delete specific event handler.
+              subscription = args.first
+              raise ArgumentError, "Incorrect publisher for #{Subscription}: #{subscription.publisher}" unless subscription.publisher == self
+              unsubscribe subscription.event, subscription.handler
+            when Block, Method
+              # Delete first events that use the handler.
+              handler = args.first
+              !!@_event_handlers.find {|_, handlers| handlers.delete handler }
+            else
+              raise TypeError, "handler must be a #{Subscription}, Block or Method: #{args.first}"
+          end
+        when 2
+          event, handler = args
+          !!@_event_handlers[event].delete(handler)
+        else
+          raise ArgumentError, "Requires 1..2 arguments, but received #{args.size} arguments"
+      end
+    end
+  end
+end

data/lib/smash_and_grab/gui/editor_selector.rb

@@ -1,7 +1,35 @@
 module SmashAndGrab
 module Gui
 class EditorSelector < Fidgit::Vertical
-  OBJECT_TABS = [:tiles, :walls, :objects, :entities, :vehicles]
+  OBJECT_TYPES = {
+      tiles: {
+          type: Tile,
+          num_columns: 2,
+          factor: 2,
+      },
+      walls: {
+          type: Wall,
+          num_columns: 3,
+          factor: 1,
+      },
+      objects: {
+          type: Objects::Static,
+          num_columns: 2,
+          factor: 1,
+      },
+      entities: {
+          type: Objects::Entity,
+          num_columns: 2,
+          factor: 1,
+      },
+      vehicles: {
+          type: Objects::Vehicle,
+          num_columns: 1,
+          factor: 0.5,
+      },
+  }
+
+  OBJECT_TABS = OBJECT_TYPES.keys
 
   def tab; @tabs_group.value; end
   def tab=(tab); @tabs_group.value = tab; end
@@ -33,7 +61,7 @@ class EditorSelector < Fidgit::Vertical
           scroll_options = { width: 200, height: 540 }
 
           @tab_windows[value] ||= Fidgit::ScrollWindow.new scroll_options do
-            send("#{value}_window")
+            list_window value
           end
 
           @selector_window = @tab_windows[value]
@@ -83,91 +111,44 @@ class EditorSelector < Fidgit::Vertical
     end
   end
 
-  protected
-  def tiles_window
-    buttons = group do
-      vertical padding: 1 do
-        radio_button 'Erase', :none
-        grid padding: 0, num_columns: 2 do
-          Tile.config.each_pair.sort.each do |type, data|
-            next if type == :none
-            radio_button '', type, icon: Tile.sprites[*data[:spritesheet_position]],
-                         tip: "Tile: #{type}", padding: 0, icon_options: { factor: 2 }
-          end
-        end
-      end
+  public
+  def icon_for(type, list_type = tab)
+    if type == :erase or type == :none
+      nil
+    else
+      klass = OBJECT_TYPES[list_type][:type]
+      spritesheet_position = if list_type == :walls
+                               klass.config[type][:spritesheet_positions][:vertical]
+                             else
+                               klass.config[type][:spritesheet_position]
+                             end
+
+      klass.sprites[*spritesheet_position]
     end
-
-    buttons.value = :none
   end
 
   protected
-  def entities_window
-    buttons = group do
-      vertical padding: 1 do
-        radio_button 'Erase', :erase
-        grid padding: 0, num_columns: 2 do
-          Objects::Entity.config.each_pair.sort.each do |type, data|
-            radio_button '', type, icon: Objects::Entity.sprites[*data[:spritesheet_position]],
-                         tip: "Entity: #{type} (#{data[:faction]})", padding: 0
-          end
-        end
-      end
-    end
+  def list_window(list_type)
+    erase_name = (list_type == :walls) ? :none : :erase
 
-    buttons.value = :erase
-  end
-
-  protected
-  def objects_window
     buttons = group do
       vertical padding: 1 do
-        radio_button 'Erase', :erase
-        grid padding: 0, num_columns: 2 do
-          Objects::Static.config.each_pair.sort.each do |type, data|
-            radio_button '', type, icon: Objects::Static.sprites[*data[:spritesheet_position]],
-                         tip: "Object: #{type}", padding: 0
-          end
-        end
-      end
-    end
+        radio_button 'Erase', erase_name
 
-    buttons.value = :erase
-  end
+        grid padding: 0, num_columns: OBJECT_TYPES[list_type][:num_columns] do
+          OBJECT_TYPES[list_type][:type].config.each_pair.sort.each do |type, config|
+            icon = icon_for(type, list_type)
+            next unless icon
 
-  protected
-  def vehicles_window
-    buttons = group do
-      vertical padding: 1 do
-        radio_button 'Erase', :erase
-        grid padding: 0, num_columns: 1 do
-          Objects::Vehicle.config.each_pair.sort.each do |type, data|
-            radio_button '', type, icon: Objects::Vehicle.sprites[*data[:spritesheet_position]],
-                         tip: "Vehicle: #{type}", padding: 0, icon_options: { factor: 0.5 }
-          end
-        end
-      end
-    end
-
-    buttons.value = :erase
-  end
-
-  protected
-  def walls_window
-    buttons = group do
-      vertical padding: 1 do
-        radio_button 'Erase', :none
-        grid padding: 0, num_columns: 3 do
-          Wall.config.each_pair.sort.each do |type, data|
-            next if type == :none
-            radio_button '', type, icon: Wall.sprites[*(data[:spritesheet_positions][:vertical])],
-                         tip: "Wall: #{type}", padding: 0
+            radio_button '', type, icon: icon, padding: 0,
+                         icon_options: { factor: OBJECT_TYPES[list_type][:factor]  },
+                         tip: "#{list_type.capitalize}: #{type} #{list_type == :entities ? "(#{config[:faction]})" : ''}"
           end
         end
       end
     end
 
-    buttons.value = :none
+    buttons.value = erase_name
   end
 end
 end