fantasy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98740063fd63398988bf5b11e625a75e2526f617ab22e9aa1ff483a65c0f91cb
+  data.tar.gz: b4eecd987e01f24f2a1d3aef7627c195992ec0ffa0c4b124fb6ca577896a2a58
+SHA512:
+  metadata.gz: ab99759553de96490612fbf1c6089db1113ec26969876b88d9215fbb1317a7ee08dfef98cd376c7843750013ed3981b10fc0beba0e816a6c5c7358511166b023
+  data.tar.gz: 69c41125931104d3440c02bfe1073b6d37f27d2efebbe3fdd331165c014739bf81f92d80c83c46f636d0eda77d583a802a7f377c943ce8964a8bf9d7567f7d4d

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-03-11
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+ruby ">= 3.0.0"
+
+# Specify your gem's dependencies in fantasy.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Fernando Guillen
+
+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,163 @@
+# Ruby in Fantasy
+
+An upper layer over Gosu library to offer a more friendly API for an easy and lean game development.
+
+Specially intended to use Ruby as a learning language to introduce children into programming.
+
+**Attention**: This project is in early development phase, right now it is just an experiment
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "fantasy"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install fantasy
+
+## Features
+
+### Actor
+
+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)
+- Animations (TODO)
+- Possibility to extend Actor class or instantiate it directly for simple characters
+
+### Clock
+
+Create new execution threads to program delayed behaviors, repetitive actions, animations, ...
+
+- Run now
+- Run after a delay
+- Repeat
+- Stop
+- Callback when finished (TODO)
+
+### Animations
+
+Add animations to an Actor and activate them when special state triggered
+
+- Set frames (TODO)
+- Duration in seconds (TODO)
+- Run once (TODO)
+- Run on loop (TODO)
+- Stop (TODO)
+- Callback when finished (TODO)
+
+### UI
+
+#### Button (TODO)
+
+Easy to set up a graphical component that responds to mouse hover and click events.
+
+- Set image (TODO)
+- Set image when hover (TODO)
+- Set image when clicked (TODO)
+- OnClicked callback (TODO)
+
+#### HUD Elements
+
+For easy creation of head-up display components.
+
+- Text Element
+- Image Element
+- Auto update text (observer variable changes) (TODO)
+
+### Debug Mode
+
+When active different attributes from all the Actors and HUD elements will be visible in the screen.
+
+- Position
+- Collider
+
+On top, when debug mode is active, the Actors and HUD elements become draggable.
+The new position won't be persistent but it will be helpful to identify which should be the desired position.
+
+### Camera
+
+Setting up a camera component that we can easily move around and all the active
+Actors in the game will be rendered in the relative position to this camera.
+
+- Allow camera move
+- Easy to follow one actor
+
+### Colors palette (TODO)
+
+- Not deal with RGB or anything, just a list of colors (TODO)
+
+### Game Scene transitions
+
+Easy to configure 3 basic game states:
+
+- Initial screen
+- Game
+- Game over screen
+
+Each state should be independent and unique Actors and other elements can be created and configured for each state
+
+Built-in mechanism to move from one state to another.
+
+### Pause Game (TODO)
+
+- Pause game, pause Actors, animations, clocks, ... (TODO)
+
+### Core run
+
+Move the core functions to the top level hierarchy so I don't need to create a `Game::Window` class
+
+### Sound
+
+Direct and easy way to play a sound
+
+### Data Persistance (TODO)
+
+Simple mechanismo to save data in disk. For user preferences, game progress, high scores and others
+
+### User Inputs
+
+Easy access to keyboard and mouse inputs on any part of the code. Specially in the Actors.
+
+- Allow "on_space_bar" and each Actor (TODO)
+- Allow multiple "on_space_bar" (TODO)
+- Remove "on_space_bar" when changing scene (TODO)
+
+## API
+
+
+
+## Credits for assets
+
+- Sprites: www.kenney.nl
+- Font: VT323 Project Authors (peter.hull@oikoi.com)
+
+## Bugs
+
+- When dragging in debug mode new elements are being added to the drag (TODO)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fguillen/fantasy.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "fantasy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fantasy.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/fantasy/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "fantasy"
+  spec.version = Fantasy::VERSION
+  spec.authors = ["Fernando Guillen"]
+  spec.email = ["fguillen.mail@gmail.com"]
+
+  spec.summary = "Simple toolbox library and lean API to build great mini games"
+  spec.description = "Simple toolbox library and lean API to build great mini games"
+  spec.homepage = "https://github.com/fguillen/fantasy"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/fguillen/fantasy"
+  spec.metadata["changelog_uri"] = "https://github.com/fguillen/fantasy/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "gosu", "~> 1.4.1"
+  spec.add_dependency "vector2d", "~> 2.2.3"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/fonts/OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2011, The VT323 Project Authors (peter.hull@oikoi.com)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

