search

darktable-org / lua-scripts

151 stars 110 forks source link

example slider mimic script for x-touch mini #409

Closed dterrahe closed 1 year ago

dterrahe commented 1 year ago

An example script that sets up 8 mimic sliders that the x-touch's 8 knobs can be mapped to and that will then send any moves to the currently focused module or default.

For this to be useful, the users has to set up the mappings. This can be easily done in the shortcuts dialog or via import of a shortcuts file: None;midi:CC1=lua/x-touch/knob 1 None;midi:CC2=lua/x-touch/knob 2 None;midi:CC3=lua/x-touch/knob 3 None;midi:CC4=lua/x-touch/knob 4 None;midi:CC5=lua/x-touch/knob 5 None;midi:CC6=lua/x-touch/knob 6 None;midi:CC7=lua/x-touch/knob 7 None;midi:CC8=lua/x-touch/knob 8

Do I understand correctly that the best practice for documenting this would be in a second comment block at the top and that this would be fully shown as a tooltip in the script manager?

dterrahe commented 1 year ago

If this script were publicly available on 4.4 launch I would like to mention it in the release notes here https://github.com/darktable-org/darktable/blame/2e0a7bdca80077824cc889ed7a1dfbd482cb38d6/RELEASE_NOTES.md?plain=1#L502

wpferguson commented 1 year ago

Do I understand correctly that the best practice for documenting this would be in a second comment block at the top and that this would be fully shown as a tooltip in the script manager?

Yes

If this script were publicly available on 4.4 launch I would like to mention it in the release notes here https://github.com/darktable-org/darktable/blame/2e0a7bdca80077824cc889ed7a1dfbd482cb38d6/RELEASE_NOTES.md?plain=1#L502

We can merge it when it's ready. The du.check_min_api_version("9.1.0", "x-touch") will take care of any compatibility issues.

dterrahe commented 1 year ago

As far as I'm concerned, this is ready for merging. As mentioned, I'd like to refer to it in the 4.4 release notes, so should be in place by then. I'd also want to point to this script in the updated dtdocs article on midi. https://github.com/darktable-org/dtdocs/blob/4a1df263b90f7ed103732bfa036e82eefcdd62bc/content/special-topics/midi-device-support.md

wpferguson commented 1 year ago

You must have been reading my mind. When I saw the commit I was going to tell you to let me know when it was ready :smiley:

wpferguson commented 1 year ago

Thanks @dterrahe