fantasy 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b920c99d05b572330432388e4cb4bae6ef5b814d8834bb3b05da16375f49bf6
-  data.tar.gz: 2a5d7c01b7f3e98b5c8928f70981f5bf3591badc844f33a1209f49f6883a426d
+  metadata.gz: 1c4d46c2a62a78651a3e571f5728ad846010dace93462f0c980b2235291a7f76
+  data.tar.gz: ceea378b0edd7b58155a9d05eb659236b4c70a0253e42167084e88cc41853170
 SHA512:
-  metadata.gz: b791f6790eaa41e1c0cd49ef9faf514ef1fdacf9310f4dcf6cdfe6aeae2ebde28952d2f748c1e4f155dea6145dbbee7755599bf6a2555479b36a0d0390752bc0
-  data.tar.gz: e6be40d13c6b7a8c19e0e3604a1554eaa2f2efbc08ea7a9769e9b3db94407a1d8e3fd18c7ea0e08089ff6643e69e9c251d3de746720f464d6313b29baa288a50
+  metadata.gz: b1c7f7e63529fc52adfe955152a76820da1f7df3e9274184d5f8b93df3f647a529eba55bd6b8b64b2270f3d54780b3c39ea3a5066bb21e2114ca5e79ce78602f
+  data.tar.gz: 418dc874ae30413c064a63074fe54b67840bdf1cd38bff01c6288b6b9bf287abe5c5e6c3aab7830be23fe0660d390b6dbc8e86565f81e667b156bb9f6150e453

data/CHANGELOG.md

@@ -3,3 +3,21 @@
 ## [0.1.0] - 2022-03-11
 
 - Initial release
+
+## [0.1.5] - 2022-03-16
+
+- Background color or image
+- Tilemap
+- Camera can be controlled by cursors
+- Background image can be replicable
+
+## [0.1.7] - 2022-03-17
+
+- HudText accepts alignment property. Valid values: 'top-left, top-right, center'
+
+## [0.1.9] - 2022-03-25
+
+- Adding platformer support
+  - Jump
+  - Gravity
+- Music background support

data/README.md

@@ -116,12 +116,13 @@ Managing game elements which have (optionally) image, movement and collision
 - Easy to set an `image`
 - Managing movement through `direction` and `speed`
 - Built-in movement control through cursors
-- Collision detection, OnCollision callback
-- Jump (TODO)
-- Gravity (TODO)
+- Collision detection, OnCollision callback, Collision matrix
+- Jump
+- Gravity
 - Animations (TODO)
 - Possibility to extend Actor class or instantiate it directly for simple characters
 - Allowing magic instance properties (Like in OpenStruct). So programmer can do `actor.stuff = 1` and it is valid (TODO)
+- Alignment "center" and "top-left" (TODO)
 
 ### Clock
 
@@ -196,7 +197,9 @@ Move the core functions to the top level hierarchy so I don't need to create a `
 
 ### Sound
 
-Direct and easy way to play a sound
+- Direct and easy way to play a sound
+- Direct and easy way to play a background music
+
 
 ### Background
 
@@ -302,6 +305,7 @@ player.solid = true
 player.speed = 200
 player.layer = 1
 player.move_with_cursors
+player.collision_with = ["enemy", "bullets"] # default "all"
 
 player.on_collision do |other|
   if other.name == "enemy"
@@ -331,6 +335,7 @@ class Player < Actor
     @speed = 200
     @layer = 1
     @direction = Coordinates.zero
+    @collision_with = ["enemy", "bullets"] # default "all"
     move_with_cursors
   end
 
@@ -352,6 +357,25 @@ class Player < Actor
 end
 ```
 
+Actor settings for a platformer:
+
+```ruby
+player = Actor.new("warrior") # ./images/warrior.png
+player.solid = true
+player.jump = 150
+player.gravity = 200
+player.move_with_cursors(left: true, right: true, up: false, down: false, jump: true)
+
+player.on_start_jumping do
+  Sound.play("jump")
+  player.image = "warrior_jump")
+end
+
+player.on_start_falling do
+  player.image = "warrior")
+end
+```
+
 ### Clock
 
 ```ruby
