dxopal 1.0.0 → 1.1.0

data/doc/api/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.9.9
+    &mdash; Documentation by YARD 0.9.12
   
 </title>
 
@@ -100,9 +100,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Oct 17 13:56:27 2017 by
+  Generated on Mon Feb  5 16:56:40 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.9 (ruby-2.4.2).
+  0.9.12 (ruby-2.4.2).
 </div>
 
     </div>

data/doc/en/index.html

@@ -83,6 +83,18 @@ $ dxopal server</code></pre>
           </li>
         </ul>
 
+        <h2>FAQ</h2>
+        <h3>Why is dxopal.js so big?</h3>
+        <p>
+        Because it contains the whole opal processor, so that you will
+        not be bothered by how to compile your game files into JS.
+        </p>
+        <p>
+        Technically you can reduce the file size by commenting out
+        <code>require "opal-parser"</code> in opal/dxopal.rb and
+        building your own .js (including your game).
+        </p>
+
       </section>
       <footer>
         <p><small>Hosted on <a href="https://pages.github.com">GitHub Pages</a> using the <a href='https://github.com/pages-themes/dinky'>Dinky theme</a></small></p>

data/doc/ja/index.html

@@ -82,6 +82,15 @@ $ dxopal server</code></pre>
           </li>
         </ul>
 
+        <h2>FAQ</h2>
+        <h3>dxopal.jsのサイズがけっこう大きいのはなぜ？</h3>
+        <p>
+        Opal処理系がまるごと入っているからです。その代わり、作ったゲームをJavaScriptに変換する手順を気にしなくて済むというメリットがあります。
+        </p>
+        <p>
+        技術的には、opal/dxopal.rbの<code>require "opal-parser"</code>をコメントアウトして、作ったゲームと一緒に.jsに変換すればより小さいサイズで済むはずです。
+        </p>
+
       </section>
       <footer>
         <p><small>Hosted on <a href="https://pages.github.com">GitHub Pages</a> using the <a href='https://github.com/pages-themes/dinky'>Dinky theme</a></small></p>

data/dxopal.gemspec

@@ -20,10 +20,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "opal", "~> 0.10.5"
+  spec.add_runtime_dependency "opal", "~> 0.11.0"
   spec.add_runtime_dependency "thor", "~> 0.19.1"
   spec.add_runtime_dependency "rack", "~> 2.0"
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "yard", "~> 0.9.9"
+  spec.add_development_dependency "yard", "~> 0.9.12"
+  spec.add_development_dependency "opal-sprockets", "~> 0.4.1"
 end

data/exe/dxopal

@@ -31,14 +31,16 @@ module DXOpal
     end
 
     desc "server", "Start local server"
+    option "port", aliases: :p, type: :numeric, default: 7521
     def server
       puts "Starting DXOpal Server"
-      puts "(Open http://localhost:7521/index.html in browser)"
+      puts "(Open http://localhost:#{options[:port]}/index.html in the browser)"
       puts "---"
       app = Rack::Directory.new(Dir.pwd)
-      Rack::Server.start(app: app, Port: 7521)
+      Rack::Server.start(app: app, Port: options[:port])
     end
   end
 end
 
+puts "DXOpal v#{DXOpal::VERSION}" 
 DXOpal::Cli.start

data/index.html

@@ -23,6 +23,7 @@
         <canvas id="dxopal-canvas" style='float: left'></canvas>
         <div id="editor" style='width: 350px; height: 300px; position: relative'></div>
         <input type='button' style='float: right' id='run' value='Run'>
+        <div id="dxopal-errors"></div>
       </section>
     </div>
 
