aniruby 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b0e843e0f081ca0cc57e4e28ed4b37f43574d7d4b50220d608879357f322d44
+  data.tar.gz: e284a38f220483bd15cae1a0ed61f6615296d8b4257838266013d9214bfd327c
+SHA512:
+  metadata.gz: e3339f0a1560b4b77adf2b1dadf574d88f80d8315e71c0a1e7d886e94da3ada92968486dfdb48ef06fba66fa572f9f8f1fb95ace2669afba150c233e4cda780a
+  data.tar.gz: 42308936cde744c37f56af5c1fe03e244f0d13634ebf52dd194408603531108e5cf4d804b0da6432f7fe7f3b2a81c02ec27ac4036b0dc51af88c75594d458078

data/.yardopts

@@ -0,0 +1 @@
+lib/**/*.rb - README.md CHANGELOG.md LICENSE

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+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]
+
+## 0.1.2 - 2023-08-20
+
+### Changed
+
+- Downcased the gem name in the gemspec
+
+## 0.1.1 - 2023-08-20
+
+### Added
+
+- Add .yardopts to included files
+
+### Fixed
+
+- Required ruby not being used correctly in gemspec
+
+## 0.1.0 - 2023-08-20
+
+Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Chadow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# AniRuby
+
+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
+
+The library is made in pure Ruby with no dependencies at all (except Gosu, of course)
+
+## Install
+
+You can install the gem with the following command:
+
+`gem install aniruby`
+
+or use it with a bundle:
+
+```ruby
+# Somewhere in a Gemfile
+
+gem 'aniruby'
+```
+
+## Getting Started
+
+Using the less code possible:
+
+```ruby
+
+require 'gosu'
+require 'aniruby'
+
+class MyWindow < Gosu::Window
+  def initialize
+    super(800, 600, false)
+
+    @animation = AniRuby::Animation.new('my_spritesheet.png', 32, 32,
+                                        false, true,
+                                        150)
+  end
+
+  def update
+    @animation.update
+  end
+
+  def draw
+    @animation.draw(0, 0)
+  end
+end
+```
+
+### Explanation
+
+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.
+
+That is the bare minimum, you can specify filter type (retro in gosu's API), looping
+and duration (for each individual frame too!).
+
+provided you have the initilization right, you need to `update` your animation for it
+to come to live!
+
+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!
+
+## Roadmap
+
+- more fine-grained control of animation
+- being able to make an animation stitching `Gosu::Image`'s together
+- mirroring 
+
+## License
+
+[MIT](LICENSE)

data/Rakefile

@@ -0,0 +1,33 @@
+
+require 'fileutils'
+require "minitest/test_task"
+
+require_relative 'lib/aniruby/version'
+
+Minitest::TestTask.create
+
+task :default => :build
+
+desc 'Build the gem'
+task :build do
+  Dir.mkdir('pkg') unless Dir.exist?('pkg')
+
+  sh 'gem build aniruby.gemspec'
+
+  FileUtils.mv("aniruby-#{AniRuby::VERSION}.gem", 'pkg')
+end
+
+desc 'Clean the build enviroment'
+task :clean do
+  FileUtils.rm_rf('pkg')
+end
+
+desc 'Push the gem to RubyGems'
+task :push do
+  sh "gem push pkg/aniruby-#{AniRuby::VERSION}.gem"
+end
+
+desc 'Use YARD to generate documentation'
+task :doc do
+  sh 'yardoc'
+end

data/lib/aniruby/animation.rb

@@ -0,0 +1,189 @@
+
+module AniRuby
+  # Has a AniRuby::Frames colletion, with a simple counter to keep track of
+  # current frame plus looping and pausing functionality
+  class Animation
+    # @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 :loop
+
+    # Create a new animation
+    #
+    # @param spritesheet [String] Path to the spritesheet file
+    # @param frame_w [Integer] The width of each individual frame
+    # @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
+    #
+    # @return [Animation] A new animation ready to play
+    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
+      @pause = false
+
+      @frames = AniRuby::Frames.new(Gosu::Image.load_tiles(spritesheet,
+                                                           @frame_w,
+                                                           @frame_h,
+                                                           retro: retro))
+
+      # TODO: Maybe I could shorten this, adding an extra argument to
+      #       AniRuby::Frames
+      if durations.one?
+        @frames.each { |frame| frame.duration = durations[0]}
+      else
+        @frames.each_with_index do |frame, idx|
+          # Set each frame to the duration provided, if there's no provide
+          # duration for all frames then we'll leave it at the default
+          frame.duration = durations[idx] unless durations[idx].nil?
+        end
+      end
+    end
+
+    # Get the width of the current frame's image
+    #
+    # @return [Integer]
+    def width
+      @frames[@current_frame].sprite.width
+    end
+
+    # Get the height of the current frame's image
+    #
+    # @return [Integer]
+    def height
+      @frames[@current_frame].sprite.height
+    end
+
+    # 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?
+    end
+
+    # Draw the animation
+    #
+    # @param x [Integer] The X coordinate
+    # @param y [Integer] The Y coordinate
+    # @param z [Integer] The Z order
+    # @param scale_x [Float] The horizontal scale factor
+    # @param scale_y [Float] The vertical scale factor
+    # @param color [Gosu::Color] The color to usw when drawing
+    # @param mode [:default, :additive] The blending mode
+    #
+    # (see {draw_rot})
+    def draw(x, y, z = 0,
+             scale_x = 1,
+             scale_y = 1,
+             color = Gosu::Color::WHITE,
+             mode = :default)
+      frame = @frames[@current_frame]
+
+      frame.sprite.draw(x, y, z, scale_x, scale_y, color, mode)
+
+      @current_frame = 0 if @loop && done?
+    end
+
+    # Draw the animation rotated, with its rotational center at (x, y).
+    #
+    # @param x [Integer] The X coordinate
+    # @param y [Integer] The Y coordinate
+    # @param z [Integer] The Z order
+    # @param angle [Float] The angle. in degrees
+    # @param center_x [Float] the relative horizontal rotation origin
+    # @param center_y [Float] the relative vertical rotation origin
+    # @param scale_x [Float] The horizontal scale factor
+    # @param scale_y [Float] The vertical scale factor
+    # @param color [Gosu::Color] The color to usw when drawing
+    # @param mode [:default, :additive] The blending mode
+    #
+    # (see {draw})
+    def draw_rot(x, y, z = 0,
+                 angle = 0,
+                 center_x = 0.5,
+                 center_y = 0.5,
+                 scale_x = 1,
+                 scale_y = 1,
+                 color = Gosu::Color::WHITE,
+                 mode = :default)
+      frame = @frames[@current_frame]
+
+      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?
+    end
+
+    # Pause the animation
+    #
+    # (see {resume})
+    def pause
+      @pause = true
+    end
+
+    # Resume the animation
+    #
+    # (see {pause})
+    def resume
+      @pause = false
+    end
+
+    # Set the animation to the beginning frame
+    def reset
+      @current_frame = 0
+    end
+
+    # Set the duration for all frames in the animation
+    #
+    # @param ms [Integer] The new duration in milliseconds
+    def duration(ms)
+      @frames.each { |frame| frame.duration = ms}
+    end
+
+    # Is the animation finished?
+    #
+    # @return [Boolean]
+    # @note This method will return true in intervals if the animation loops
+    def done?
+      true if @current_frame == @frames.size - 1
+    end
+
+    # Is the animation paused?
+    #
+    # @return [Boolean]
+    def paused?
+      return true if @pause
+
+      false
+    end
+
+    # Get the current frame
+    #
+    # @return [AniRuby::Frame]
+    def get_current_frame
+      @frames[@current_frame % @frames.size]
+    end
+
+    # Has the current frame's duration expired?
+    def frame_expired?
+      now = Gosu.milliseconds
+      @last_frame ||= now
+
+      if (now - @last_frame) > @frames[@current_frame].duration
+        @last_frame = now
+      end
+    end
+  end
+end

data/lib/aniruby/frame.rb

@@ -0,0 +1,16 @@
+
+module AniRuby
+  # A frame has a sprite and a duration in milliseconds
+  class Frame
+    attr_accessor :duration, :sprite
+    attr_reader :w, :h
+
+    def initialize(sprite, duration = 100)
+      @sprite = sprite
+      @duration = duration
+
+      @w = @sprite.width
+      @h = @sprite.height
+    end
+  end
+end

data/lib/aniruby/frames.rb

@@ -0,0 +1,31 @@
+
+module AniRuby
+  # Collection of frames, with Enumerable included to add iteration functions
+  class Frames
+    include Enumerable
+
+    # Create a new collection of frames
+    #
+    # @param sprites [Array<Gosu::Image>]
+    def initialize(sprites)
+      @frames = sprites.map do |sprite|
+        AniRuby::Frame.new(sprite)
+      end
+    end
+
+    # @param index [Integer]
+    def [](index)
+      @frames[index]
+    end
+
+    def each(&block)
+      @frames.each do |frame|
+        if block_given?
+          block.call(frame)
+        else
+          yield frame
+        end
+      end
+    end
+  end
+end

data/lib/aniruby/version.rb

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

data/lib/aniruby.rb

@@ -0,0 +1,6 @@
+
+require_relative 'aniruby/version'
+
+require_relative 'aniruby/frame'
+require_relative 'aniruby/frames'
+require_relative 'aniruby/animation'

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: aniruby
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Chadow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gosu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.17.0
+description: |
+  Library for painless sprite animations on Gosu, with a easy
+  and nifty API, made in pure Ruby with no dependencies at all!
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/aniruby.rb
+- lib/aniruby/animation.rb
+- lib/aniruby/frame.rb
+- lib/aniruby/frames.rb
+- lib/aniruby/version.rb
+homepage: https://github.com/Chadowo/aniruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key: 
+specification_version: 4
+summary: Make sprite animations on Gosu simple and easy
+test_files: []