reight 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f71e95252b70e9d2cf1eb2ec6022d58912ccb4409a583b30f2bb9a63926d6216
-  data.tar.gz: b3abfeb44477f44f79eaea1323f47eeef1e41d9bdcff6bf8c67991a4362d7055
+  metadata.gz: f33c4762be06696447cc2975a6363c5865325115c438d6d2ba62bae45f0c1362
+  data.tar.gz: 785b2dc2beb430356875301d0ca8a4423bcea7327789055878e76ea5f0a13c33
 SHA512:
-  metadata.gz: 254f31c3435558aac8e57f65346a4f4e5f72eef0bf6c2a70e6cba20c248111c5b7ea8896cf6d37ebfce7c40ec85f0b231c45f2a90dc7ac8c2bdd83b9586e36cf
-  data.tar.gz: 4cbcedca74269acc8f29ee80826a0691fff58b4c0c201c685f009ea09a6a2db76f78e5c17ba2f9b953c1f2ca21f3dc5b805d909ce8e209787d9a246425fd429d
+  metadata.gz: 825762a3025e5270621ad31e0f85994509adc2c9e504e4ff820bcb22bf453b263813ebc8c0a29574489943ace7e30c8d1384e7d2b1ac33ed7a3fa3cae2e6b4ca
+  data.tar.gz: 12bb191d3da0b11a72692157fd9d68c4598042ddb0ea8c5d36261d2fd8195765719a5fc4f4423996f8e16dd4bc923b213954e7bf839b9d7e23a643d96659f0d6

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+## Pull Requests Not Accepted 🚫
+
+Thank you for your interest in contributing!
+However, this repository does not accept pull requests directly.
+
+### Where to Contribute?
+
+Please submit your changes to the [xord/all](https://github.com/xord/all) monorepo, which serves as the primary repository for all our main libraries.
+
+For more details, please refer to our [contribution guidelines](../CONTRIBUTING.md).
+
+Thanks for your understanding! 🙌

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contribution Guide
+
+Thank you for your interest in contributing!
+However, this repository does not accept pull requests.
+Instead, please submit your changes to the [xord/all](https://github.com/xord/all) monorepo, which serves as the primary repository for all our main libraries.
+
+For any questions, feel free to open an issue.

data/ChangeLog.md

@@ -1,6 +1,30 @@
 # reight ChangeLog
 
 
+## [v0.1.8] - 2025-03-24
+
+- Add '--edit' command-line option to enable edit mode
+- Add Text#editable?
+- Add SpriteEditor::chips_index
+- Add frame_changed and selection_changed to Sprite::Canvas
+- Add Index control for maps
+- Add PULL_REQUEST_TEMPLATE.md
+- Add CONTRIBUTING.md
+- Update layout
+- Share the chips.rb
+- Move chip_sizes above chips
+- Refine visuals of button and index
+- Index has min and max
+- Text::initialize can take 'align:' keyword parameter
+- The text input area will not be shaked if the value determined by the click is empty
+- Fix the text value if not reverted on exiting edit mode with invalid value
+- Delete App#name
+- Simplify inspect() text
+- Update readme: Add link to examples (by @kaibadash)
+
+- Fix some crashes
+
+
 ## [v0.1.7] - 2025-03-07
 
 - Add Reight::Context

data/README.md

@@ -1,4 +1,3 @@
-
 # Reight - A Retro Game Engine for Ruby
 
 Reight is an open-source Ruby library inspired by the powerful [Processing](https://processing.org/) API, designed to make creative coding accessible and enjoyable for everyone. With support for both Mac and Windows, this library brings the joy of visual programming to Ruby developers.
@@ -38,20 +37,22 @@ Here’s a simple example to get you started:
 # Create a window and draw something
 draw do
   background 0
-	$sprites ||= project.maps.first.map(&:to_sprite)
-	sprite $sprites
+  $sprites ||= project.maps.first.map(&:to_sprite)
+  sprite $sprites
 end
 ```
 
 Run the script and watch your window come to life!
 
-```
+```bash
 $ bundle exec r8 .
 ```
 
+You can find example projects in [xord/reight-examples](https://github.com/xord/reight-examples).
+
 ## Documentation
 
-Comprehensive documentation and guides can be found [here](https://www.rubydoc.info/gems/reight/0.1/index).
+Comprehensive documentation and guides can be found [here](https://www.rubydoc.info/gems/reight/).
 
 ## License
 

data/Rakefile

@@ -29,5 +29,5 @@ build_ruby_gem
 task :run do
   libs = %w[xot rucy beeps rays reflex processing rubysketch]
     .map {|lib| "-I#{ENV['ALL']}/#{lib}/lib"}
-  sh %( ruby #{libs.join ' '} -Ilib bin/r8 '#{ENV["dir"] || "."}' )
+  sh %( ruby #{libs.join ' '} -Ilib bin/r8 --edit '#{ENV["dir"] || "demo/hello"}' )
 end

data/VERSION

@@ -1 +1 @@
-0.1.7
+0.1.8

data/bin/r8

@@ -1,21 +1,31 @@
 #!/usr/bin/env ruby
 
+require 'optparse'
 require 'reight'
-using Reight
 
 
-def r8 = $r8__
+opt         = OptionParser.new
+opt.banner  = "Usage: r8 [options] [DIR]"
+opt.version = Reight::Extension.version
+
+opt.on      '-e', '--edit', "edit mode"
+opt.on_tail '-h', '--help'
+
+params = {}
+argv   = opt.parse! ARGV, into: params
 
-def usage()
-  <<~END
-    USAGE: r8 [path]
-  END
+if params.key? :help
+  puts opt.help
+  exit
 end
 
+
+def r8 = $r8__
+
 Reight::CONTEXT__.tap do |c|
-  path = ARGV.shift or return puts usage
+  path = argv.shift || '.'
   path = File.expand_path path, Dir.pwd unless path.start_with?('/')
-  c.setup          {Reight::R8.new(path).setup}
+  c.setup          {Reight::R8.new(path, edit: params[:edit]).setup}
   c.draw           {r8.draw}
   c.key_pressed    {r8.key_pressed}
   c.key_released   {r8.key_released}

data/lib/reight/all.rb

@@ -36,6 +36,7 @@ require 'reight/sound'
 require 'reight/app'
 require 'reight/app/navigator'
 require 'reight/app/runner'
+require 'reight/app/chips'
 require 'reight/app/sprite'
 require 'reight/app/map'
 require 'reight/app/sound'

data/lib/reight/app/chips.rb

@@ -0,0 +1,124 @@
+using Reight
+
+
+class Reight::App::Chips
+
+  include Reight::Hookable
+
+  def initialize(
+    app, chips, size = 8,
+    page_width  = app.project.chips_page_width,
+    page_height = app.project.chips_page_height)
+
+    hook :frame_changed
+    hook :offset_changed
+
+    @app, @chips = app, chips
+    @page_size   = create_vector page_width, page_height
+    @offset      = create_vector 0, 0
+
+    set_frame 0, 0, size, size
+  end
+
+  attr_reader :x, :y, :size, :offset
+
+  def chip = @chips.at x, y, size, size
+
+  def set_frame(x, y, w = size, h = size)
+    raise 'Chips: width != height' if w != h
+    @x    = align_to_grid(x).clamp(0..@chips.image.width)
+    @y    = align_to_grid(y).clamp(0..@chips.image.height)
+    @size = w
+    frame_changed! @x, @y, @size, @size
+  end
+
+  def offset=(pos)
+    sp      = sprite
+    x       = pos.x.clamp([-(@chips.image.width  - sp.w), 0].min..0)
+    y       = pos.y.clamp([-(@chips.image.height - sp.h), 0].min..0)
+    offset  = create_vector x, y
+    return if offset == @offset
+    @offset = offset
+    offset_changed! @offset
+  end
+
+  def index2offset(index)
+    pw, ph = @page_size.x.to_i, @page_size.y.to_i
+    size   = @chips.image.width / pw
+    create_vector -(index % size).to_i * pw, -(index / size).to_i * ph
+  end
+
+  def offset2index(offset = self.offset)
+    iw     = @chips.image.width
+    pw, ph = @page_size.x.to_i, @page_size.y.to_i
+    x, y   = (-offset.x / ph).to_i, (-offset.y / pw).to_i
+    w      = (iw / pw).to_i
+    y * w + x
+  end
+
+  def draw()
+    sp = sprite
+    clip sp.x, sp.y, sp.w, sp.h
+
+    fill 0
+    no_stroke
+    rect 0, 0, sp.w, sp.h
+
+    translate offset.x, offset.y
+    draw_offset_grids
+    image @chips.image, 0, 0
+    draw_frame
+  end
+
+  def draw_offset_grids()
+    no_fill
+    stroke 50
+    iw, ih = @chips.image.width, @chips.image.height
+    cw, ch = @page_size.x, @page_size.y
+    (cw...iw).step(cw) {|x| line x, 0, x,  ih}
+    (ch...ih).step(ch) {|y| line 0, y, iw, y}
+  end
+
+  def draw_frame()
+    no_fill
+    stroke 255
+    stroke_weight 1
+    rect @x, @y, @size, @size
+  end
+
+  def mouse_pressed(x, y)
+    @prev_pos = create_vector x, y
+  end
+
+  def mouse_released(x, y)
+  end
+
+  def mouse_dragged(x, y)
+    pos          = create_vector x, y
+    self.offset += pos - @prev_pos if @prev_pos
+    @prev_pos    = pos
+  end
+
+  def mouse_clicked(x, y)
+    set_frame(
+      -offset.x + align_to_grid(x),
+      -offset.y + align_to_grid(y))
+  end
+
+  def sprite()
+    @sprite ||= RubySketch::Sprite.new.tap do |sp|
+      sp.draw           {draw}
+      sp.mouse_pressed  {mouse_pressed  sp.mouse_x, sp.mouse_y}
+      sp.mouse_released {mouse_released sp.mouse_x, sp.mouse_y}
+      sp.mouse_dragged  {mouse_dragged  sp.mouse_x, sp.mouse_y}
+      sp.mouse_clicked  {mouse_clicked  sp.mouse_x, sp.mouse_y}
+    end
+  end
+
+  private
+
+  def align_to_grid(n)
+    n.to_i / 8 * 8
+  end
+
+end# Chips

data/lib/reight/app/map/canvas.rb

@@ -3,8 +3,8 @@ using Reight
 
 class Reight::MapEditor::Canvas
 
-  def initialize(app, map, path)
-    @app, @map, @path      = app, map, path
+  def initialize(app, map)
+    @app, @map             = app, map
     @x, @y, @tool, @cursor = 0, 0, nil, nil, nil
   end
 
@@ -12,6 +12,10 @@ class Reight::MapEditor::Canvas
 
   attr_reader :map, :cursor
 
+  def map=(map)
+    @map = map
+  end
+
   def save()
     @app.project.save
   end

data/lib/reight/app/map/editor.rb

@@ -4,11 +4,15 @@ using Reight
 class Reight::MapEditor < Reight::App
 
   def canvas()
-    @canvas ||= Canvas.new self, project.maps.first, project.maps_json_path
+    @canvas ||= Canvas.new self, project.maps.first
   end
 
   def chips()
-    @chips ||= Chips.new self, project.chips
+    @chips ||= Chips.new(self, project.chips).tap do |chips|
+      chips.offset_changed do |offset|
+        chips_index.index = chips.offset2index offset
+      end
+    end
   end
 
   def setup()
@@ -42,25 +46,36 @@ class Reight::MapEditor < Reight::App
 
   def window_resized()
     super
+    [chip_sizes, tools].flatten.map(&:sprite)
+      .each {|sp| sp.w = sp.h = BUTTON_SIZE}
+
+    chips_index.sprite.tap do |sp|
+      sp.w, sp.h = INDEX_SIZE, BUTTON_SIZE
+      sp.x       = SPACE
+      sp.y       = NAVIGATOR_HEIGHT + SPACE
+    end
+    chip_sizes.reverse.map {_1.sprite}.each.with_index do |sp, index|
+      sp.x = SPACE + CHIPS_WIDTH - (sp.w + (sp.w + 1) * index)
+      sp.y = chips_index.sprite.y
+    end
     chips.sprite.tap do |sp|
       sp.x      = SPACE
-      sp.y      = NAVIGATOR_HEIGHT + SPACE
-      sp.w      = CHIPS_WIDTH
+      sp.y      = chip_sizes.last.sprite.bottom + SPACE
+      sp.right  = chip_sizes.last.sprite.right
       sp.bottom = height - SPACE
     end
+    map_index.sprite.tap do |sp|
+      sp.w, sp.h = INDEX_SIZE, BUTTON_SIZE
+      sp.x       = chip_sizes.last.sprite.right + SPACE
+      sp.y       = chip_sizes.last.sprite.y
+    end
     tools.map {_1.sprite}.each.with_index do |sp, index|
-      sp.w = sp.h = BUTTON_SIZE
       sp.x = chips.sprite.right + SPACE + (sp.w + 1) * index
       sp.y = height - (SPACE + sp.h)
     end
-    chip_sizes.reverse.map {_1.sprite}.each.with_index do |sp, index|
-      sp.w = sp.h = BUTTON_SIZE
-      sp.x = width - (SPACE + sp.w * (index + 1) + index)
-      sp.y = height - (SPACE + sp.h)
-    end
     canvas.sprite.tap do |sp|
-      sp.x      = chips.sprite.right + SPACE
-      sp.y      = chips.sprite.y
+      sp.x      = map_index.sprite.x
+      sp.y      = map_index.sprite.bottom + SPACE
       sp.right  = width - SPACE
       sp.bottom = tools.first.sprite.top - SPACE
     end
@@ -93,10 +108,16 @@ class Reight::MapEditor < Reight::App
   private
 
   def sprites()
-    [canvas, chips, *chip_sizes, *tools]
+    [chips_index, *chip_sizes, chips, map_index, *tools, canvas]
       .map(&:sprite) + super
   end
 
+  def chips_index()
+    @chips_index ||= Reight::Index.new max: project.chips_npages - 1 do |index|
+      chips.offset = chips.index2offset index if index != chips.offset2index
+    end
+  end
+
   def chip_sizes()
     @chip_sizes ||= group(*[8, 16, 32].map {|size|
       Reight::Button.new name: "#{size}x#{size}", label: size do
@@ -105,6 +126,12 @@ class Reight::MapEditor < Reight::App
     })
   end
 
+  def map_index()
+    @map_index ||= Reight::Index.new do |index|
+      canvas.map = project.maps[index] ||= Reight::Map.new
+    end
+  end
+
   def tools()
     @tools ||= group brush, line, stroke_rect, fill_rect
   end

data/lib/reight/app/map.rb

@@ -1,6 +1,5 @@
 require 'reight/app/map/editor'
 require 'reight/app/map/canvas'
-require 'reight/app/map/chips'
 require 'reight/app/map/tool'
 require 'reight/app/map/brush_base'
 require 'reight/app/map/brush'

data/lib/reight/app/navigator.rb

@@ -32,7 +32,7 @@ class Reight::Navigator
 
   def key_pressed()
     index = [F1, F2, F3, F4, F5].index(key_code)
-    app_buttons[index].click if index
+    app_buttons[index]&.click if index
   end
 
   def window_resized()
@@ -77,20 +77,11 @@ class Reight::Navigator
   private
 
   def app_buttons()
-    @app_buttons ||= [
-      Reight::Button.new(name: 'Run',           icon: @app.icon(0, 0, 8)) {
-        switch_app Reight::Runner
-      },
-      Reight::Button.new(name: 'Sprite Editor', icon: @app.icon(1, 0, 8)) {
-        switch_app Reight::SpriteEditor
-      },
-      Reight::Button.new(name: 'Map Editor',    icon: @app.icon(2, 0, 8)) {
-        switch_app Reight::MapEditor
-      },
-      Reight::Button.new(name: 'Sound Editor',  icon: @app.icon(3, 0, 8)) {
-        switch_app Reight::SoundEditor
-      },
-    ]
+    @app_buttons ||= r8.apps.map.with_index {|app, index|
+      Reight::Button.new(name: app.label, icon: app.icon(index, 0, 8)) {
+        r8.current = app
+      }
+    }
   end
 
   def history_buttons()
@@ -134,11 +125,6 @@ class Reight::Navigator
     @message ||= Message.new
   end
 
-  def switch_app(klass)
-    app        = r8.apps.find {_1.class == klass}
-    r8.current = app if app
-  end
-
 end# Navigator
 
 

data/lib/reight/app/runner.rb

@@ -6,6 +6,12 @@ class Reight::Runner < Reight::App
 
   TEMPORARY_HASH = {}
 
+  def label = 'Run'
+
+  def setup()
+    navigator.visible = false
+  end
+
   def activated()
     run force: true
     @context.call_activated__ {|&b| call_event(ignore_pause: true, &b)}
@@ -61,7 +67,7 @@ class Reight::Runner < Reight::App
 
   def mouse_moved()
     super
-    navigator.visible = ROOT_CONTEXT.mouse_y < NAVIGATOR_HEIGHT
+    navigator.visible = ROOT_CONTEXT.mouse_y < NAVIGATOR_HEIGHT if r8.edit?
     call_event {@context.mouse_moved}
   end
 
@@ -113,15 +119,18 @@ class Reight::Runner < Reight::App
   private
 
   def call_event(push: true, ignore_pause: false, &block)
-    return unless @context
-    @context.beginDraw__
-    @context.push if push
-    block.call unless paused?
+    if @context
+      @context.beginDraw__
+      @context.push if push
+      block.call unless paused?
+    end
   rescue ScriptError, StandardError => e
     puts e.full_message
   ensure
-    @context.pop  if push
-    @context.endDraw__
+    if @context
+      @context.pop if push
+      @context.endDraw__
+    end
   end
 
   def running? = @context && !@paused
@@ -175,6 +184,10 @@ class Reight::Runner < Reight::App
         caller.call {draw}
       end
 
+      def inspect()
+        "#<#{self.class.name}:0x#{object_id}>"
+      end
+
       methods = (instance_methods - Object.instance_methods)
         .reject {_1.end_with? '__'}
       Processing.to_snake_case__(methods).each do |camel, snake|
@@ -255,23 +268,17 @@ class Reight::Runner < Reight::App
     TEMPORARY_HASH.delete :params
   end
 
+  EXCLUDE_GLOBAL_VARS = [:$FILENAME]
+
   def backup_global_vars()
-    @global_vars = global_variables
+    @global_vars = (global_variables - EXCLUDE_GLOBAL_VARS)
       .each.with_object({}) {|name, hash| hash[name] = eval name.to_s}
       .freeze
   end
 
-  def clear_all_timers()
-    prefix = Reight::Context::TIMER_PREFIX__
-    ROOT_CONTEXT.instance_eval do
-      @timers__      .delete_if {|id| id in [prefix, _]}
-      @firingTimers__.delete_if {|id| id in [prefix, _]}
-    end
-  end
-
   def restore_global_vars()
     return unless @global_vars
-    global_variables
+    (global_variables - EXCLUDE_GLOBAL_VARS)
       .map    {|name| [name, eval(name.to_s)]}
       .select {|name, value| value != nil && @global_vars[name] == nil}
       .each   {|name, value| global_var_set name, nil}
@@ -289,4 +296,12 @@ class Reight::Runner < Reight::App
     TEMPORARY_HASH.delete :value
   end
 
+  def clear_all_timers()
+    prefix = Reight::Context::TIMER_PREFIX__
+    ROOT_CONTEXT.instance_eval do
+      @timers__      .delete_if {|id| id in [prefix, _]}
+      @firingTimers__.delete_if {|id| id in [prefix, _]}
+    end
+  end
+
 end# Runner

data/lib/reight/app/sound/editor.rb

@@ -107,7 +107,7 @@ class Reight::SoundEditor < Reight::App
 
   def bpm()
     @bpm ||= Reight::Text.new(
-      canvas.sound.bpm, label: 'BPM ', regexp: /^\-?\d+$/
+      canvas.sound.bpm, label: 'BPM ', regexp: /^\-?\d+$/, editable: true
     ) do |str, text|
       bpm = str.to_i.clamp(0, Reight::Sound::BPM_MAX)
       next text.revert if bpm <= 0

data/lib/reight/app/sprite/canvas.rb

@@ -6,6 +6,8 @@ class Reight::SpriteEditor::Canvas
   include Reight::Hookable
 
   def initialize(app, image, path)
+    hook :frame_changed
+    hook :selection_changed
     hook :color_changed
 
     @app, @image, @path       = app, image, path
@@ -34,7 +36,7 @@ class Reight::SpriteEditor::Canvas
     new            = correct_bounds x, y, w, h
     return if new == old
     @x, @y, @w, @h = new
-    @app.history.append [:frame, old, new]
+    frame_changed! old, new
   end
 
   def frame = [x, y, w, h]
@@ -50,7 +52,7 @@ class Reight::SpriteEditor::Canvas
     new        = correct_bounds x, y, w, h
     return if new == old
     @selection = new
-    @app.history.append [:select, old, new]
+    selection_changed! old, new
   end
 
   def selection()
@@ -65,7 +67,7 @@ class Reight::SpriteEditor::Canvas
   def deselect()
     return if @selection == nil
     old, @selection = @selection, nil
-    @app.history.append [:deselect, old]
+    selection_changed! old, nil
   end
 
   def paint(&block)