minigl 2.3.7 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6623569ecf1fbd81357b4fe2e06b22024c2ce05829298750e1574e08a02b2706
-  data.tar.gz: ded142065a95df7c458d873a6c2049f4229f3fd40863872fdf19033f07331635
+  metadata.gz: a0cbb7ddb129a7fea30f09ad6d5c89b3cef8b9b9b83d5f7f9eeacc76b09227ca
+  data.tar.gz: 7297a8c63e1df8cf85d6d61ccfa4fd80cdf8676dc06fe8467aca522ab10bbe38
 SHA512:
-  metadata.gz: 6cbb8a59c7b77104a1a8bba97d2ab740520cc6987eda4761e438b8b36fcd30b85eaacaa6caab32884118f52dadf3b763718017114db25b09b6f416dd7e1d5588
-  data.tar.gz: 6b3db4da549096602dc258f26101f665713422f510f5623cf7e53bdb1940226dd4a97740e44446a60554e6e1ea29abfb981355ac3caa2006e8111b32dc3aa9d2
+  metadata.gz: 0ceda66b6723094d415a11d23cd3c0c5b69a496fe655f7f7a72cb7298bd5606f38d8755d9868a7e878e6a27a56350c2dbe9e513e4d3c247c7ac504a9356bd9b5
+  data.tar.gz: 8d1dd2b962d597547d54f51e18b2332ec201bbbca19f4fc1d3a584b52bb979937366c9f11719b05ce07fba43aade40137df270530e60935f56cc99b9b36d052f

data/README.md

@@ -17,10 +17,10 @@ to victordavidsantos@gmail.com.
 ## Made with MiniGL
 
 Below are two full games built with MiniGL, both available for free download and also open source.
-* [Super Bombinhas](https://victords.itch.io/super-bombinhas) ([source](https://github.com/victords/super-bombinhas))
-* [ConnecMan](https://victords.itch.io/connecman) ([source](https://github.com/victords/connecman))
+* [Super Bombinhas](https://github.com/victords/super-bombinhas)
+* [ConnecMan](https://github.com/victords/connecman)
 
-*Super Bombinhas* is also available on [Steam](https://store.steampowered.com/app/1553840).
+If you create a project using MiniGL, feel free to open a PR to include it in this list.
 
 ## Installing
 
@@ -37,10 +37,9 @@ 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.7
+## Version 2.4.0
 
-  * Exposed the `Panel#controls`, `TextField#focused` and `DropDownList#open` properties.
-  * Fixed a bug when clicking overlapping buttons: only the click action of the button with highest z-index (or last updated if z-indexes are the same) will be triggered. **WARNING**: the click callback will only be executed if `Mouse.update` is called after the click happened. If you call `Mouse.update` every frame (which is recommended), there's nothing to worry about.
+  * Added the `Localization` class! Check out [the documentation](http://www.rubydoc.info/gems/minigl/MiniGL/Localization) to learn more.
 
 ## 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

@@ -304,6 +304,14 @@ module MiniGL
     # This is +true+ when the effect's lifetime has already passed.
     attr_reader :dead
 
+    # The lifetime of the effect, in updates, i.e., how many calls to +update+
+    # must happen before the effect is marked as +dead+, since its creation.
+    attr_reader :lifetime
+
+    # The number of times +update+ has been called for this effect, while it
+    # was still active (not +dead+).
+    attr_reader :elapsed_time
+
     # Creates a new Effect.
     #
     # Parameters:
@@ -352,7 +360,7 @@ module MiniGL
       end
 
       super x, y, img, sprite_cols, sprite_rows
-      @timer = 0
+      @elapsed_time = 0
       if indices
         @indices = indices
       else
@@ -369,15 +377,21 @@ module MiniGL
 
     # Updates the effect, animating and counting its remaining lifetime.
     def update
-      unless @dead
-        animate @indices, @interval
-        @timer += 1
-        @dead = true if @timer == @lifetime
-      end
+      return if @dead
+
+      animate(@indices, @interval)
+      @elapsed_time += 1
+      @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)
       super unless @dead
     end
+
+    # The remaining number of calls to +update+ until the effect is marked
+    # +dead+.
+    def time_left
+      @lifetime - @elapsed_time
+    end
   end
 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/text.rb

@@ -11,9 +11,18 @@ module MiniGL
   #   if a character fits in the current line it must not be placed in the next
   #   one. In the last line there can be any amount of free space at the end.
   class ImageFont
+    # A string containing the characters supported by this font.
+    attr_reader :chars
+
     # The height of this font in pixels.
     attr_reader :height
 
+    # The width of the white space character in this font, in pixels.
+    attr_reader :space_width
+
+    # The spacing between characters, in pixels (can be a decimal number).
+    attr_reader :char_spacing
+
     # Creates an +ImageFont+.
     #
     # Parameters:
@@ -26,16 +35,19 @@ module MiniGL
     #          as they appear in the +chars+ string.
     # [height] The height of the lines in the image (see description above).
     # [space_width] The width of the white space character in this font.
+    # [char_spacing] The spacing between non-white-space characters when writing text with
+    #                this font. It can be a decimal number, useful when scaling the text up.
     # [global] Parameter that will be passed to +Res.img+ when loading the image.
     # [ext] Parameter that will be passed to +Res.img+ when loading the image.
     # [retro] Parameter that will be passed to +Res.img+ when loading the image.
-    def initialize(img_path, chars, widths, height, space_width, global = true, ext = '.png', retro = nil)
+    def initialize(img_path, chars, widths, height, space_width, char_spacing = 0, global = true, ext = '.png', retro = nil)
       retro = Res.retro_images if retro.nil?
       img = Res.img(img_path, global, false, ext, retro)
       @chars = chars
       @images = []
       @height = height
       @space_width = space_width
+      @char_spacing = char_spacing
       wa = widths.is_a?(Array)
       if wa && widths.length != chars.length
         raise 'Wrong widths array size!'
@@ -60,7 +72,17 @@ module MiniGL
     # Parameters:
     # [text] The string to be measured
     def markup_width(text)
-      text.chars.reduce(0) { |w, c| if c == ' '; w += @space_width; else; i = @chars.index(c); w += i ? @images[i].width : 0; end }
+      w = 0
+      text.chars.each_with_index do |c, i|
+        if c == ' '
+          w += @space_width
+        else
+          idx = @chars.index(c)
+          w += idx ? @images[idx].width : 0
+          w += @char_spacing if i < text.chars.size - 1
+        end
+      end
+      w
     end
 
     # See <code>Gosu::Font#draw_markup_rel</code> for details.
@@ -82,7 +104,7 @@ module MiniGL
         i = @chars.index(c)
         next if i.nil?
         @images[i].draw(x, y, z, scale_x, scale_y, color)
-        x += scale_x * @images[i].width
+        x += (scale_x * (@images[i].width + @char_spacing)).round
       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.7
+  version: 2.4.0
 platform: ruby
 authors:
 - Victor David Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-28 00:00:00.000000000 Z
+date: 2022-03-29 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