aniruby 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b0e843e0f081ca0cc57e4e28ed4b37f43574d7d4b50220d608879357f322d44
-  data.tar.gz: e284a38f220483bd15cae1a0ed61f6615296d8b4257838266013d9214bfd327c
+  metadata.gz: 361fe4d0f4dddeca7090d35a7bb225440fd51c94c69d5b7ea0a0be8826437340
+  data.tar.gz: afb5d871c301e09df8559cd66e2609c408e810f9f3d48e68adaf851569f19a4b
 SHA512:
-  metadata.gz: e3339f0a1560b4b77adf2b1dadf574d88f80d8315e71c0a1e7d886e94da3ada92968486dfdb48ef06fba66fa572f9f8f1fb95ace2669afba150c233e4cda780a
-  data.tar.gz: 42308936cde744c37f56af5c1fe03e244f0d13634ebf52dd194408603531108e5cf4d804b0da6432f7fe7f3b2a81c02ec27ac4036b0dc51af88c75594d458078
+  metadata.gz: 9a1d8d7b7c1fabdde8b84c68199463af199ed6bfdf7e5f7e7b684f5fc5a9abba315095655bb22904be5eb29c61877c4ae6f5f348a29971b2103e739506a6950f
+  data.tar.gz: d79b9b2f63047cad421027880c40723472a22fcf4f13e0444a4da89cb99aab772fc8eff1d1cacabb6c38ce568dd6276651f6d9b1d5b9fbf10cb738d19320b454

data/CHANGELOG.md

@@ -5,24 +5,59 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## Unreleased
+
+## 0.2.0 - 2023-09-02
+
+This release brings mostly improvements and fixes, however there's not that much
+new features yet.
+
+### Added
+
+- aliased `Animation#width` and `Animation#height` to `w` and `h` respectively, the same was done
+for `Frame`.
+
+### Changed
+
+- `Animation#get_current_frame` is now `Animation#current_frame` as to not be redundant. Following that now `Animation#current_frame`(The accessor for the instance variable) is renamed to `Animation#position`.
+
+### Fixed
+
+- Previously methods like `Animation#done?` or `Animation#resume` didn't return `self`, so it wasn't possible to chaint them like this
+  ```ruby
+  # Example
+  my_animation.pause.resume.duration(200)
+  ```
+  now they do so you can do that.
+
+## 0.1.3 - 2023-08-22
+
+### Fixed
+
+- Undefined method error in animation, when using `size` on `AniRuby::Frames`, now
+  use `Enumerable#count` instead.
+
+### Changed
+
+- The way milliseconds are used as duration, before you'll have to use whole numbers
+  (1000 is a second, 500 half a second and so on), now we can just use floats for that (1.0 as a second, 0.5 half a second and so on).
 
 ## 0.1.2 - 2023-08-20
 
 ### Changed
 
-- Downcased the gem name in the gemspec
+- Downcased the gem name in the gemspec.
 
 ## 0.1.1 - 2023-08-20
 
 ### Added
 
-- Add .yardopts to included files
+- Add .yardopts to included files.
 
 ### Fixed
 
-- Required ruby not being used correctly in gemspec
+- Required ruby not being used correctly in gemspec.
 
 ## 0.1.0 - 2023-08-20
 
-Initial release
+Initial release.

data/README.md

@@ -1,13 +1,16 @@
 # AniRuby
 