@@ -42,6 +43,7 @@
         editor.setValue(rb, -1); // -1: set cursor to document start
       });
       $('#run').on("click", function() {
+        $('#dxopal-errors').empty();
         try {
           eval(Opal.compile(editor.getValue()));
         }

data/opal/dxopal.rb

@@ -14,6 +14,8 @@ require 'dxopal/version'
 # Enable runtime compilation of Opal code (so that you can make games
 # without even install Ruby)
 require 'opal-parser'
+
+# Patch to opal-parser
 def require_remote(url)
   %x{
     var r = new XMLHttpRequest();
@@ -33,6 +35,29 @@ module DXOpal
   include DXOpal::Input::MouseCodes
   include DXOpal::SoundEffect::WaveTypes
 
+  # Call block and dump backtrace if an exception is raised.
+  # Nothing is shown if a tag with `id='dxopal-errors'` does not exist
+  def self.dump_error(&block)
+    block.call
+  rescue Exception => ex
+    div = `document.getElementById('dxopal-errors')`
+    if `div && !ex.DXOpalPrinted`
+      %x{
+        div.textContent = "ERROR: " + #{ex.class.name};
+        var ul = document.createElement('ul');
+        // Note: ex.backtrace may be an Array or a String
+        #{Array(ex.backtrace)}.forEach(function(line){
+          var li = document.createElement('li');
+          li.textContent = line;
+          ul.appendChild(li);
+        });
+        div.appendChild(ul);
+        ex.DXOpalPrinted = true;
+      }
+    end
+    raise ex
+  end
+
   # Like `Kernel.p`, but prints only limited times for each `key`
   # This is useful for debugging your game without flooding the
   # developer console.
@@ -49,6 +74,23 @@ module DXOpal
   end
 end
 
+%x{
+  // Like `console.log`, but prints only limited times.
+  // Example:
+  //   Opal.DXOpal.p_("player", player)
+  (function(){
+    var P_CT = {};
+    Opal.DXOpal.p_ = function(key, obj, n) {
+      n = (n || 10);
+      P_CT[key] = (P_CT[key] || 0);
+      if (P_CT[key] < n) {
+        console.log(key, obj);
+        P_CT[key] += 1;
+      }
+    };
+  })();
+}
+
 # `require 'dxopal'` will automatically import names like `Window` to the
 # toplevel (as `require 'dxruby'` does)
 include DXOpal

data/opal/dxopal/font.rb

@@ -1,4 +1,6 @@
 module DXOpal
+  # Represents a font
+  # Used by Window.draw_font, etc.
   class Font
     def self.default; @@default ||= Font.new(24); end
     def self.default=(f); @@default = f; end

data/opal/dxopal/image.rb

@@ -1,6 +1,8 @@
 require 'dxopal/remote_resource'
 
 module DXOpal
+  # Represents an image
+  # Each instance of Image has its own off-screen canvas.
   class Image < RemoteResource
     RemoteResource.add_class(Image)
 
@@ -53,6 +55,14 @@ module DXOpal
       return self
     end
 
+    # Draw an Image on this image with scaling
+    # - scale_x, scale_y: scaling factor (eg. 1.5)
+    # - center_x, center_y: scaling center (in other words, the point
+    #   which does not move by this scaling. Default: image center)
+    def draw_scale(x, y, image, scale_x, scale_y, center_x=nil, center_y=nil)
+      draw_ex(x, y, image, scale_x: scale_x, scale_y: scale_y, center_x: center_x, center_y: center_y)
+    end
+
     # Draw an Image on this image with rotation
     # - angle: Rotation angle (radian)
     # - center_x, center_y: Rotation center in the `image` (default: center of the `image`)
@@ -231,7 +241,7 @@ module DXOpal
     def slice(x, y, width, height)
       newimg = Image.new(width, height)
       data = _image_data(x, y, width, height)
-      newimg._put_image_data(data, 0, 0)
+      newimg._put_image_data(data)
       return newimg
     end
 
@@ -246,10 +256,27 @@ module DXOpal
       }
     end
 
+    # Set alpha of the pixels of the given color to 0
+    # - color : RGB color (If ARGV color is given, A is just ignored)
+    def set_color_key(color)
+      r, g, b, _ = _rgba_ary(color)
+      data = _image_data()
+      %x{
+        var buf = data.data;
+
+        for(var i = 0; i < buf.length; i += 4){
+          if (buf[i] == r && buf[i+1] == g && buf[i+2] == b) {
+            buf[i+3] = 0
+          }
+        }
+      }
+      _put_image_data(data)
+    end
+
     # Copy an <img> onto this image
     def _draw_raw_image(x, y, raw_img)
       %x{
-        #{@ctx}.drawImage(#{raw_img}, x, y)
+        #{@ctx}.drawImage(#{raw_img}, x, y);
       }
     end
 