data/lib/fantasy/actor.rb

@@ -0,0 +1,141 @@
+class Actor
+  attr_reader :image, :moving_with_cursors
+  attr_accessor :position, :direction, :speed, :solid, :scale, :name, :layer
+
+  def initialize(image_name)
+    @image = Gosu::Image.new("#{__dir__}/../images/#{image_name}.png", { retro: true })
+    @name = image_name
+    @position = Coordinates.new(0, 0)
+    @direction = Coordinates.new(0, 0)
+    @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
+
+    @on_collision_callback = nil
+
+    Global.actors << self
+  end
+
+  def image=(image_name)
+    @image = Gosu::Image.new("#{__dir__}/../images/#{image_name}.png", { retro: true })
+  end
+
+  def width
+    @image.width() * @scale
+  end
+
+  def height
+    @image.height() * @scale
+  end
+
+  def move_with_cursors
+    @moving_with_cursors = true
+  end
+
+  def direction=(value)
+    @direction = value
+    @direction = @direction.normalize
+  end
+
+  def draw
+    @image.draw(position_in_camera.x, position_in_camera.y, 0, @scale, @scale)
+
+    draw_debug if Global.debug
+  end
+
+  def draw_debug
+    Utils.draw_frame(position_in_camera.x, position_in_camera.y, width, height, 1, Gosu::Color::RED) if solid
+    Global.pixel_font.draw_text("#{@position.x.floor},#{@position.y.floor}", position_in_camera.x, position_in_camera.y - 20, 1)
+  end
+
+  def position_in_camera
+    @position - Global.camera.position
+  end
+
+  def move
+    mouse_position = Global.mouse_position + Global.camera.position
+
+    if @draggable_on_debug && Global.debug && !@dragging && Gosu.button_down?(Gosu::MS_LEFT) && Utils.collision_at?(self, mouse_position.x, mouse_position.y)
+      @dragging = true
+      @dragging_offset = mouse_position - @position
+    end
+
+    if @dragging && !Gosu.button_down?(Gosu::MS_LEFT)
+      @dragging = false
+    end
+
+    if @dragging
+      @position = mouse_position - @dragging_offset
+    else
+      calculate_direction_by_cursors if @moving_with_cursors
+
+      if @direction != Coordinates.zero && !@speed.zero?
+        @last_position = @position
+        @position = @position + (@direction * @speed * Global.frame_time)
+
+        if solid?
+          actual_collisions = collisions
+          actual_collisions.each do |actor|
+            collision_with(actor)
+            actor.collision_with(self)
+          end
+
+          @position = @last_position if actual_collisions.any?
+        end
+      end
+    end
+
+    @on_after_move_callback.call unless @on_after_move_callback.nil?
+  end
+
+  def solid?
+    @solid
+  end
+
+  def on_after_move(&block)
+    @on_after_move_callback = block
+  end
+
+  def on_collision(&block)
+    @on_collision_callback = block
+  end
+
+  def on_destroy(&block)
+    @on_destroy_callback = block
+  end
+
+  def collision_with(actor)
+    @on_collision_callback.call(actor) unless @on_collision_callback.nil?
+  end
+
+  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
+    else
+      @direction = Coordinates.zero
+    end
+  end
+
+  def collisions
+    Global.actors.reject { |e| e == self }.select { |e| e.solid? }.select do |actor|
+      Utils.collision? self, actor
+    end
+  end
+
+  def destroy
+    @on_destroy_callback.call unless @on_destroy_callback.nil?
+    Global.actors.delete(self)
+  end
+end

