yhara / dxopal

Game development framework for Opal, API compatible to DXRuby

DXOpal

Game development framework for Opal, has similar API to DXRuby

How to use

see https://yhara.github.io/dxopal/

Development

• rake build to make build/dxopal.js
• rake build_min to make build/dxopal.min.js (You need npm install -g terser)
• rake api to build yardoc
• bundle exec dxopal server to preview website

License

MIT (including images and sounds under examples/)

Acknowledgements

• Opal
• DXRuby
• Bxfr examples/apple_catcher/sounds/Explosion2.wav is made by this

Contact

https://github.com/yhara/dxopal

dxopal's Issues

Add Sound#stop

Support shift/ctrl key

Use Matter.js for collision detection?

How about implement Sprite.check with Matter.js?

Things look like useful:

• http://brm.io/matter-js/docs/classes/Engine.html#event_collisionActive
• http://brm.io/matter-js/docs/classes/Body.html#property_isSensor

Bundle singleton.rb

Algorithmic stdlibs like singleton.rb should be bundled with DXOpal.

`dxopal new` command

Currently you can use dxopal init to copy template files into the current directory, but I think dxopal new DIR is better (like rails new DIR).

Support set_color_key

Support touch events?

It is nice if our games supports mobile devices 😄

However, we need to design API for them because DXRuby does not have such events.

Touch drag invokes pull-to-refresh

When doing touch drag on Android Chrome, it is detected as pull-to-refresh gesture. Can we disable this?

dxopal server -h should print help

Current behavior: ERROR: "dxopal server" was called with arguments ["-h"]

LoadError: cannot load such file -- dxopal

I tried releasing v1.4.0 but actually it raises this error:

ERROR: LoadError
LoadError: cannot load such file -- dxopal
at Object.Opal.load (http://localhost:7521/dxopal.min.js:1:34889)
at Function.Opal.require (http://localhost:7521/dxopal.min.js:1:35120)
at eval (eval at <anonymous> (http://localhost:7521/dxopal.min.js:1:2171179), <anonymous>:10:8)
at eval (eval at <anonymous> (http://localhost:7521/dxopal.min.js:1:2171179), <anonymous>:22:3)
at http://localhost:7521/dxopal.min.js:1:2171179
at Function.$Kernel_eval$1 (http://localhost:7521/dxopal.min.js:1:2171190)
at Function.$$require_remote (http://localhost:7521/dxopal.min.js:1:2204025)
at $$1 (eval at <anonymous> (http://localhost:7521/dxopal.min.js:1:2171179), <anonymous>:8:15)
at Object.Opal.yieldX (http://localhost:7521/dxopal.min.js:1:22606)
at Function.$$call (http://localhost:7521/dxopal.min.js:1:375302)

Window.draw_box(C_WHITE) draws a gray rectangle

Example: https://qiita.com/yhara/items/c9a2a21ff24c65978205

Move ./opal to ./lib

Like https://github.com/yhara/ovto

It would be nice if we can use DXOpal as a gem, not through dxopal.js.

Resource loading does not work on v1.4.0

With DXOpal v1.4.0 (already yanked), examples which uses image/sound loading does not work.

Support multi-touch?

eg. 2-players PONG game on mobile

Unit testing

To prevent issues like #35, it is nice if we have an unit test like:

1. Run Window.draw_xx
2. Save it to a png file
3. Compare it with the correct image (maybe made with DXRuby)

dxopal server: enable access log

So that you can check which file is being accessed by the browser

z value of Window.draw () does not work

z value of Window.draw () does not work.

example.
http://blawat2015.no-ip.com/~mieki256/diary/201802241.html#201802241

I think

  sorted = @@draw_queue.sort{|a, b| a[0] == b[0] ? a[1] <=> b[1] : a[0] <=> a[1] }

->

  sorted = @@draw_queue.sort{|a, b| a[0] == b[0] ? a[1] <=> b[1] : a[0] <=> b[0] }

Implement draw_tile

No method `_loop` defined in `self`

I got this error when I upgrade opal to the newest one

`Input.mouse_down?` does not raise error

Input.mouse_down? should raise an error if the argument (M_LBUTTON, etc.) is missing.

Implement Window.fps=

Currently Window.fps = 30 raises no error but actually does nothing.

API reference displays a 404 page.

Hi. I would like to see the API reference page below, but I get a 404 page.

https://yhara.github.io/dxopal/doc/api/DXOpal/Constants/Colors.html
https://yhara.github.io/dxopal/doc/api/DXOpal/Input/KeyCodes.html
https://yhara.github.io/dxopal/doc/api/DXOpal/Input/Touch.html

However, when I executed the following command on the local machine, it was output.

yard doc -o doc/api/ lib/**/*.rb lib/**/**/*.rb

Why doesn't it appear on the github page?

Input.keyevent_target= raises NameError in Opal 1.2.0

Hi. I tried to use DXOpal with Opal 1.2.0 and NameError was raised in Input.keyevent_target= (input.rb#L96).

uninitialized class variable @@keyevent_target in DXOpal::Input
    at Opal.class_variable_get (http://localhost:7521/build/dxopal.js:918:28)
    at Function.$Input_keyevent_target$eq$9 (http://localhost:7521/build/dxopal.js:26352:21)
    at Object.Opal.send2 (http://localhost:7521/build/dxopal.js:1773:17)
    at Opal.send (http://localhost:7521/build/dxopal.js:1763:17)
    at eval (eval at <anonymous> (http://localhost:7521/index.html:2:7), <anonymous>:11:3)
    at eval (eval at <anonymous> (http://localhost:7521/index.html:2:7), <anonymous>:13:3)
    at http://localhost:7521/index.html:32:7

It seems to be caused by the following change.

Rework class variables to support inheritance correctly by hmdne · Pull Request # 2251 · opal/opal
opal/opal#2251

Steps to reproduce

ruby -v
  => ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [x86_64-linux]

git log -1 --oneline
  => 45a9605 (HEAD -> master, tag: v1.5.2, origin/master, origin/HEAD) v1.5.2

Edit Gemfile

-gem 'opal'
-gem 'opal-sprockets'
-gem 'c_lexer'
+gem 'opal', '1.2.0'
+# gem 'opal-sprockets'
+# gem 'c_lexer'

bundle config set --local path 'vendor/bundle'
bundle install

bundle exec opal -v
  => Opal v1.2.0

bundle exec rake build
bundle exec dxopal server
# Open http://localhost:7521/index.html and see developer console.

Add hsl2rgb as utility

DXOpal 1.4.1 does not work with non-ascii comments

I found that if main.rb contains Japanese comments, opal raises parse error 😱

Reported to upstream. opal/opal#2066

Sound loop

Sound#play should take optional argument loop (boolean, default is false)

Add source.loop = true; here
https://github.com/yhara/dxopal/blob/master/lib/dxopal/sound.rb#L48

Upgrade Opal to >= 1.0.4

Now that opal/opal#2066 is fixed, we can update opal when the next version is released. (refs #25)

Presentation at RubyKaigi2017

http://rubykaigi.org/2017/presentations/yhara.html

Finish implementation of collision detection

Image#[]= paints nothing

Regression caused by 4c6634a

Issues related to mouse events

Hi. I wrote sample code for a mouse event like this.

require 'dxopal'
include DXOpal

Window.load_resources do
  Window.loop do
    case
    when Input.mouse_release?(M_MBUTTON)
      p 'Middle mouse release'
    when Input.mouse_down?(M_MBUTTON)
      p 'Middle mouse down'
    when Input.mouse_release?(M_LBUTTON)
      p 'Left mouse release'
    when Input.mouse_down?(M_LBUTTON)
      p 'Left mouse down'
    end
  end
end

After that, I checked the operation with a browser.

I clicked the left mouse button.
The following is displayed on the browser console.

Left mouse down
Left mouse release

I clicked the middle mouse button.

Middle mouse down
Middle mouse release

I clicked the left mouse button again.

Left mouse down
Middle mouse release  (unexpected result)

The problem seems to be that the return value of ev.buttons (lib/dxopal/input.rb) when mouseup is always 0.

How to maximize the Window

idea:

Window.width = nil   # maxmize width
Window.height = nil  # maximize height
Window.load_resources do
  # ...

"XML parse error" on Firefox

(Note: this is already fixed but filing this as a note.)

The following error is shown in the developer console when I opened starter_kit/index.html on Mac Firefox 59.

Error is not shown when I run it with the dxopal server command.

The "=begin ~ =end " comment causes an error when the new line code is CR+LF.

When I wrote a comment in my code using "=begin ~ =end", an error has occurred.
In this case it occurs only in the CR+LF new line code, and does not occur in the LF new line code.
(the character code is UTF-8)

・Firefox, Safari/ macOS High Sierra
・Firefox/ Windows 7

index.html: How to invalidate cache

From mobile browsers, disabling cache is not so easy as PC browsers (where you can just use DevTools.)

How about passing timestamp like main.rb?2020012702111234?