@@ -398,18 +422,43 @@ end
 
 ### Sound
 
+Plays only once:
+
 ```ruby
 Sound.play("shoot") # ./sounds/shoot.wav
 ```
 
+Plays in loop:
+
+```ruby
+Music.play("music") # ./musics/music.mp3
+Music.volume = 0.5
+Music.stop
+```
+
+### Tilemap
+
+```ruby
+# ./maps/sky.txt
+#0       0        0
+#    1          0
+#
+#0    0     0
+
+planet = Actor.new("planet")
+star = Actor.new("star")
+map = Tilemap.new(map_name: "sky", tiles: [planet, star], tile_size: 30)
+map.spawn
+```
 
 ### UI
 
 #### HUD Text
 
 ```ruby
-timer = HudText.new(position: Coordinates.new(20, 10))
+timer = HudText.new(position: Coordinates.new(SCREEN_WIDTH / 2, 10))
 timer.text = 0
+timer.alignment = "center"
 timer.size = "big"
 
 Clock.new { timer.text += 1 }.repeat(seconds: 1)

data/lib/fantasy/actor.rb

@@ -1,26 +1,40 @@
 class Actor
   include MoveByCursor
+  include MoveByDirection
+  include Mover
+  include Gravitier
+  include Jumper
 
   attr_reader :image, :moving_with_cursors
-  attr_accessor :image_name, :position, :direction, :speed, :solid, :scale, :name, :layer
+  attr_accessor :image_name, :position, :direction, :speed, :jump, :gravity, :solid, :scale, :name, :layer
+  attr_accessor :collision_with
 
   def initialize(image_name)
     @image_name = image_name
     @image = Image.new(image_name)
     @name = image_name
-    @position = Coordinates.new(0, 0)
-    @direction = Coordinates.new(0, 0)
+    @position = Coordinates.zero
+    @direction = Coordinates.zero
     @speed = 0
     @scale = 1
-    @on_after_move_callback = nil
+
     @moving_with_cursors = false
     @solid = false
     @draggable_on_debug = true
     @dragging = false
     @dragging_offset = nil
     @layer = 0
+    @gravity = 0
+    @jump = 0
+    @collision_with = "all"
+
+    @on_floor = false
 
+    @on_after_move_callback = nil
     @on_collision_callback = nil
+    @on_destroy_callback = nil
+    @on_start_jumping_callback = nil
+    @on_start_falling_callback = nil
 
     Global.actors << self
   end
@@ -30,20 +44,16 @@ class Actor
   end
 
   def width
-    @image.width() * @scale
+    @image.width * @scale
   end
 
   def height
-    @image.height() * @scale
-  end
-
-  def move_with_cursors
-    @moving_with_cursors = true
+    @image.height * @scale
   end
 
   def direction=(value)
     @direction = value
-    @direction = @direction.normalize
+    @direction = @direction.normalize unless @direction.zero?
   end
 
   def draw
@@ -61,6 +71,25 @@ class Actor
     @position - Global.camera.position
   end
 
+  # TODO: make this work optimized
+  # def position_top_left
+  #   @position - position_delta
+  # end
+
+  # def position_delta
+  #   case @alignment
+  #   when "top-left"
+  #     Coordinates.zero
+  #   when "center"
+  #     Coordinates.new(width/2, height/2)
+  #   else
+  #     raise "Actor.alignment value not valid '#{@alignment}'. Valid values: 'top-left, center'"
+  #   end
+  # end
+
+  # TODO: I made more of this code while I was with Covid
+  # It looks horrible and it is crap
+  # I'll improve it some day :)
   def move
     mouse_position = Global.mouse_position + Global.camera.position
 
@@ -76,30 +105,87 @@ class Actor
     if @dragging
       @position = mouse_position - @dragging_offset
     else
-      calculate_direction_by_cursors if @moving_with_cursors
+      # Direction moving
+      unless @direction.zero?
+        @velocity = Coordinates.zero
+        last_position = @position
+        add_forces_by_direction
+        apply_forces(max_speed: @speed)
+
+        # Check collision after cursor moving
+        if @solid && @position != last_position
+          manage_collisions(last_position)
+        end
+      end
 
-      if @direction != Coordinates.zero && !@speed.zero?
-        @last_position = @position
-        @position = @position + (@direction * @speed * Global.frame_time)
+      # Cursors moving
+      @velocity = Coordinates.zero
+      last_position = @position
+      add_forces_by_cursors
+      apply_forces(max_speed: @speed)
 
-        if solid?
-          collisions.each do |actor|
-            collision_with(actor)
-            actor.collision_with(self)
-          end
+      # Check collision after cursor moving
+      if @solid && @position != last_position
+        manage_collisions(last_position)
+      end
 
-          @position = @last_position if collisions.any? # we don't cache collisions because position may be changed on collision callback
+      # Jump moving
+      unless @jump.zero?
+        @velocity = Coordinates.zero
+        last_position = @position
+        add_force_by_jump
+        apply_forces(max_speed: @speed)
+
+        # Check collision after jump moving
+        if @solid && @position != last_position
+         if manage_collisions(last_position)
+            @jumping = false
+         end
         end
       end
+
+      # Gravity moving
+      if !@gravity.zero? && !@jumping
+        @velocity = Coordinates.zero
+        last_position = @position
+        add_force_by_gravity
+        apply_forces(max_speed: @gravity)
+
+        # Check collision after gravity moving
+        if @solid && @position != last_position
+          @on_floor = false
+          manage_collisions(last_position)
+        end
+      end
+    end
+
+    on_after_move_do
+  end
+
+  def manage_collisions(last_position)
+    collisions.each do |other|
+      on_collision_do(other)
+      other.on_collision_do(self)
+
+      if other.position.y > (last_position.y + height)
+        @on_floor = true
+      end
+    end
+
+    if collisions.any? # we don't cache collisions because position may be changed on collision callback
+      @position = last_position
+
+      return true
     end
 
-    @on_after_move_callback.call unless @on_after_move_callback.nil?
+    false
   end
 
   def solid?
     @solid
   end
 
+  # Set callbacks
   def on_after_move(&block)
     @on_after_move_callback = block
   end
@@ -112,18 +198,51 @@ class Actor
     @on_destroy_callback = block
   end
 
-  def collision_with(actor)
-    @on_collision_callback.call(actor) unless @on_collision_callback.nil?
+  def on_start_jumping(&block)
+    @on_start_jumping_callback = block
   end
 
+  def on_start_falling(&block)
+    @on_start_falling_callback = block
+  end
+
+
+  # Execute callbacks
+  def on_after_move_do
+    instance_exec(&@on_after_move_callback) unless @on_after_move_callback.nil?
+  end
+
+  def on_collision_do(other)
+    instance_exec(other, &@on_collision_callback) unless @on_collision_callback.nil?
+  end
+
+  def on_destroy_do
+    instance_exec(&@on_destroy_callback) unless @on_destroy_callback.nil?
+  end
+
+  def on_start_jumping_do
+    instance_exec(&@on_start_jumping_callback) unless @on_start_jumping_callback.nil?
+  end
+
+  def on_start_falling_do
+    instance_exec(&@on_start_falling_callback) unless @on_start_falling_callback.nil?
+  end
+
+
+
   def collisions
-    Global.actors.reject { |e| e == self }.select { |e| e.solid? }.select do |actor|
-      Utils.collision? self, actor
+    Global.actors.reject { |e| e == self }.select { |e| e.solid? }.select do |other|
+      if(
+        (@collision_with == "all" || @collision_with.include?(other.name)) &&
+        (other.collision_with == "all" || other.collision_with.include?(self.name))
+      )
+        Utils.collision? self, other
+      end
     end
   end
 
   def destroy
-    @on_destroy_callback.call unless @on_destroy_callback.nil?
+    on_destroy_do
     Global.actors.delete(self)
   end
 
@@ -133,15 +252,21 @@ class Actor
     actor.name = @name
     actor.position = @position.clone
     actor.direction = @direction.clone
+
     actor.speed = @speed
     actor.scale = @scale
     actor.moving_with_cursors if @moving_with_cursors
     actor.solid = @solid
     actor.layer = @layer
+    actor.gravity = @gravity
+    actor.jump = @jump
+    actor.collision_with = @collision_with
 
     actor.on_after_move_callback = @on_after_move_callback
     actor.on_collision_callback = @on_collision_callback
     actor.on_destroy_callback = @on_destroy_callback
+    actor.on_start_jumping = @on_start_jumping_callback
+    actor.on_start_falling = @on_start_falling_callback
 
     actor
   end
@@ -159,4 +284,12 @@ class Actor
   def on_destroy_callback=(block)
     @on_destroy_callback = block
   end
+
+  def on_start_jumping=(block)
+    @on_start_jumping_callback = block
+  end
+
+  def on_start_falling=(block)
+    @on_start_falling_callback = block
+  end
 end

data/lib/fantasy/coordinates.rb

@@ -32,4 +32,8 @@ class Coordinates < Vector2d
   def clone
     Coordinates.new(@x, @y)
   end
+
+  def zero?
+    @x == 0 && @y == 0
+  end
 end

data/lib/fantasy/global.rb

@@ -116,11 +116,22 @@ module Global
       @hud_images.clear
       @backgrounds.clear
       @tile_maps.clear
+      @camera.position = Coordinates.zero
 
       @clocks.reject(&:persistent?).each do |clock|
         clock.stop unless clock.thread == Thread.current # no stop current Thread
       end
 
+      # clear callbacks
+      @button_proc = nil
+      @space_bar_proc = nil
+      @cursor_up_proc = nil
+      @cursor_down_proc = nil
+      @cursor_left_proc = nil
+      @cursor_right_proc = nil
+      @mouse_button_left_proc = nil
+      @mouse_button_right_proc = nil
+
       @background = Color.new(r: 0, g: 0, b: 0)
     end
 

data/lib/fantasy/hud_image.rb

@@ -37,7 +37,7 @@ class HudImage
   end
 
   def draw_debug
-    Global.pixel_font.draw_text("#{@position.x.floor},#{@position.y.floor}", @position.x, @position.y - 20, 1)
+    Global.pixel_fonts["medium"].draw_text("#{@position.x.floor},#{@position.y.floor}", @position.x, @position.y - 20, 1)
   end
 
   def destroy

data/lib/fantasy/hud_text.rb

@@ -1,5 +1,5 @@
 class HudText
-  attr_accessor :text, :size, :color, :visible, :layer, :in_world, :position
+  attr_accessor :text, :size, :color, :visible, :layer, :in_world, :position, :alignment
 
   def initialize(position:, text: "")
     @position = position
@@ -9,6 +9,7 @@ class HudText
     @visible = true
     @layer = 100
     @in_world = false
+    @alignment = "top-left"
 
     Global.hud_texts.push(self)
   end
@@ -17,8 +18,8 @@ class HudText
 
   def draw
     if visible
-      font.draw_markup(text, screen_position.x + shadow_offset, screen_position.y - 20 + shadow_offset, 1, 1, 1, Gosu::Color::BLACK)
-      font.draw_markup(text, screen_position.x, screen_position.y - 20, 1, 1, 1, color)
+      font.draw_markup_rel(text, screen_position.x + shadow_offset, screen_position.y + shadow_offset, 1, position_rel.x, position_rel.y, 1, 1, Gosu::Color::BLACK)
+      font.draw_markup_rel(text, screen_position.x, screen_position.y, 1, position_rel.x, position_rel.y, 1, 1, color)
     end
 
     draw_debug if Global.debug
@@ -27,11 +28,24 @@ class HudText
   def font
     found_font = Global.pixel_fonts[@size]
     if found_font.nil?
-      raise "HudText.size not valid '#{@size}'. Valid sizes: 'small, medium, big, huge'"
+      raise "HudText.size value not valid '#{@size}'. Valid values: 'small, medium, big, huge'"
     end
     found_font
   end
 
+  def position_rel
+    case @alignment
+    when "top-left"
+      Coordinates.new(0, 0)
+    when "top-right"
+      Coordinates.new(1, 0)
+    when "center"
+      Coordinates.new(0.5, 0.5)
+    else
+      raise "HudText.alignment value not valid '#{@alignment}'. Valid values: 'top-left, top-right, center'"
+    end
+  end
+
   def shadow_offset
     case @size
     when "small"
@@ -43,7 +57,7 @@ class HudText
     when "huge"
       4
     else
-      raise "HudText.size not valid '#{@size}'. Valid sizes: 'small, medium, big, huge'"
+      raise "HudText.size value not valid '#{@size}'. Valid sizes: 'small, medium, big, huge'"
     end
   end
 
@@ -60,6 +74,6 @@ class HudText
   end
 
   def draw_debug
-    Global.pixel_fonts["medium"].draw_text("#{@position.x.floor},#{@position.y.floor}", @position.x, @position.y, 1)
+    Global.pixel_fonts["medium"].draw_text("#{@position.x.floor},#{@position.y.floor}", screen_position.x, screen_position.y, 1)
   end
 end

data/lib/fantasy/includes/gravitier.rb

@@ -0,0 +1,5 @@
+module Gravitier
+  def add_force_by_gravity
+    add_force(Coordinates.down * @gravity)
+  end
+end

data/lib/fantasy/includes/jumper.rb

@@ -0,0 +1,30 @@
+module Jumper
+  def add_force_by_jump
+    if Gosu.button_down?(Gosu::KB_SPACE) && @move_with_cursors_jump && !@jumping && @on_floor
+      execute_jump
+    end
+
+    if @jumping
+      continue_jump
+    end
+  end
+
+  def execute_jump
+    @jumping = true
+    @on_floor = false
+    @final_vertical_position = @position.y - @jump
+
+    on_start_jumping_do
+  end
+
+  def continue_jump
+    add_force(Coordinates.up * @jump)
+
+    if(@position.y <= @final_vertical_position)
+      @position.y = @final_vertical_position
+      @jumping = false
+
+      on_start_falling_do
+    end
+  end
+end

data/lib/fantasy/includes/move_by_cursors.rb

@@ -1,15 +1,26 @@
 module MoveByCursor
-  def calculate_direction_by_cursors
-    if Gosu.button_down?(Gosu::KB_DOWN)
-      @direction = Coordinates.down
-    elsif Gosu.button_down?(Gosu::KB_UP)
-      @direction = Coordinates.up
-    elsif Gosu.button_down?(Gosu::KB_RIGHT)
-      @direction = Coordinates.right
-    elsif Gosu.button_down?(Gosu::KB_LEFT)
-      @direction = Coordinates.left
+  def add_forces_by_cursors
+    if Gosu.button_down?(Gosu::KB_DOWN) && @move_with_cursors_down
+      add_force(Coordinates.down * @speed)
+    elsif Gosu.button_down?(Gosu::KB_UP) && @move_with_cursors_up
+      add_force(Coordinates.up * @speed)
+    elsif Gosu.button_down?(Gosu::KB_RIGHT) && @move_with_cursors_right
+      add_force(Coordinates.right * @speed)
+    elsif Gosu.button_down?(Gosu::KB_LEFT) && @move_with_cursors_left
+      add_force(Coordinates.left * @speed)
     else
-      @direction = Coordinates.zero
+      # @velocity.x = 0
     end
+
+
+  end
+
+  def move_with_cursors(down: true, up: true, left: true, right: true, jump: false)
+    puts "#{@name}: move_with_cursors(down: #{down}, up: #{up}, left: #{left}, right: #{right}), jump: #{jump}"
+    @move_with_cursors_down = down
+    @move_with_cursors_up = up
+    @move_with_cursors_left = left
+    @move_with_cursors_right = right
+    @move_with_cursors_jump = jump
   end
 end

data/lib/fantasy/includes/move_by_direction.rb

@@ -0,0 +1,5 @@
+module MoveByDirection
+  def add_forces_by_direction
+    add_force(@direction)
+  end
+end

data/lib/fantasy/includes/mover.rb

@@ -0,0 +1,20 @@
+module Mover
+  def add_force(force)
+    @acceleration ||= Coordinates.zero
+    @acceleration += force
+  end
+
+  def apply_forces(max_speed:)
+    @acceleration ||= Coordinates.zero
+    @velocity ||= Coordinates.zero
+
+    @velocity += @acceleration
+
+    unless @velocity.length.zero?
+      @velocity = @velocity.normalize * max_speed * Global.frame_time
+      @position += @velocity
+    end
+
+    @acceleration = Coordinates.zero
+  end
+end

data/lib/fantasy/music.rb

@@ -0,0 +1,49 @@
+module Music
+  class << self
+    @@musics = {}
+    @@actual_song = nil
+
+    def play(music_name)
+      stop
+
+      @@actual_song = locate_music(music_name)
+      @@actual_song.play(true)
+    end
+
+    def stop
+      @@actual_song.stop unless @@actual_song.nil?
+    end
+
+    def volume
+      @@actual_song&.volume
+    end
+
+    def volume=(value)
+      @@actual_song.volume = value unless @@actual_song.nil?
+    end
+
+    def locate_music(music_name)
+      return @@musics[music_name] if @@musics[music_name]
+
+      puts "Initialize Music: '#{music_name}'"
+
+      file_name = Dir.entries(base_path).find { |e| e =~ /^#{music_name}($|\.)/ }
+
+      raise "Music file not found with name '#{music_name}'" if file_name.nil?
+
+      @@musics[music_name] = Gosu::Song.new("#{base_path}/#{file_name}")
+
+      return @@musics[music_name]
+    end
+
+    def preload_musics
+      Dir.each_child(base_path) do |file_name|
+        locate_music(file_name) unless file_name.start_with?(".")
+      end
+    end
+
+    def base_path
+      "#{Dir.pwd}/musics"
+    end
+  end
+end

data/lib/fantasy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fantasy
-  VERSION = "0.1.7"
+  VERSION = "0.1.9"
 end

data/lib/fantasy.rb

@@ -2,12 +2,17 @@
 require "gosu"
 
 require_relative "fantasy/version"
+
+require_relative "fantasy/coordinates"
 require_relative "fantasy/includes/move_by_cursors"
+require_relative "fantasy/includes/move_by_direction"
+require_relative "fantasy/includes/mover"
+require_relative "fantasy/includes/gravitier"
+require_relative "fantasy/includes/jumper"
 require_relative "fantasy/tween"
 require_relative "fantasy/draggable"
 require_relative "fantasy/color"
 require_relative "fantasy/actor"
-require_relative "fantasy/coordinates"
 require_relative "fantasy/utils"
 require_relative "fantasy/global"
 require_relative "fantasy/clock"
@@ -16,6 +21,7 @@ require_relative "fantasy/hud_text"
 require_relative "fantasy/hud_image"
 require_relative "fantasy/background"
 require_relative "fantasy/sound"
+require_relative "fantasy/music"
 require_relative "fantasy/camera"
 require_relative "fantasy/image"
 require_relative "fantasy/tilemap"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fantasy
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Fernando Guillen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-17 00:00:00.000000000 Z
+date: 2022-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -69,8 +69,13 @@ files:
 - lib/fantasy/hud_image.rb
 - lib/fantasy/hud_text.rb
 - lib/fantasy/image.rb
+- lib/fantasy/includes/gravitier.rb
+- lib/fantasy/includes/jumper.rb
 - lib/fantasy/includes/move_by_cursors.rb
+- lib/fantasy/includes/move_by_direction.rb
+- lib/fantasy/includes/mover.rb
 - lib/fantasy/loop.rb
+- lib/fantasy/music.rb
 - lib/fantasy/sound.rb
 - lib/fantasy/tilemap.rb
 - lib/fantasy/tween.rb