data/lib/fantasy/base.rb

@@ -0,0 +1,59 @@
+Global.setup_proc = nil
+Global.loop_proc = nil
+
+def on_presentation(&block)
+  Global.presentation_proc = block
+end
+
+def on_game(&block)
+  Global.game_proc = block
+end
+
+def on_end(&block)
+  Global.end_proc = block
+end
+
+def on_setup(&block)
+  Global.setup_proc = block
+end
+
+def on_loop(&block)
+  Global.loop_proc = block
+end
+
+def on_button(&block)
+  Global.button_proc = block
+end
+
+def on_space_bar(&block)
+  Global.space_bar_proc = block
+end
+
+def on_cursor_up(&block)
+  Global.cursor_up_proc = block
+end
+
+def on_cursor_down(&block)
+  Global.cursor_down_proc = block
+end
+
+def on_cursor_left(&block)
+  Global.cursor_left_proc = block
+end
+
+def on_cursor_right(&block)
+  Global.cursor_right_proc = block
+end
+
+def on_mouse_button_left(&block)
+  Global.mouse_button_left_proc = block
+end
+
+def on_mouse_button_right(&block)
+  Global.mouse_button_right_proc = block
+end
+
+def start!
+  Global.game = Game.new
+  Global.game.show
+end

data/lib/fantasy/camera.rb

@@ -0,0 +1,7 @@
+class Camera
+  attr_accessor :position
+
+  def initialize(position: Coordinates.zero)
+    @position = position
+  end
+end

data/lib/fantasy/clock.rb

@@ -0,0 +1,39 @@
+class Clock
+  def initialize(&block)
+    @block = block
+    @thread = nil
+
+    Global.clocks << self
+  end
+
+  def run_now
+    @thread =
+      Thread.new do
+        @block.call
+      end
+  end
+
+  def run_on(seconds:)
+    @thread =
+      Thread.new do
+        sleep(seconds)
+        @block.call
+      end
+  end
+
+  def repeat(seconds: 1, times: Float::INFINITY)
+    times_executed = 0
+    @thread =
+      Thread.new do
+        while(times_executed < times)
+          @block.call
+          times_executed += 1;
+          sleep(seconds)
+        end
+      end
+  end
+
+  def stop
+    Thread.kill(@thread)
+  end
+end

data/lib/fantasy/color.rb

@@ -0,0 +1,5 @@
+class Color < Gosu::Color
+  def initialize(r:, g:, b:, a: 255)
+    super(a, r, g, b)
+  end
+end

data/lib/fantasy/coordinates.rb

@@ -0,0 +1,31 @@
+require "vector2d"
+
+class Coordinates < Vector2d
+  def self.zero
+    Coordinates.new(0, 0)
+  end
+
+  def self.up
+    Coordinates.new(0, -1)
+  end
+
+  def self.down
+    Coordinates.new(0, 1)
+  end
+
+  def self.left
+    Coordinates.new(-1, 0)
+  end
+
+  def self.right
+    Coordinates.new(1, 0)
+  end
+
+  def x=(value)
+    @x = value
+  end
+
+  def y=(value)
+    @y = value
+  end
+end

data/lib/fantasy/draggable.rb

