rmagick-sprite 0.0.6 → 0.0.7

data/README.md

@@ -1,13 +1,39 @@
 # RMagick-Sprite
 
+## Description
+
+`rmagick-sprite` allows you to easily slice up a spritesheet into `Magick::Image` instances. 
+
+The thought is that a spreadsheet contains many of a character's actions (standing, walking, jumping, etc..) which 
+consist of many frames.
+
+This gem provides a DSL for defining those actions and the size/location of each frame on the spritesheet.
+
+Then, you are free to use these images in your favorite game library, save each frame as separate images, or 
+even save each action as an animated GIF.
+
+## Install
+
+### Bundler: `gem 'rmagick-sprite'`
+
+### RubyGems: `gem install rmagick-sprite`
+
 ## Example
 
+### Example Spritesheet
+<hr/ >
+
 In this example, I have one character printed on one spritesheet with only one line of 
 evenly spaced/sized sprites.
 
 Here it is: ![Example Spritesheet](http://f.cl.ly/items/1h1T292v2F3N2f1D3c1b/0.png)
 
+### Declaration
+<hr/ >
+
 ```ruby
+require 'rmagick-sprite'
+
 sprite = Sprite.new do
   filename 'foo/bar/character_spritesheet.png'
   
@@ -21,7 +47,7 @@ sprite = Sprite.new do
     frame x: 16 * 1 # Frame 1
     # x: 0, y: 0 is the top-left corner..
     # I'm lazy, so I'm just taking the default_frame_options width and multiplying it by the 
-    # frame index to calculate the x coordinate.
+    # frame's offset to calculate the x coordinate.
   end
   
   walking do
@@ -38,27 +64,43 @@ sprite = Sprite.new do
     frame x: 16 * 4 # Frame 4
   end
 end
+```
 
-# Standing only has one frame so next_image will loop over the same frame
-p sprite.next_image # => Second Image (Magick::Image) same as: sprite.next_frame.image
+### Enumeration
+<hr/ >
+
+```ruby
+# The :standing action only has one frame, so next_image will loop over the same frame on each call
+p sprite.next_image # => Second Image (Magick::Image) - Note that this is the same as: sprite.next_frame.image
 p sprite.next_image # => Second Image
 
 sprite.action = :walking
 
-# Here, we loop through the walking animation.. pump these images right into Gosu or your favorite gaming library
-p sprite.next_image # => First Image
-p sprite.next_image # => Second Image
-p sprite.next_image # => Third Image
-p sprite.next_image # => Second Image
-p sprite.next_image # => First Image
+# Here, we loop through the :walking animation.. pump these images right into Gosu or your favorite gaming library
+p sprite.next_image # => Image 3 - Frame 1
+p sprite.next_image # => Image 4 - Frame 2
+p sprite.next_image # => Image 5 - Frame 3
+p sprite.next_image # => Image 4 - Frame 4
+p sprite.next_image # => Image 3 - Frame 1
+```
+
+### Saving Frames and Actions
+<hr/ >
 
-# Save each action's frame as a separate image
+#### Save each action's frame as a separate image
+
+```ruby
 sprite.actions.each do |action_name, action|
   action.frames.each_with_index do |frame, index|
     frame.image.write "foo/bar/#{action_name}_#{index}.png"
   end
 end
+```
 
-# Saving an action as a gif (note: looks wonky with transparent backgrounds)
+#### Saving an action as a gif 
+
+> Note: This looks a bit wonky with transparent backgrounds.
+
+```ruby
 sprite.actions[:running].write 'foo/bar/running.gif'
 ```

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/lib/rmagick-sprite.rb

@@ -65,13 +65,13 @@ class Sprite
   end
   
   def action
-    @action ||= @actions[@default_action]
+    @action ||= @actions[@default_action || :default]
   end
   
   def add_action(name, options={}, &blk)
     raise 'options must be a Hash' unless options.respond_to?(:to_hash) || options.respond_to?(:to_h)
     options = options.to_hash rescue options.to_h
-    options = { sprite: self }.merge(@default_action_options).merge(options)
+    options = { sprite: self, name: name }.merge(@default_action_options).merge(options)
       
     @actions[name] = Action.new(options, &blk)
   end

data/lib/rmagick-sprite/action.rb

@@ -7,17 +7,18 @@ class Sprite
       end
     end
     
-    attr_reader :sprite, :frames
+    attr_reader :sprite, :frames, :name
     attr_accessor :current_index
     
     def initialize(options, &blk)
       raise 'options must be a Hash' unless options.respond_to?(:to_hash) || options.respond_to?(:to_h)
       options = options.to_hash rescue options.to_h
       
+      raise 'options[:name] must be given' if options[:name].nil?
       raise 'options[:sprite] must be given' if options[:sprite].nil?
       raise 'options[:sprite] must be a Sprite' unless options[:sprite].instance_of?(Sprite)
       
-      @sprite = options[:sprite]
+      @sprite, @name = options.values_at(:sprite, :name)
       @current_index, @frames = 0, []
       
       DSL.call(self, &blk)

data/rmagick-sprite.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rmagick-sprite"
-  s.version = "0.0.6"
+  s.version = "0.0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Scott Lewis"]
-  s.date = "2012-11-05"
+  s.date = "2012-11-14"
   s.description = "Encapsulates a \"Sprite\" in RMagick."
   s.email = "ryan@rynet.us"
   s.files = [".gitignore", ".rvmrc", "Gemfile", "Gemfile.lock", "README.md", "Rakefile", "VERSION", "lib/rmagick-sprite.rb", "lib/rmagick-sprite/action.rb", "lib/rmagick-sprite/frame.rb", "rmagick-sprite.gemspec"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rmagick-sprite
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-05 00:00:00.000000000 Z
+date: 2012-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
@@ -90,7 +90,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3528737833198202252
+      hash: 2005499775495730886
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: