minigl 2.3.8 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a080b868fab24c01aaa591dcb2c5b087cc2b1bd4a86b1a649691a5e53aaa27e4
-  data.tar.gz: 117867b84b262cbc6d30adb68e0756d9d3e62246ae9fb57cd03377cc564339ed
+  metadata.gz: c0de5c7f62aa915f3f4b27bb395d9521f93f21e855192da3e0ae7e9de90b91b6
+  data.tar.gz: 1f771f1c1281032ed119d3f4717bbd181c838b124b666df6c70b1e130b298ef3
 SHA512:
-  metadata.gz: 2c1ee1a615f081b4c6b36b547c7a187553cdf91aa5f7026c35b9d6e2087d9c9b461f2b60f37f56ce20739080be5277ee99f6b4f01bc50578c6887fc18c2cbbe8
-  data.tar.gz: c000b6516264435786de8bc90858d644cbb1938128d984fd4c75938593514b07585651a5b8363e65ebbda415c151b028c934284f65e1b14cae7b3435a5bb92b5
+  metadata.gz: 745596ac394298301ef9cb3d9490aa447931a160de16505634715c888ac31d267b6b059120b15cb48d6ef7f792f889dde07bb0b5c0e41af44204c72232cc6dd0
+  data.tar.gz: 8306f0e0f22122ccd0e7df3ccf318539132b96028aee6f724ff355a9fc2fb63245f1aed8650e3bfdc9910b3868595c7a05719b04578d04034874b3ba32e8e601

data/README.md

@@ -16,9 +16,14 @@ to victordavidsantos@gmail.com.
 
 ## Made with MiniGL
 
-Below are two full games built with MiniGL, both available for free download and also open source.
+Below are some games built with MiniGL, all available for free download and also open source.
 * [Super Bombinhas](https://github.com/victords/super-bombinhas)
 * [ConnecMan](https://github.com/victords/connecman)
+* [SokoAdventure](https://github.com/victords/sokoadventure)
+* [Spheres](https://github.com/victords/spheres)
+* [Willy the droid](https://github.com/gavr-games/willy_the_droid)
+
+Download Super Bombinhas, ConnecMan, SokoAdventure and Spheres in my [itch.io page](https://victords.itch.io).
 
 If you create a project using MiniGL, feel free to open a PR to include it in this list.
 
@@ -37,10 +42,10 @@ After installing the Gosu dependencies, you can just `gem install minigl`.
   * The [wiki](https://github.com/victords/minigl/wiki) is a work in progress with tutorials and examples.
   * Test package and examples aren't complete!
 
-## Version 2.3.8
+## Version 2.4.1
 
-  * Exposed `Effect`'s `lifetime`, `elapsed_time` and `time_left` properties.
-  * Added the `char_spacing` parameter to the `ImageFont` class and exposed some existing properties.
+  * Expose `Sprite`'s `img` attribute.
+  * Fix `Effect#draw`'s `z_index` parameter.
 
 ## Contributing
 

data/lib/minigl/forms.rb

@@ -317,12 +317,12 @@ module MiniGL
       super x, y, font, text, text_color, disabled_text_color
       @over_text_color = over_text_color
       @down_text_color = down_text_color
-      if center_x; @text_x = x + @w / 2 if @w
-      else; @text_x = x + margin_x * @scale_x; end
-      if center_y; @text_y = y + @h / 2 if @h
-      else; @text_y = y + margin_y * @scale_y; end
       @center_x = center_x
       @center_y = center_y
+      @margin_x = margin_x
+      @margin_y = margin_y
+      set_position(x, y)
+
       @action = action
       @params = params
 
@@ -393,10 +393,10 @@ module MiniGL
     # [x] The new x-coordinate for the button.
     # [y] The new y-coordinate for the button.
     def set_position(x, y)
-      if @center_x; @text_x = x + @w / 2
-      else; @text_x += x - @x; end
-      if @center_y; @text_y = y + @h / 2
-      else; @text_y += y - @y; end
+      @text_x = @center_x ? x + @w / 2 : x
+      @text_y = @center_y ? y + @h / 2 : y
+      @text_x += @margin_x
+      @text_y += @margin_y
       @x = x; @y = y
     end
 
@@ -445,7 +445,7 @@ module MiniGL
     private
 
     def perform_action
-      @action.call @params if @action
+      @action.call(@params) if @action
     end
   end
 
@@ -514,8 +514,6 @@ module MiniGL
         else; height * @scale_y; end
       _, x, y = FormUtils.check_anchor(anchor, @anchor_offset_x, @anchor_offset_y, @w, @h)
       set_position(x, y)
-      @text_x = x + @w / 2 if center_x
-      @text_y = y + @h / 2 if center_y
       @checked = checked
     end
 

data/lib/minigl/game_object.rb

@@ -3,6 +3,9 @@ require_relative 'movement'
 module MiniGL
   # This class represents an (optionally animated) image inside the game screen.
   class Sprite
+    # The list of images of this sprite (i.e. the spritesheet).
+    attr_reader :img
+
     # The index of the current sprite in the spritesheet being drawn.
     attr_reader :img_index
 
@@ -384,7 +387,7 @@ module MiniGL
       @dead = true if @elapsed_time == @lifetime
     end
 
-    def draw(map = nil, scale_x = 1, scale_y = 1, alpha = 0xff, color = 0xffffff, angle = nil, z_index = 0)
+    def draw(map = nil, scale_x = 1, scale_y = 1, alpha = 0xff, color = 0xffffff, angle = nil, flip = nil, z_index = 0, round = false)
       super unless @dead
     end
 

data/lib/minigl/global.rb

@@ -245,6 +245,16 @@ module MiniGL
     def toggle_fullscreen
       self.fullscreen = !fullscreen?
     end
+
+    def button_down(id)
+      super
+      Mouse.register_button_down(id)
+    end
+
+    def button_up(id)
+      super
+      Mouse.register_button_up(id)
+    end
   end
 
   # Exposes methods for controlling keyboard and gamepad events.
@@ -387,6 +397,7 @@ module MiniGL
       def initialize
         @down = {}
         @prev_down = {}
+        @next_down = {}
         @dbl_click = {}
         @dbl_click_timer = {}
       end
@@ -394,7 +405,8 @@ module MiniGL
       # Updates the mouse position and the state of all buttons.
       def update
         @prev_down = @down.clone
-        @down.clear
+        @down = @next_down.clone
+        @next_down.delete_if { |_, v| v.zero? }
         @dbl_click.clear
 
         if @click
@@ -403,19 +415,19 @@ module MiniGL
         end
 
         @dbl_click_timer.each do |k, v|
-          if v < G.double_click_delay; @dbl_click_timer[k] += 1
-          else; @dbl_click_timer.delete k; end
+          if v < G.double_click_delay
+            @dbl_click_timer[k] += 1
+          else
+            @dbl_click_timer.delete(k)
+          end
         end
 
-        k1 = [Gosu::MsLeft, Gosu::MsMiddle, Gosu::MsRight]
-        k2 = [:left, :middle, :right]
-        (0..2).each do |i|
-          if G.window.button_down? k1[i]
-            @down[k2[i]] = true
-            @dbl_click[k2[i]] = true if @dbl_click_timer[k2[i]]
-            @dbl_click_timer.delete k2[i]
-          elsif @prev_down[k2[i]]
-            @dbl_click_timer[k2[i]] = 0
+        %i[left middle right].each do |key|
+          if @down[key]
+            @dbl_click[key] = true if @dbl_click_timer[key]
+            @dbl_click_timer.delete(key)
+          elsif @prev_down[key]
+            @dbl_click_timer[key] = 0
           end
         end
 
@@ -486,6 +498,31 @@ module MiniGL
 
         @click = { z_index: z_index, action: action }
       end
+
+      # :nodoc:
+      def register_button_down(id)
+        key = key_from_id(id)
+        @next_down[key] = 1 if key
+      end
+
+      # :nodoc:
+      def register_button_up(id)
+        key = key_from_id(id)
+        @next_down[key] = 0 if key && @next_down[key]
+      end
+
+      private
+
+      def key_from_id(id)
+        case id
+        when Gosu::MS_LEFT
+          :left
+        when Gosu::MS_RIGHT
+          :right
+        when Gosu::MS_MIDDLE
+          :middle
+        end
+      end
     end
   end
 

data/lib/minigl/localization.rb

@@ -0,0 +1,79 @@
+module MiniGL
+  # This class provides methods to easily retrieve string translations from
+  # text files.
+  class Localization
+    class << self
+      # The list of available languages. These are symbols corresponding to the
+      # names of the files in data/text, without the '.txt' extension.
+      attr_reader :languages
+
+      # The current language. It's a symbol corresponding to the name of the
+      # file in data/text for that language, without the '.txt' extension.
+      attr_reader :language
+
+      # Initializes the localization system. If you're using a custom
+      # +Res.prefix+, call this _after_ setting it.
+      #
+      # The localization system will look for files with extension '.txt' in
+      # the <code>[Res.prefix]/data/text</code> folder. In each file,
+      # each string should be specified in one line, with the following format:
+      #
+      # <code>identifier    content content content...</code>
+      #
+      # Use tab characters between the identifier and the text, not white
+      # spaces. This makes it easier to make all the texts aligned and is
+      # required for the localization system to work. The identifiers will be
+      # used as symbols when retrieving strings.
+      #
+      # The text contents support placeholders, i.e., markers that can be
+      # replaced by arguments you pass to +Localization.text+. To specify a
+      # placeholder, simply use the '$' character. For example, if your string
+      # is:
+      #
+      # <code>my_string    Values: $ and $</code>
+      #
+      # the call <code>Localization.text(:my_string, 'test', 10)</code> will
+      # result in "Values: test and 10."
+      #
+      # To include a literal '$'
+      # in the text, use '\\$' (without the quotes). Similarly, use '\\\\' to
+      # represent a literal backslash, and just '\\' to represent a line break
+      # (i.e. a "\\n" in the resulting string).
+      def initialize
+        @languages = []
+        @texts = {}
+        files = Dir["#{Res.prefix}text/*.txt"].sort
+        files.each do |f|
+          lang = f.split('/')[-1].chomp('.txt').to_sym
+          @languages << lang
+          @texts[lang] = {}
+          File.open(f).each do |l|
+            parts = l.split("\t")
+            @texts[lang][parts[0].to_sym] = parts[-1].chomp
+          end
+        end
+
+        @language = @languages[0]
+      end
+
+      # Sets the current language. +value+ must be a symbol corresponding to
+      # the name of a file in data/text, without the '.txt' extension.
+      def language=(value)
+        raise "Can't set to invalid language #{value}" unless @languages.include?(value)
+
+        @language = value
+      end
+
+      # Retrieves the string identified by +id+ in the current language.
+      #
+      # See +Localization.initialize+ for details on how to use +args+.
+      def text(id, *args)
+        value = @texts[@language][id] || '<MISSING STRING>'
+        args.each do |arg|
+          value = value.sub(/(^|[^\\])\$/, "\\1#{arg}")
+        end
+        value.gsub('\\$', '$').gsub(/\\(.|$)/) { |m| m[1] == '\\' ? '\\' : "\n#{m[1]}" }
+      end
+    end
+  end
+end

data/lib/minigl.rb

@@ -2,3 +2,4 @@ require_relative 'minigl/game_object'
 require_relative 'minigl/map'
 require_relative 'minigl/text'
 require_relative 'minigl/forms'
+require_relative 'minigl/localization'

data/test/data/text/english.txt

@@ -0,0 +1,6 @@
+str1	Common string.
+str2	String with \$ dollar sign.
+str3	$ should be replaced.
+str4	Should replace both $ and $.
+str5	String with \\ backslash.
+str6	String with\line breaks.\

data/test/data/text/portuguese.txt

@@ -0,0 +1,6 @@
+str1	String comum.
+str2	String com \$ cifrão.
+str3	$ deve ser substituído.
+str4	Deve substituir $ e $.
+str5	String com \\ barra invertida.
+str6	String com\quebras de linha.\

data/test/game.rb

@@ -19,7 +19,7 @@ class MyGame < GameWindow
     @font2 = Res.font :font1, 50
     @writer1 = TextHelper.new @font1, 5
     @writer2 = TextHelper.new @font2, 5
-    @btn = Button.new(10, 560, @font1, 'Test', :btn, 0x008000, 0x808080, 0xffffff, 0xff9980, true, true, 0, 4, 0, 0, 'friends', nil, 2, 2) { |x| puts "hello #{x}" }
+    @btn = Button.new(10, 560, @font1, 'Test', :btn, 0x008000, 0x808080, 0xffffff, 0xff9980, true, false, -10, 4, 0, 0, 'friends', nil, 2, 2) { |x| puts "hello #{x}" }
     @btn.enabled = false
     @chk =
       ToggleButton.new(x: 0, y: 30, font: @font1, text: 'Click me', img: :check, center_x: false, margin_x: 36, params: 'friends', anchor: :south) { |c, x|

data/test/localization_tests.rb

@@ -0,0 +1,41 @@
+require 'test/unit'
+require_relative '../lib/minigl'
+include MiniGL
+
+class LocalizationTest < Test::Unit::TestCase
+  def setup
+    Res.prefix = File.expand_path(File.dirname(__FILE__)) + '/data'
+    Localization.initialize
+  end
+
+  def test_languages
+    assert_equal([:english, :portuguese], Localization.languages)
+  end
+
+  def test_language
+    assert_equal(:english, Localization.language)
+    Localization.language = :portuguese
+    assert_equal(:portuguese, Localization.language)
+    assert_raise { Localization.language = :invalid }
+    assert_equal(:portuguese, Localization.language)
+  end
+
+  def test_strings
+    assert_equal('Common string.', Localization.text(:str1))
+    assert_equal('String with $ dollar sign.', Localization.text(:str2))
+    assert_equal('something should be replaced.', Localization.text(:str3, 'something'))
+    assert_equal('Should replace both 5 and true.', Localization.text(:str4, 5, true))
+    assert_equal('String with \\ backslash.', Localization.text(:str5))
+    assert_equal("String with\nline breaks.\n", Localization.text(:str6))
+    assert_equal('<MISSING STRING>', Localization.text(:str7))
+
+    Localization.language = :portuguese
+    assert_equal('String comum.', Localization.text(:str1))
+    assert_equal('String com $ cifrão.', Localization.text(:str2))
+    assert_equal('algo deve ser substituído.', Localization.text(:str3, 'algo'))
+    assert_equal('Deve substituir 5 e true.', Localization.text(:str4, 5, true))
+    assert_equal('String com \\ barra invertida.', Localization.text(:str5))
+    assert_equal("String com\nquebras de linha.\n", Localization.text(:str6))
+    assert_equal('<MISSING STRING>', Localization.text(:str7))
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minigl
 version: !ruby/object:Gem::Version
-  version: 2.3.8
+  version: 2.4.1
 platform: ruby
 authors:
 - Victor David Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-09 00:00:00.000000000 Z
+date: 2022-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -43,6 +43,7 @@ files:
 - lib/minigl/forms.rb
 - lib/minigl/game_object.rb
 - lib/minigl/global.rb
+- lib/minigl/localization.rb
 - lib/minigl/map.rb
 - lib/minigl/movement.rb
 - lib/minigl/text.rb
@@ -70,10 +71,13 @@ files:
 - test/data/img/tile2.svg
 - test/data/img/tile2b.png
 - test/data/sound/1.wav
+- test/data/text/english.txt
+- test/data/text/portuguese.txt
 - test/data/tileset/tileset1.png
 - test/game.rb
 - test/game_object_tests.rb
 - test/iso_game.rb
+- test/localization_tests.rb
 - test/map_tests.rb
 - test/mov_game.rb
 - test/movement_tests.rb
@@ -107,6 +111,7 @@ test_files:
 - test/game.rb
 - test/game_object_tests.rb
 - test/iso_game.rb
+- test/localization_tests.rb
 - test/map_tests.rb
 - test/mov_game.rb
 - test/movement_tests.rb
@@ -136,5 +141,7 @@ test_files:
 - test/data/img/tile2.svg
 - test/data/img/tile2b.png
 - test/data/sound/1.wav
+- test/data/text/english.txt
+- test/data/text/portuguese.txt
 - test/data/tileset/tileset1.png
 - test/data/img/sub/image.png