@@ -0,0 +1,27 @@
+module Draggable
+  def drag
+    puts "XXX: dragging 1 #{name}"
+    mouse_position = Global.mouse_position
+
+    puts "@draggable_on_debug: #{@draggable_on_debug}"
+    puts "@dragging: #{@dragging}"
+    puts "Gosu.button_down?(Gosu::MS_LEFT): #{Gosu.button_down?(Gosu::MS_LEFT)}"
+    puts "collision: #{Utils.collision_at?(self, mouse_position.x, mouse_position.y)}"
+
+    if @draggable_on_debug && !@dragging && Gosu.button_down?(Gosu::MS_LEFT) && Utils.collision_at?(self, mouse_position.x, mouse_position.y)
+      puts "XXX: dragging start #{name}"
+      @dragging = true
+      @dragging_offset = mouse_position - @position
+    end
+
+    if @dragging && !Gosu.button_down?(Gosu::MS_LEFT)
+      puts "XXX: dragging end #{name}"
+      @dragging = false
+    end
+
+    if @dragging
+      puts "XXX: dragging 3 #{name}"
+      @position = mouse_position - @dragging_offset
+    end
+  end
+end

data/lib/fantasy/global.rb

@@ -0,0 +1,106 @@
+require "ostruct"
+
+module Global
+  class << self
+    attr_accessor :actors, :hud_texts, :hud_images, :clocks
+    attr_accessor :debug
+    attr_accessor :setup_proc, :loop_proc, :button_proc
+    attr_accessor :presentation_proc, :game_proc, :end_proc
+
+    attr_accessor :space_bar_proc
+    attr_accessor :cursor_up_proc, :cursor_down_proc, :cursor_left_proc, :cursor_right_proc
+    attr_accessor :mouse_button_left_proc, :mouse_button_right_proc
+
+    attr_accessor :background
+
+    attr_accessor :game
+    attr_reader :frame_time # delta_time
+    attr_reader :pixel_font
+    attr_reader :references
+    attr_reader :camera
+    attr_reader :game_state
+
+    def initialize
+      puts "Global.initialize"
+      @actors = []
+      @hud_texts = []
+      @hud_images = []
+      @clocks = []
+      @last_frame_at = Time.now
+      @debug = false
+      @pixel_font = Gosu::Font.new(20, { name: "#{__dir__}/../fonts/VT323-Regular.ttf" } )
+      @d_key_pressed = false
+      @references = OpenStruct.new
+      @camera = Camera.new(position: Coordinates.zero)
+      @game_state = Global.presentation_proc.nil? ? "game" : "presentation"
+
+      @presentation_proc = Global.default_on_presentation if @presentation_proc.nil?
+      @game_proc = Global.default_on_game if @game_proc.nil?
+      @end_proc = Global.default_on_end if @end_proc.nil?
+      @paused = false
+    end
+
+    def update
+      @frame_time = Time.now - @last_frame_at
+      @last_frame_at = Time.now
+
+      if Gosu.button_down?(Gosu::KB_D) && !@d_key_pressed
+        @debug = !@debug
+        @d_key_pressed = true
+      end
+
+      if !Gosu.button_down?(Gosu::KB_D) && @d_key_pressed
+        @d_key_pressed = false
+      end
+    end
+
+    def add_reference(name:, object:)
+      @references[name] = object
+    end
+
+    def default_on_presentation
+      Global.go_to_game
+    end
+
+    def default_on_game
+      raise "You have to define a 'on_game' block"
+    end
+
+    def default_on_end
+      Global.go_to_presentation
+    end
+
+    def go_to_presentation
+      puts "Game stage 'presentation'"
+
+      clear_state_elements
+      presentation_proc.call
+    end
+
+    def go_to_game
+      puts "Game stage 'game'"
+
+      clear_state_elements
+      game_proc.call
+    end
+
+    def go_to_end
+      puts "Game stage 'end'"
+
+      clear_state_elements
+      end_proc.call
+    end
+
+    def clear_state_elements
+      @actors.clear
+      @hud_texts.clear
+      @hud_images.clear
+      @clocks.each(&:stop)
+      @background = Color.new(r: 0, g: 0, b: 0)
+    end
+
+    def mouse_position
+      Coordinates.new(Global.game.mouse_x, Global.game.mouse_y)
+    end
+  end
+end

data/lib/fantasy/hud_image.rb

