reight 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 443639fd56ce2df76ee0d57d6bc4c61c0a121e2615a0511068a9b37cc41fd4d1
-  data.tar.gz: afcf2bf4c67f3e1712a375d654ed5583af9c3473659fedb1d1129511d2d9747b
+  metadata.gz: f33c4762be06696447cc2975a6363c5865325115c438d6d2ba62bae45f0c1362
+  data.tar.gz: 785b2dc2beb430356875301d0ca8a4423bcea7327789055878e76ea5f0a13c33
 SHA512:
-  metadata.gz: c293eb4bc9281f295f5adc22007fe1e5139b9fd1c26aeb6e19374769c6476e69c0417d7d897ef94f78ee40b893c9fbcb57ddc9776881b565ef6556ee42863cc0
-  data.tar.gz: d5dab9d239a2c161cf032fff213c894eafc7bc38410ecd5883207dee2f78d1502247dd7072649d9f6dd2f779afacac15f3a42da243a8c0a1fabddccfc2902116
+  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,82 @@
 # 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
+- Add docs for Reight::Context
+- Add Reight::Sprite class
+- Add sound editor
+- Add size() and createCanvas()
+- Add App#active?
+- Project: Add clear_all_sprites()
+- Map: Add to_sprites(), sprites(), sprites_at(), clear_sprites()
+- Map::Chunk: Add sprites(), clear_sprites(), and each()
+- Chip: Add sprite(), clear_sprites(), and each()
+- Add Map::SpriteArray class
+- Add SpriteWorld#offset and SpriteWorld#zoom
+
+- Define Sprite and Sound classes in the main context
+- Change pixelsPerMeter from 100 to 8
+- createSprite() creates a new Reight::Sprite instance
+- Map: delete/delete_chip -> Map#remove/remove_chip
+- Map::Chunk: Caches drawing contents
+- Disable the '<=>' operators for Map, Map::Chunk, Chip, ChipList
+- Sound: play() accepts a block parameter that is called when playback ends
+- Sound: play() can take gain parameter
+- Sound: Default gain: 0.1 -> 0.2
+- Sound: apply envelope and gain
+- Offset the button text while it is pressed
+
+- Runner: During game execution, the Run button re-runs the game
+- Runner: Delete F10 to restart
+- Runner: Delete restart button
+- Runner: Rescue exceptions raised by user script
+- Runner: Stop all timers on stop running user script
+- Runner: runner.rb does not use 'using Reight', so define funcs in runner context
+- Runner: User script paths are relative to project directory
+
+- SpriteEditor: Black is treated as a transparent color
+- SpriteEditor: Update color palette to 32 colors
+- SpriteEditor: Show color code
+
+- SoundEditor: Cancel attack and release on successive notes to avoid click noise
+- SoundEditor: Display tone colors on each tone button
+- SoundEditor: Canvas is scrollable
+
+- Fix pick_color fails to get pixel color
+- Fix crash on moving window
+- Fix crash on switching from editer to another editor
+- Fix yard crash caused by pattern matching rightward assginment
+- Fix misaligned mouse position on sound editor canvas
+- Fix error on drawing line tool at map editor
+- Fix the angle mode of Reight::Context does not sync with root context
+
+
 ## [v0.1.6] - 2025-01-30
 
 - Update dependencies: processing, rubysketch

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

@@ -4,7 +4,7 @@
   .map  {|s| File.expand_path "#{s}/lib", __dir__}
   .each {|s| $:.unshift s if !$:.include?(s) && File.directory?(s)}
 
-require 'xot/rake'
+require 'rucy/rake'
 
 require 'xot/extension'
 require 'rucy/extension'
@@ -18,13 +18,16 @@ require 'reight/extension'
 
 EXTENSIONS = [Xot, Rucy, Beeps, Rays, Reflex, Processing, RubySketch, Reight]
 
+ENV['RDOC'] = 'yardoc --no-private'
+
 default_tasks
 test_ruby_extension
+generate_documents
 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.6
+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

@@ -21,17 +21,22 @@ end# Reight
 
 require 'reight/extension'
 require 'reight/helpers'
-require 'reight/project'
 require 'reight/history'
 require 'reight/button'
+require 'reight/text'
+require 'reight/index'
 
 require 'reight/reight'
+require 'reight/context'
+require 'reight/project'
+require 'reight/sprite'
 require 'reight/chip'
 require 'reight/map'
+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'
-require 'reight/app/music'

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/brush.rb

@@ -10,7 +10,7 @@ class Reight::MapEditor::Brush < Reight::MapEditor::BrushBase
 
   def brush(cursor_from, cursor_to, chip)
     x, y, = cursor_to
-    put_or_delete_chip x, y, chip
+    put_or_remove_chip x, y, chip
     false
   end
 

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

@@ -5,15 +5,15 @@ class Reight::MapEditor::BrushBase < Reight::MapEditor::Tool
 
   def brush(cursor_from, cursor_to, chip) = nil
 
-  def put_or_delete_chip(x, y, chip)
+  def put_or_remove_chip(x, y, chip)
     return false unless x && y && chip
     m = canvas.map
     return false if !@deleting && m[x, y]&.id == chip.id
 
     result = false
     m.each_chip x, y, chip.w, chip.h do |ch|
