Skip to content

feat: add generic wheel scroll and press commands #744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Keith94 wants to merge 2 commits into
base: main
Choose a base branch
from
+51 −17
Open

feat: add generic wheel scroll and press commands #744

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
842bc00
docs: add default mouse actions info
Keith94 Apr 26, 2026
0f3c224
feat: add default mouse commands
Keith94 Apr 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/USER_OPTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,12 @@ Customize the button function based on mouse actions.
| | speed_mbtn_right_command | `osd-msg set speed 1` |
| | speed_wheel_down_command | `osd-msg add speed -0.25` |
| | speed_wheel_up_command | `osd-msg add speed 0.25` |
| Default actions | default_mbtn_mid_command | `ignore` |
| | default_wheel_up_command | `ignore` |
| | default_wheel_down_command | `ignore` |

> [!NOTE]
> Commands set as default actions are applied to elements that have no explicit command defined above.

### Auto Profile

Expand Down
6 changes: 6 additions & 0 deletions modernz.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,3 +442,9 @@ speed_mbtn_left_command=osd-msg add speed 1
speed_mbtn_right_command=osd-msg set speed 1
speed_wheel_down_command=osd-msg add speed -0.25
speed_wheel_up_command=osd-msg add speed 0.25

# default mouse actions
# applied to elements that have no explicit command defined above
default_mbtn_mid_command=ignore
default_wheel_up_command=ignore
default_wheel_down_command=ignore
56 changes: 39 additions & 17 deletions modernz.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,11 @@ local user_opts = {
speed_mbtn_right_command = "osd-msg set speed 1",
speed_wheel_down_command = "osd-msg add speed -0.25",
speed_wheel_up_command = "osd-msg add speed 0.25",

-- default mouse actions (applied to elements that have no explicit command defined above)
default_mbtn_mid_command = "",
default_wheel_up_command = "",
default_wheel_down_command = "",
}

local osc_param = { -- calculated by osc_init()
Expand Down Expand Up @@ -2750,10 +2755,10 @@ local function bind_buttons(element_name, use_down)
if command ~= nil and command ~= "" and command ~= "ignore" then
elements[element_name].eventresponder["shift+mbtn_left_down"] = function() mp.command(command) end
end
for _, button in ipairs({"wheel_up", "wheel_down"}) do
local command = user_opts[element_name .. "_" .. button .. "_command"]
for _, dir in ipairs({"wheel_up", "wheel_down"}) do
local command = user_opts[element_name .. "_" .. dir .. "_command"]
if command ~= nil and command ~= "" and command ~= "ignore" then
elements[element_name].eventresponder[button .. "_press"] = function() mp.command(command) end
elements[element_name].eventresponder[dir .. "_press"] = function() mp.command(command) end
end
end
end
Expand Down Expand Up @@ -2796,6 +2801,20 @@ local function build_cache_seek_ranges()
return nranges
end

-- dynamically sets the "input" mouse area to only the hovered element
local click_keys = {
"mbtn_left_up", "mbtn_left_down", "mbtn_left_press",
"mbtn_right_up", "mbtn_right_down", "mbtn_right_press",
"wheel_up_press", "wheel_down_press",
}
local function has_click_action(e)
if not e.eventresponder then return false end
for _, k in ipairs(click_keys) do
if e.eventresponder[k] then return true end
end
return false
end

local function osc_init()
msg.debug("osc_init")

Expand Down Expand Up @@ -3353,6 +3372,23 @@ local function osc_init()

prepare_elements()
update_margins()

-- apply default mid/wheel commands to every button/slider that has no responder
local default_actions = {
["shift+mbtn_left_down"] = user_opts.default_mbtn_mid_command,
["wheel_up_press"] = user_opts.default_wheel_up_command,
["wheel_down_press"] = user_opts.default_wheel_down_command,
}
for _, element in pairs(elements) do
if (element.type == "button" or element.type == "slider") and element.eventresponder
and has_click_action(element) then
for key, command in pairs(default_actions) do
if not element.eventresponder[key] and command ~= nil and command ~= "" and command ~= "ignore" then
element.eventresponder[key] = function() mp.command(command) end
end
end
end
end
end

local function show_wc()
Expand Down Expand Up @@ -3439,20 +3475,6 @@ local function element_has_action(element, action)
return element and element.eventresponder and element.eventresponder[action]
end

-- dynamically sets the "input" mouse area to only the hovered element
local click_keys = {
"mbtn_left_up", "mbtn_left_down", "mbtn_left_press",
"mbtn_right_up", "mbtn_right_down", "mbtn_right_press",
"wheel_up_press", "wheel_down_press",
}
local function has_click_action(e)
if not e.eventresponder then return false end
for _, k in ipairs(click_keys) do
if e.eventresponder[k] then return true end
end
return false
end

local function refresh_input_area()
if not state.osc_visible then
set_virt_mouse_area(0, 0, 0, 0, "input")
Expand Down