@@ -0,0 +1,46 @@
+class HudImage
+  include Draggable
+
+  attr_accessor :name, :scale, :color, :visible, :position, :layer
+
+  def initialize(position:, image_name: )
+    @image = Gosu::Image.new("#{__dir__}/../images/#{image_name}.png", { retro: true })
+    @name = image_name
+    @position = position
+    @scale = 1
+    @visible = true
+    @draggable_on_debug = true
+    @dragging = false
+    @layer = 100
+
+    Global.hud_images.push(self)
+  end
+
+  def width
+    @image.width() * @scale
+  end
+
+  def height
+    @image.height() * @scale
+  end
+
+  def move
+    drag if Global.debug
+  end
+
+  def draw
+    if visible
+      @image.draw(@position.x, @position.y, 0, @scale, @scale)
+    end
+
+    draw_debug if Global.debug
+  end
+
+  def draw_debug
+    Global.pixel_font.draw_text("#{@position.x.floor},#{@position.y.floor}", @position.x, @position.y - 20, 1)
+  end
+
+  def destroy
+    Global.hud_images.delete(self)
+  end
+end

data/lib/fantasy/hud_text.rb

@@ -0,0 +1,57 @@
+class HudText
+  attr_accessor :text, :size, :color, :visible, :layer, :in_world
+
+  def initialize(position:, text: "")
+    @position = position
+    @text = text
+    @size = "medium"
+    @color = Gosu::Color::WHITE
+    @visible = true
+    @layer = 100
+    @in_world = false
+
+    Global.hud_texts.push(self)
+  end
+
+  def move; end
+
+  def draw
+    if visible
+      Global.pixel_font.draw_markup(text, screen_position.x + scale, screen_position.y - 20 + scale, 1, scale, scale, Gosu::Color::BLACK)
+      Global.pixel_font.draw_markup(text, screen_position.x, screen_position.y - 20, 1, scale, scale, color)
+    end
+
+    draw_debug if Global.debug
+  end
+
+  def scale
+    case @size
+    when "small"
+      1
+    when "medium"
+      2
+    when "big"
+      3
+    when "huge"
+      4
+    else
+      raise "HudText.size not valid '#{@size}'. Valid sizes: 'small, medium, big, huge'"
+    end
+  end
+
+  def screen_position
+    if @in_world
+      @position - Global.camera.position
+    else
+      @position
+    end
+  end
+
+  def destroy
+    Global.hud_texts.delete(self)
+  end
+
+  def draw_debug
+    Global.pixel_font.draw_text("#{@position.x.floor},#{@position.y.floor}", @position.x, @position.y, 1)
+  end
+end

data/lib/fantasy/loop.rb

@@ -0,0 +1,55 @@
+class Game < Gosu::Window
+  def initialize
+    # TODO: require SCREEN_WIDTH and SCREEN_HEIGHT
+    super(SCREEN_WIDTH, SCREEN_HEIGHT)
+    Global.initialize
+
+    Global.presentation_proc.call()
+  end
+
+  def button_down(button_id)
+    case button_id
+    when Gosu::KB_DOWN then Global.cursor_down_proc.call unless Global.cursor_down_proc.nil?
+    when Gosu::KB_UP then Global.cursor_up_proc.call unless Global.cursor_up_proc.nil?
+    when Gosu::KB_LEFT then Global.cursor_left_proc.call unless Global.cursor_left_proc.nil?
+    when Gosu::KB_RIGHT then Global.cursor_right_proc.call unless Global.cursor_right_proc.nil?
+    when Gosu::MS_LEFT then Global.mouse_button_left_proc.call unless Global.mouse_button_left_proc.nil?
+    when Gosu::MS_RIGHT then Global.mouse_button_right_proc.call unless Global.mouse_button_right_proc.nil?
+    when Gosu::KB_SPACE then Global.space_bar_proc.call unless Global.space_bar_proc.nil?
+    end
+
+    Global.button_proc.call(button_id) unless Global.button_proc.nil?
+
+    super
+  end
+
+  def update
+    Global.update
+
+    Global.actors.each do |e|
+      e.move
+    end
+
+    Global.hud_texts.each do |e|
+      e.move
+    end
+
+    Global.hud_images.each do |e|
+      e.move
+    end
+
+    Global.loop_proc.call() unless Global.loop_proc.nil?
+  end
+
+  def draw
+    Gosu.draw_rect(0, 0, SCREEN_WIDTH, SCREEN_HEIGHT, Global.background)
+
+    (
+      Global.actors +
+      Global.hud_texts +
+      Global.hud_images
+    ).sort_by(&:layer).each do |e|
+      e.draw
+    end
+  end
+end