-      m.delete_chip ch
-      result |= history.append [:delete_chip, ch.pos.x, ch.pos.y, ch.id]
+      m.remove_chip ch
+      result |= history.append [:remove_chip, ch.pos.x, ch.pos.y, ch.id]
     end
     unless @deleting
       m.put x, y, chip

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

@@ -3,26 +3,21 @@ using Reight
 
 class Reight::MapEditor::Canvas
 
-  include Reight::Hookable
-
-  def initialize(app, map, path)
-    hook :tool_changed
-
-    @app, @map, @path      = app, map, path
+  def initialize(app, map)
+    @app, @map             = app, map
     @x, @y, @tool, @cursor = 0, 0, nil, nil, nil
   end
 
-  attr_accessor :x, :y
+  attr_accessor :x, :y, :tool
 
-  attr_reader :map, :tool, :cursor
+  attr_reader :map, :cursor
 
-  def save()
-    @app.project.save
+  def map=(map)
+    @map = map
   end
 
-  def tool=(tool)
-    @tool = tool
-    tool_changed! tool
+  def save()
+    @app.project.save
   end
 
   def set_cursor(x, y, w, h)
@@ -47,7 +42,7 @@ class Reight::MapEditor::Canvas
   end
 
   def sprite()
-    @sprite ||= Sprite.new.tap do |sp|
+    @sprite ||= RubySketch::Sprite.new.tap do |sp|
       pos = -> {to_image sp.mouse_x, sp.mouse_y}
       sp.draw           {draw}
       sp.mouse_pressed  {mouse_pressed( *pos.call, sp.mouse_button)}
@@ -76,7 +71,7 @@ class Reight::MapEditor::Canvas
     clip sp.x, sp.y, sp.w, sp.h
     translate @x, @y
 
-    fill 0, 0, 0
+    fill 0
     no_stroke
     rect(-@x, -@y, sp.w, sp.h)
 

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

@@ -4,14 +4,18 @@ 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 activated()
+  def setup()
     super
     history.disable do
       tools[0].click
@@ -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
@@ -69,8 +84,8 @@ class Reight::MapEditor < Reight::App
   def undo(flash: true)
     history.undo do |action|
       case action
-      in [:put_chip,    x, y, id] then canvas.map.delete x, y
-      in [:delete_chip, x, y, id] then canvas.map.put    x, y, project.chips[id]
+      in [:put_chip,    x, y, id] then canvas.map.remove x, y
+      in [:remove_chip, x, y, id] then canvas.map.put    x, y, project.chips[id]
       in [  :select, sel, _]      then sel ? canvas.select(*sel) : canvas.deselect
       in [:deselect, sel]         then       canvas.select(*sel)
       end
@@ -82,7 +97,7 @@ class Reight::MapEditor < Reight::App
     history.redo do |action|
       case action
       in [:put_chip,    x, y, id] then canvas.map.put    x, y, project.chips[id]
-      in [:delete_chip, x, y, id] then canvas.map.delete x, y
+      in [:remove_chip, x, y, id] then canvas.map.remove x, y
       in [  :select, _, sel]      then canvas.select(*sel)
       in [:deselect, _]           then canvas.deselect
       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/line.rb

@@ -4,7 +4,7 @@ using Reight
 class Reight::MapEditor::Line < Reight::MapEditor::BrushBase
 
   def initialize(app, &block)
-    super app, icon: app.icon(3, 2, 8), &block
+    super app, icon: app.icon(4, 2, 8), &block
     set_help left: name, right: 'Pick Chip'
   end
 
@@ -17,15 +17,15 @@ class Reight::MapEditor::Line < Reight::MapEditor::BrushBase
       dy           = fromy < toy ? chip.h : -chip.h
       if (tox - fromx).abs > (toy - fromy).abs
         (fromx..tox).step(dx).each do |x|
-          y = map x, fromx, tox, fromy, toy
+          y = fromy == toy ? toy : map(x, fromx, tox, fromy, toy)
           y = y / chip.h * chip.h
-          result |= put_or_delete_chip x, y, chip
+          result |= put_or_remove_chip x, y, chip
         end
       else
         (fromy..toy).step(dy).each do |y|
-          x = map y, fromy, toy, fromx, tox
+          x = fromx == tox ? tox : map(y, fromy, toy, fromx, tox)
           x = x / chip.w * chip.w
-          result |= put_or_delete_chip x, y, chip
+          result |= put_or_remove_chip x, y, chip
         end
       end
     end

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

@@ -5,7 +5,7 @@ class Reight::MapEditor::Rect < Reight::MapEditor::BrushBase
 
   def initialize(app, fill:, &block)
     @fill = fill
-    super app, icon: app.icon(fill ? 5 : 4, 2, 8), &block
+    super app, icon: app.icon(fill ? 6 : 5, 2, 8), &block
     set_help left: "#{fill ? 'Fill' : 'Stroke'} #{name}", right: 'Pick Chip'
   end
 
@@ -19,7 +19,7 @@ class Reight::MapEditor::Rect < Reight::MapEditor::BrushBase
       (fromy..toy).step(chip.h).each do |y|
         (fromx..tox).step(chip.w).each do |x|
           next if !@fill && fromx < x && x < tox && fromy < y && y < toy
-          result |= put_or_delete_chip x, y, chip
+          result |= put_or_remove_chip x, y, chip
         end
       end
     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'