Feature Request: Mouse Support

[rahji]

I believe BubbleTea has mouse support. It would be great to be able to respond to mouse movements and clicks.

BTW, this is a great project! I'm thinking I might use it in my creative coding course in the fall. :)

[xaviergodart]

I'm not using BubbleTea at the moment, but I'm starting to think that I should. I thought that I didn't need most of the feature it provides for Runal, but in the end, there's so much niceties available from it, including mouse support.

I'll try to switch to BubbleTea in the coming days and see how it goes.

BTW, this is a great project! I'm thinking I might use it in my creative coding course in the fall. :)

Wow this is awesome! Thanks for considering it! Don't hesitate to contact me if you need some help with that.

I'm curious though, what makes you consider Runal instead of p5js for example?

[rahji]

I'm curious though, what makes you consider Runal instead of p5js for example?

Constraints are good for art students. :) I do like the idea that even if we start out with Runal, they would see that the code translates to p5.js afterwards. Also, I like to try and interact with hardware via things like serial, midi, and osc. Those tend to be harder in a browser. I've taken to showing students how to do websockets simply in p5js and then use Chataigne to convert between other software/protocols/hardware and websockets - but, while it's a nice solution, it's often too much tech for them. It's fun to think that they could do hardware stuff in Runal, but realistically I think that would require using it with Go, which isn't going to work for them (and would also break that continuum between Runal w/js and p5.js). I did a quick Go demo of using a phone OSC client to control Runal last night. Very fun! https://github.com/rahji/runalosc I'm going to keep thinking about how I might be able to use it for teaching, but either way Runal is def going to help with some electronic poetry projects/objects I'm working on.

[xaviergodart]

Constraints are good for art students. :) I do like the idea that even if we start out with Runal, they would see that the code translates to p5.js afterwards.

It makes a lot of sense 👌

It's fun to think that they could do hardware stuff in Runal, but realistically I think that would require using it with Go, which isn't going to work for them (and would also break that continuum between Runal w/js and p5.js).

I'm actually considering supporting more protocols out of the box, so it could also work in js. I had midi and osc in mind because I do some midi stuff myself, it's pretty easy to implement, and they are really common in creative fields.
We could add new event callbacks like:

function onMidi(c, event) {
  if (event.key == "C3") {
    // do stuff
  }

  if (event.velocity > 90) {
    // do stuff
  }
}

Not sure what you would expect from a serial connection though, it would be great if you have an example to share.

I did a quick Go demo of using a phone OSC client to control Runal last night. Very fun! https://github.com/rahji/runalosc I'm going to keep thinking about how I might be able to use it for teaching, but either way Runal is def going to help with some electronic poetry projects/objects I'm working on.

Awesome. I'm glad the usage in Go is still pretty straightforward. I tend to focus more on js during development.

[rahji]

Oh yeah, I wasn´t thinking that Runal might not have the same limitations that p5js has since it´s not running in a browser. MIDI and serial can work in a browser, but not OSC. For MIDI, this is what I´ve set up for students - I like the simple onMidi() callback you showed as an option for Runal. For serial, I´ve given my students this template. It assumes that the data coming over is simply a string containing comma-separated numbers. When students want to do more than that, I work with them to come up with the code required. An onSerial() callback, like the onMidi() one might be cool. You´d have to come up with an equally simple method of sending MIDI and serial data.

[xaviergodart]

It assumes that the data coming over is simply a string containing comma-separated numbers. When students want to do more than that, I work with them to come up with the code required.

Sounds simple enough.
I just created #6, #7 and #8 for new protocol implementations.

[rahji]

Are you thinking these would work the same for Go or JavaScript?

[xaviergodart]

Yes. I don't want to maintain one API per language anyway, so IMO it must work the same for JS and Go.

[xaviergodart]

Just pushed a v0.5.0 with mouse support.

I started with a bubbletea integration, but it wasn't ideal for controlling precisely how I refresh the canvas.
The good news was that the charm team provides a standalone input package (https://github.com/charmbracelet/x/tree/main/input) that handle both keyboard and mouse events, and it works pretty well.

Closing this now, but feel free to open a new issue if things aren't working properly.

[rahji]

This is great! I'm not sure if it's just a Windows Terminal thing, but using the mouse location variables is a bit quirky. It is pretty responsive with small movements but starts to freak out a little with larger movements. I'm travelling for another few weeks and only have my laptop so I can't try it on a linux machine. It acts the same in WSL2 and Windows Command Prompt in Terminal. Let me know if you want me to file an issue or if it's understood that it will always be a bit limited given the refresh rate.

Example:

package main

import (
        "context"
        "github.com/emprcl/runal"
)

func main() {
        runal.Run(context.Background(), setup, draw, onKey, onMouse)
}

func setup(c *runal.Canvas) {
        c.Stroke("COUCOU", "#ffffff", "#000000")
        c.Fill("i", "#f40234", "#440020")
}

func draw(c *runal.Canvas) {
        c.Clear()
        c.Ellipse(c.Width/2, c.Height/2, c.MouseX, c.MouseX)
}

func onKey(c *runal.Canvas, e runal.KeyEvent) {}

func onMouse(c *runal.Canvas, e runal.MouseEvent) {}