data/lib/fantasy/sound.rb

@@ -0,0 +1,21 @@
+module Sound
+  class << self
+    @@sounds = {}
+
+    def play(sound_name)
+      locate_sound(sound_name).play
+    end
+
+    def locate_sound(sound_name)
+      return @@sounds[sound_name] if @@sounds[sound_name]
+
+      puts "Initialize Sound: '#{sound_name}'"
+
+      base_path = "#{__dir__}/../sounds"
+      file_name = Dir.entries(base_path).find { |e| e.start_with?(sound_name) }
+      @@sounds[sound_name] = Gosu::Sample.new("#{base_path}/#{file_name}")
+
+      return @@sounds[sound_name]
+    end
+  end
+end

data/lib/fantasy/utils.rb

@@ -0,0 +1,27 @@
+module Utils
+  # https://developer.mozilla.org/en-US/docs/Games/Techniques/2D_collision_detection
+  def self.collision?(actor_1, actor_2)
+    (
+      actor_1.position.x < (actor_2.position.x + actor_2.width) &&
+      (actor_1.position.x + actor_1.width) > actor_2.position.x &&
+      actor_1.position.y < (actor_2.position.y + actor_2.height) &&
+      actor_1.position.y + actor_1.height > actor_2.position.y
+    )
+  end
+
+  def self.collision_at?(actor, x, y)
+    (
+      actor.position.x < x &&
+      (actor.position.x + actor.width) > x &&
+      actor.position.y < y &&
+      actor.position.y + actor.height > y
+    )
+  end
+
+  def self.draw_frame(x, y, width, height, stroke, color)
+    Gosu.draw_rect(x, y, width, stroke, color)
+    Gosu.draw_rect(x + (width - stroke), y, stroke, height, color)
+    Gosu.draw_rect(x, y + (height - stroke), width, stroke, color)
+    Gosu.draw_rect(x, y, stroke, height, color)
+  end
+end

data/lib/fantasy/version.rb

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

data/lib/fantasy.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require "gosu"
+
+require_relative "fantasy/version"
+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"
+require_relative "fantasy/loop"
+require_relative "fantasy/hud_text"
+require_relative "fantasy/hud_image"
+require_relative "fantasy/sound"
+require_relative "fantasy/camera"
+require_relative "fantasy/base"

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: fantasy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fernando Guillen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-11 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.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: vector2d
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+description: Simple toolbox library and lean API to build great mini games
+email:
+- fguillen.mail@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fantasy.gemspec
+- fonts/OFL.txt
+- fonts/VT323-Regular.ttf
+- lib/fantasy.rb
+- lib/fantasy/actor.rb
+- lib/fantasy/base.rb
+- lib/fantasy/camera.rb
+- lib/fantasy/clock.rb
+- lib/fantasy/color.rb
+- lib/fantasy/coordinates.rb
+- lib/fantasy/draggable.rb
+- lib/fantasy/global.rb
+- lib/fantasy/hud_image.rb
+- lib/fantasy/hud_text.rb
+- lib/fantasy/loop.rb
+- lib/fantasy/sound.rb
+- lib/fantasy/utils.rb
+- lib/fantasy/version.rb
+homepage: https://github.com/fguillen/fantasy
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/fguillen/fantasy
+  source_code_uri: https://github.com/fguillen/fantasy
+  changelog_uri: https://github.com/fguillen/fantasy/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Simple toolbox library and lean API to build great mini games
+test_files: []