+![Gem (including prereleases)](https://img.shields.io/gem/v/aniruby?style=flat-square&color=blue)
+
 Make sprite animations on Gosu simple and easy.
 
 ## Summary
 
 This library will provide you with a nice n easy interface to do sprite animations
-on [Gosu](https://www.libgosu.org/), while being as nifty as possible
+on [Gosu](https://www.libgosu.org/), while being as nifty and simple as possible.
 
-The library is made in pure Ruby with no dependencies at all (except Gosu, of course)
+The library is made in pure Ruby with no dependencies at all (except Gosu, of course) so
+its quite lightweight.
 
 ## Install
 
@@ -18,14 +21,14 @@ You can install the gem with the following command:
 or use it with a bundle:
 
 ```ruby
-# Somewhere in a Gemfile
+# Somewhere in your Gemfile
 
 gem 'aniruby'
 ```
 
 ## Getting Started
 
-Using the less code possible:
+The smallest example:
 
 ```ruby
 
@@ -38,10 +41,11 @@ class MyWindow < Gosu::Window
 
     @animation = AniRuby::Animation.new('my_spritesheet.png', 32, 32,
                                         false, true,
-                                        150)
+                                        0.15)
   end
 
   def update
+    # Remember to update your animation!
     @animation.update
   end
 
@@ -56,23 +60,58 @@ end
 When you create a animation, you'll need to have an *spritesheet*, where you have
 each sprite of the animation, that's the first argument to `Animation#new`, then
 you'll need the dimensions of each individual sprite on your spritesheet, in the
-example provided each sprite in the spritesheet is 32x32.
+example provided we assume each sprite in the spritesheet is 32x32. Take for example
+the following spritesheet courtesy of penzilla on [Itch.io](https://penzilla.itch.io/hooded-protagonist)
+
+![example spritesheet](assets/example_spritesheet.png)
+
+when we load it, it'll be divided into different image based on the individual
+dimensions of each sprite, so if we specify 32 as width and 32 as height then the
+spritesheet will be divided like this:
+
+![example spritesheet quads](assets/example_spritesheet_quads.png)
+
+That's the bare minimum to get an animation, of course you can enable Gosu's retro
+option so pixel animations will still look crisp when scaled, enable looping or specify
+the duration of the animation (or for every frame even!).
+
+In the example above we initialize the animation with retro off, looping on and
+with a duration of 0.15 (150ms) for every frame. So we'll get something like this:
+
+![example spritesheet result](assets/example_spritesheet_result.gif)
+
+Ain't that nice?
+
+### Drawing
+
+You can draw an animation like any other `Gosu::Image`! An animation has both
+`Animation#draw` and `Animation#draw_rot`, these methods mimic the ones on Gosu, so you don't
+have to learn anything new.
+
+### Extras
+
+Each `Animation` has extra helpful methods, like `pause` & `unpause`, `reset`,
+`done?`, etc. I recommend you to look on the source, its pretty small and easy to
+understand, or build the YARD documentation with
+
+`rake doc`
+
+## Development
 
-That is the bare minimum, you can specify filter type (retro in gosu's API), looping
-and duration (for each individual frame too!).
+First clone this repo locally:
 
-provided you have the initilization right, you need to `update` your animation for it
-to come to live!
+`git clone https://github.com/Chadowo/aniruby`
 
-NOTE: `Animation#draw` mimics the API of gosu' `Image#draw`, so you can give it
-much more than single coordinates. there's `Animation#draw_rot` too!
+Then you can use rake to build or test gem.
 
 ## Roadmap
 
 - more fine-grained control of animation
 - being able to make an animation stitching `Gosu::Image`'s together
-- mirroring 
+- mirroring
+- inverse animation
+- multiple animation from a single spritesheet
 
 ## License
 
-[MIT](LICENSE)
+This library is licensed under the [MIT](LICENSE) license.

data/Rakefile

@@ -1,12 +1,12 @@
 
 require 'fileutils'
-require "minitest/test_task"
+require 'minitest/test_task'
 
 require_relative 'lib/aniruby/version'
 
 Minitest::TestTask.create
 
-task :default => :build
+task :default => :test
 
 desc 'Build the gem'
 task :build do

data/lib/aniruby/animation.rb

@@ -6,8 +6,8 @@ module AniRuby
     # @return [AniRuby::Frames] The collection of frames this animation uses
     attr_accessor :frames
     # @return [Integer] The current frame index of the animation
-    attr_accessor :current_frame
-    # @return [Boolean] The loop status of the animation
+    attr_accessor :position
+    # @return [Boolean] The loop parameter
     attr_accessor :loop
 
     # Create a new animation
@@ -17,20 +17,23 @@ module AniRuby
     # @param frame_h [Integer] The height of each individual frame
     # @param retro [Boolean] If true, the animation will not be interpolated when scaled
     # @param loop [Boolean] If true, the animation will loop indefinitely
-    # @param durations [Integer] The duration of the frames in milliseconds (500
-    #                             is half a second, 1000 a second, etc). If
-    #                             there's more than one duration, then they will
-    #                             be mapped to each frame of the animation, the
-    #                             frames with no specified duration will default to 100
+    # @param durations [Float] The duration of the frames in MS (0.5 is half a second,
+    #                              1.0 a second, etc). If there's more than one duration
+    #                              provided they will be mapped to each frame of the
+    #                              animation. The default for each frame is 0.1.
     #
     # @return [Animation] A new animation ready to play
-    def initialize(spritesheet, frame_w, frame_h, retro = false, loop = true, *durations)
+    def initialize(spritesheet,
+                   frame_w, frame_h,
+                   retro = false,
+                   loop = true,
+                   *durations)
       @frame_w = frame_w
       @frame_h = frame_h
 
       @loop = loop
 
-      @current_frame = 0
+      @position = 0
       @pause = false
 
       @frames = AniRuby::Frames.new(Gosu::Image.load_tiles(spritesheet,
@@ -55,22 +58,26 @@ module AniRuby
     #
     # @return [Integer]
     def width
-      @frames[@current_frame].sprite.width
+      @frames[@position].width
     end
 
+    alias :w :width
+
     # Get the height of the current frame's image
     #
     # @return [Integer]
     def height
-      @frames[@current_frame].sprite.height
+      @frames[@position].height
     end
 
+    alias :h :height
+
     # Update the animation, advancing the frame counter. Note that this won't do
     # do anything if the animation is paused or has finished
     def update
       return if done? || paused?
 
-      @current_frame += 1 if frame_expired?
+      @position += 1 if frame_expired?
     end
 
     # Draw the animation
@@ -93,7 +100,7 @@ module AniRuby
 
       frame.sprite.draw(x, y, z, scale_x, scale_y, color, mode)
 
-      @current_frame = 0 if @loop && done?
+      @position = 0 if @loop && done?
     end
 
     # Draw the animation rotated, with its rotational center at (x, y).
@@ -123,7 +130,7 @@ module AniRuby
       frame.sprite.draw_rot(x, y, z, angle, center_x, center_y, scale_x, scale_y, color, mode)
 
       # Loop the animation
-      @current_frame = 0 if @loop && done?
+      @position = 0 if @loop && done?
     end
 
     # Pause the animation
@@ -131,6 +138,8 @@ module AniRuby
     # (see {resume})
     def pause
       @pause = true
+
+      self
     end
 
     # Resume the animation
@@ -138,18 +147,24 @@ module AniRuby
     # (see {pause})
     def resume
       @pause = false
+
+      self
     end
 
     # Set the animation to the beginning frame
     def reset
-      @current_frame = 0
+      @position = 0
+
+      self
     end
 
     # Set the duration for all frames in the animation
     #
-    # @param ms [Integer] The new duration in milliseconds
+    # @param ms [Float] The new duration in milliseconds
     def duration(ms)
-      @frames.each { |frame| frame.duration = ms}
+      @frames.each { |frame| frame.duration = ms }
+
+      self
     end
 
     # Is the animation finished?
@@ -157,7 +172,9 @@ module AniRuby
     # @return [Boolean]
     # @note This method will return true in intervals if the animation loops
     def done?
-      true if @current_frame == @frames.size - 1
+      true if @position == @frames.count - 1
+
+      false
     end
 
     # Is the animation paused?
@@ -172,16 +189,16 @@ module AniRuby
     # Get the current frame
     #
     # @return [AniRuby::Frame]
-    def get_current_frame
-      @frames[@current_frame % @frames.size]
+    def current_frame
+      @frames[@position % @frames.count]
     end
 
     # Has the current frame's duration expired?
     def frame_expired?
-      now = Gosu.milliseconds
+      now = Gosu.milliseconds / 1000.0
       @last_frame ||= now
 
-      if (now - @last_frame) > @frames[@current_frame].duration
+      if (now - @last_frame) > @frames[@position].duration
         @last_frame = now
       end
     end

data/lib/aniruby/frame.rb

@@ -1,16 +1,32 @@
 
 module AniRuby
-  # A frame has a sprite and a duration in milliseconds
+  # A frame has a sprite that's Gosu::Image and a duration specified in
+  # milliseconds
   class Frame
-    attr_accessor :duration, :sprite
-    attr_reader :w, :h
+    # @return [Float]
+    attr_accessor :duration
 
-    def initialize(sprite, duration = 100)
+    # @return [Gosu::Image]
+    attr_accessor :sprite
+
+    # @return [Integer]
+    attr_reader :width, :height
+
+    alias :w :width
+    alias :h :height
+
+    # Create a new frame
+    #
+    # @param sprite [Gosu::Image]
+    # @param duration [Float]
+    #
+    # @return [Frame]
+    def initialize(sprite, duration = 0.1)
       @sprite = sprite
       @duration = duration
 
-      @w = @sprite.width
-      @h = @sprite.height
+      @width = @sprite.width
+      @height = @sprite.height
     end
   end
 end

data/lib/aniruby/frames.rb

@@ -1,6 +1,6 @@
 
 module AniRuby
-  # Collection of frames, with Enumerable included to add iteration functions
+  # Collection of frames
   class Frames
     include Enumerable
 
@@ -14,6 +14,8 @@ module AniRuby
     end
 
     # @param index [Integer]
+    #
+    # @return [Frame]
     def [](index)
       @frames[index]
     end

data/lib/aniruby/version.rb

@@ -1,8 +1,8 @@
 
 module AniRuby
   MAJOR = 0
-  MINOR = 1
-  PATCH = 2
+  MINOR = 2
+  PATCH = 0
 
   # See https://semver.org/
   VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}".freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aniruby
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Chadow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-20 00:00:00.000000000 Z
+date: 2023-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.17.0
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
 description: |
   Library for painless sprite animations on Gosu, with a easy
   and nifty API, made in pure Ruby with no dependencies at all!
@@ -74,7 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- Gosu installed and working
 rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4