@@ -259,7 +286,7 @@ module DXOpal
     end
 
     # Call .putImageData
-    def _put_image_data(image_data, x, y)
+    def _put_image_data(image_data, x=0, y=0)
       `#{@ctx}.putImageData(image_data, x, y)`
     end
 

data/opal/dxopal/input/key_codes.rb

@@ -1,9 +1,6 @@
 module DXOpal
   module Input
     module KeyCodes
-      K_SPACE = " "
-      K_X = "x"
-
       K_ESCAPE = 27
       # K_1 1
       # K_2 2

data/opal/dxopal/remote_resource.rb

@@ -2,6 +2,8 @@ module DXOpal
   # A base class for resources acquired through JS Promises.
   # Provides `<klass>.register` and `<klass>[name]`.
   # A subclass must impelment `<klass>._load`.
+  #
+  # TODO: better name? (SoundEffect is not actually 'remote')
   class RemoteResource
     # List of registered resources (Contains path_or_url)
     @@resources = Hash.new{|h,k| h[k] = {}}

data/opal/dxopal/sound_effect.rb

@@ -7,6 +7,8 @@ module DXOpal
   #     v = v - 0.03
   #     [rand(300), v]
   #   end
+  #
+  # This will generate a sound with WebAudio.
   class SoundEffect < Sound
     RemoteResource.add_class(SoundEffect)
 
@@ -79,6 +81,7 @@ module DXOpal
     end
 
     def add(wave_type=WAVE_RECT, resolution=1000)
+      TODO
     end
   end
 end

data/opal/dxopal/sprite/collision_check.rb

@@ -5,8 +5,28 @@ module DXOpal
     # Methods of Sprite related to collision checking
     module CollisionCheck
       module ClassMethods
-        # TODO: implement arguments `shot` and `hit`
+        # Run collision checking for set of sprites
+        # - offences: Sprite or [Sprite]
+        # - defences: Sprite or [Sprite]
+        # - shot: method name
+        # - hit: method name
+        #
+        # This method has two modes.
+        # - If `offences` and `defences` are the same, collision check will
+        #   be performed on each pair from the array. Method `hit` is called
+        #   on the each sprite, with the other sprite as an argument.
+        # - Otherwise, collision check will be performed on each pair
+        #   of offence sprite and defence sprite. In this case,
+        #   method `shot` is called on the offence sprite and
+        #   method `hit` is called on the defence sprite, with the
+        #   other sprite as an argument.
+        #
+        # TODO: return true if any collition is detected
+        # TODO: skip collision checking if shot/hit returned `:discard`
         def check(offences, defences, shot=:shot, hit=:hit)
+          offences = Array(offences)
+          defences = Array(defences)
+          i = j = 0  # trick to use i, j in the `#{}`
           if offences.equal?(defences)
             # any-vs-any mode
             sprites = offences.select{|x| x.is_a?(Sprite)}
@@ -14,9 +34,9 @@ module DXOpal
             %x{
               for (var i=0; i<n; i++) {
                 for (var j=i+1; j<n; j++) {
-                  if (sprites[i]['$==='](sprites[j])) {
-                    sprites[i]['$hit']();
-                    sprites[j]['$hit']();
+                  if (#{sprites[i] === sprites[j]}) {
+                    #{sprites[i].__send__(hit)};
+                    #{sprites[j].__send__(hit)};
                   }
                 }
               }
@@ -26,9 +46,9 @@ module DXOpal
             %x{
               for (var i=0; i<offences.length; i++) {
                 for (var j=0; j<defences.length; j++) {
-                  if (offences[i]['$==='](defences[j])) {
-                    offences[i]['$shot'](defences[j]);
-                    defences[j]['$hit'](offences[i]);
+                  if (#{offences[i] === defences[j]}) {
+                    #{offences[i].__send__(shot, defences[j])};
+                    #{defences[j].__send__(hit, offences[i])};
                   }
                 }
               }

data/opal/dxopal/sprite/collision_checker.rb

@@ -1,4 +1,6 @@
 # vim: set ft=javascript:
+# Collision checking algorithm, implemented in JavaScript.
+# Available as `Opal.DXOpal.CollisionChecker` in the runtime.
 %x{ (function(){
 
 var intersect = function(x1, y1, x2, y2, x3, y3, x4, y4){

data/opal/dxopal/sprite/physics.rb

@@ -1,6 +1,8 @@
 module DXOpal
   class Sprite
-    # Physics engine powered by Matter.js
+    # Experimental Matter.js (physics engine) support
+    #
+    # You need to load matter.js in advance to using these features.
     module Physics
       # Create Matter Body and register it to the World
       # - type: :rectangle, etc.
@@ -56,7 +58,9 @@ module DXOpal
 
     # Return true if `physical_body=` is ever called
     def self.matter_enabled?
-      `!!#{@matter_engine}`
+      # Note: we cannot use `!!` here because @matter_engine may be a JS object,
+      # which does not have Ruby's `!@` method
+      @matter_engine ? true : false
     end
 
     # Call Matter.Runner.tick

data/opal/dxopal/version.rb

@@ -1,3 +1,3 @@
 module DXOpal
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/opal/dxopal/window.rb

@@ -14,7 +14,9 @@ module DXOpal
     # Load resources specified with Image.register or Sound.register
     # Call block when loaded
     def self.load_resources(&block)
-      RemoteResource._load_resources(&block)
+      RemoteResource._load_resources do
+        DXOpal.dump_error(&block)
+      end
     end
 
     # Start main loop
@@ -22,8 +24,9 @@ module DXOpal
     # When called twice, previous loop is stopped (this is useful
     # when implementing interactive game editor, etc.)
     def self.loop(&block)
+      already_running = !!@@block
       @@block = block
-      `window`.JS.requestAnimationFrame{|time| _loop(time) }
+      _loop unless already_running
     end
 
     # (DXOpal original) Pause & resume
@@ -43,7 +46,7 @@ module DXOpal
     end
 
     # (internal) call @@block periodically
-    def self._loop(time)
+    def self._loop(time=0)
       @@img ||= _init(@@width, @@height)
       t0 = Time.now
 
@@ -67,7 +70,7 @@ module DXOpal
       if @@paused
         Window.draw_pause_screen
       else
-        @@block.call
+        DXOpal.dump_error(&@@block)
       end
 
       # Draw
@@ -77,6 +80,7 @@ module DXOpal
         case item[2]
         when :image then @@img.draw(*item.drop(3))
         when :image_rot then @@img.draw_rot(*item.drop(3))
+        when :image_scale then @@img.draw_scale(*item.drop(3))
         when :draw_ex then @@img.draw_ex(*item.drop(3))
         when :font then @@img.draw_font(*item.drop(3)) 
         when :pixel then @@img.[]=(*item.drop(3))
@@ -120,6 +124,10 @@ module DXOpal
       enqueue_draw(z, :image, x, y, image)
     end
 
+    def self.draw_scale(x, y, image, scale_x, scale_y, center_x=nil, center_y=nil, z=0)
+      enqueue_draw(z, :image_scale, x, y, image, scale_x, scale_y, center_x, center_y)
+    end
+
     def self.draw_rot(x, y, image, angle, center_x=nil, center_y=nil, z=0)
       enqueue_draw(z, :image_rot, x, y, image, angle, center_x, center_y)
     end
@@ -166,6 +174,7 @@ module DXOpal
       enqueue_draw(z, :triangle_fill, x1, y1, x2, y2, x3, y3, color)
     end
 
+    # (internal)
     def self.enqueue_draw(z, *args)
       @@draw_queue.push([z, @@draw_queue.length, *args])
     end

data/template/index.html

@@ -4,10 +4,13 @@
     <meta charset= "utf-8" />
     <title>DXOpal game</title>
     <script type="text/javascript" src="dxopal.min.js"></script>
-    <script type="text/ruby" src="main.rb"></script>
+    <script type="text/ruby">
+      DXOpal.dump_error{ require_remote 'main.rb' }
+    </script>
   </head>
 
   <body>
     <canvas id="dxopal-canvas"></canvas>
+    <div id="dxopal-errors"></div>
   </body>
 </html>