Main menu overhaul (Part 1): Mouse controls + Vertical submenus #57764

dseguin · 2022-05-17T02:50:15Z

Summary

None

Purpose of change

Contributes to New world and start game UI improvements #57098

Describe the solution

This is just a first pass introducing some QoL improvements to the main menu:

Allow mouse controls for menu and submenu buttons (SDL only)
Standardize on vertical secondary menus
Use uilists for tertiary menus

Mouse controls

Primary, secondary and tertiary menu options are mouse accessible on SDL builds (non-curses). Moving the mouse also highlights primary and secondary menu options:

2022-05-17.04-24-41.mp4

Left-clicking on a menu item selects it and confirms the option (where applicable). Mouse movement does nothing on tertiary menus since they rely on uilist for input handling.

The mouse wheel scrolls through vertical submenu options, as well as scrollable text like the MOTD/Credits windows.

Vertical submenus

Secondary menus use a common vertical layout:

A couple of extra minor changes:

Submenus (where applicable) are automatically displayed when switching main menu options
- Menu items are navigated with LEFT/BACKTAB and RIGHT/TAB
- Submenu items are navigated with UP/PAGEUP and DOWN/PAGEDOWN
- Confirming a submenu option is done with ENTER
Hints for "New Character" options are listed on the line below the main menu options (in yellow)
Submenu hotkeys were revised to avoid conflicts with the main menu (since both are accessible at the same time)

Describe alternatives you've considered

This is just a first pass addressing some of the items from #57098 (mostly limited by the size of these changes). Future changes will address the problems with the Settings and World Options menus to round off the issue.

Testing

See clips above. Manually tested each menu and submenu item to check that they behave the same as before.

Also tested with the minimal resolution, just to make sure each submenu is accessible:

Also tested the curses build:

Additional context

I took some liberties with some of the design elements, but I think it works pretty well.

github-actions · 2022-05-17T02:51:37Z

Spell checker encountered unrecognized words in the in-game text added in this pull request. See below for details.

Click to expand

%s has no loadable characters!
A<u|U>topickup
Copy World Sett<i|I>ngs
Sa<f|F>emode

This alert is automatically generated. You can simply disregard if this is inaccurate, or (optionally) you can also add the new words to tools/spell_checker/dictionary.txt so they will not trigger an alert next time.

Night-Pryanik · 2022-05-17T02:57:38Z

Awesome!

Is it possible to highlight element that you mouse-clicked on first, and then start its function, not the way around, as it is now?

dseguin · 2022-05-17T03:04:40Z

It's possible, for sure. I'm not sure if that's the way Erk would want it, since it would add extra clicks (and on touchscreen controls you would have to tap the option twice, but tapping twice also acts as ESC)

C.C.: @I-am-Erk

Night-Pryanik · 2022-05-17T03:12:26Z

No, you misunderstood me. No need to double click: just highlight clicked option and then start its function right after that - all with one click.

dseguin · 2022-05-17T03:19:31Z

Oh I see, my mistake :P

~~The short answer is "yes", but it would add a lot of complexity.~~

Nevermind, I'm totally wrong! It's literally a 2 line change:

diff --git a/src/main_menu.cpp b/src/main_menu.cpp
index 76090b507c..014b6ff48e 100644
--- a/src/main_menu.cpp
+++ b/src/main_menu.cpp
@@ -684,6 +684,7 @@ bool main_menu::opening_screen()
                     if( sel1 == getopt( main_menu_opts::HELP ) || sel1 == getopt( main_menu_opts::QUIT ) ) {
                         action = "CONFIRM";
                     }
+                    ui_manager::redraw();
                     break;
                 }
             }
@@ -692,6 +693,7 @@ bool main_menu::opening_screen()
                     sel1 = it.second.first;
                     sel2 = it.second.second;
                     action = "CONFIRM";
+                    ui_manager::redraw();
                     break;
                 }
             }

src/main_menu.cpp

Co-authored-by: Anton Burmistrov <[email protected]>

leemuar · 2022-05-17T07:54:18Z

No, you misunderstood me. No need to double click: just highlight clicked option and then start its function right after that - all with one click.

I think it might be better to highlight on "mouse over" and to activate on click. I have no idea how to implement Mouse Over events on menu items though...

dseguin · 2022-05-17T08:37:15Z

I think it might be better to highlight on "mouse over" and to activate on click.

Turns out this was pretty easy:

2022-05-17.04-24-41.mp4

leemuar · 2022-05-17T08:55:26Z

Turns out this was pretty easy:

This is absolutely awesome addition, thanks!

ZeroInternalReflection · 2022-05-17T15:20:55Z

This definitely fixes some of the quirks of the main menu. One note on the mouseover behaviour, however, is that the credits/MOTD displays get a bit tricky on small screens. You can get kicked out of the screen by moving your mouse such that it lands on a menu that you can't see (The video is in Ukrainian since I also wanted to test whether everything works when the menu options get bumped to a second line, and it appears to):
https://user-images.githubusercontent.com/89038572/168846661-63a935d8-86b6-4c1c-81dd-46d540c32dac.mp4

Inglonias · 2022-05-17T17:37:53Z

what. this is amazing.

dseguin · 2022-05-17T22:49:18Z

You can get kicked out of the screen by moving your mouse such that it lands on a menu that you can't see

I'm not sure how to address this. I see 2 solutions, both involve adding a special case for TERMX size:

Prevent mouse functions when MOTD/Credits are selected
Require confirming the MOTD/Credits option to view the text in a new window

ZeroInternalReflection · 2022-05-18T03:00:50Z

I'm not sure how to address this. I see 2 solutions, both involve adding a special case for TERMX size:
* Prevent mouse functions when MOTD/Credits are selected

* Require confirming the MOTD/Credits option to view the text in a new window

Is there a particular reason that display_text() is currently fixed at FULL_SCREEN_HEIGHT/WIDTH? Rather than having a slightly different mouse interface for the credits/MOTD, I'd favour just capping the window height in display_text(). I feel consistency in interface behaviour is more important than maximizing the size of the credits/MOTD panes. This test video uses a fixed allowance of 4 rows for tips/menu/etc. This should ensure the menu you're mousing over is always visible, no matter what screen size/language you're using.

80x24_modified_credits_height.mp4

dseguin · 2022-05-18T03:16:50Z

Cheers, that's a much better solution. Not sure why I didn't consider it, haha.

Edit: I've also added mousewheel scrolling for submenus and MOTD/Credits windows. It just scrolls one element at a time regardless of mouse sensitivity (I don't think it's possible to get the number of scroll "ticks" without querying SDL directly).

leemuar · 2022-05-18T19:42:02Z

I think it would be better to not activate "main" menus (MOTD, New Game, Load, World, Special, Settings, Help, Credits, Quit) by mouse hovering, it should require a click. It should be highlighted, but not activated.
Submenus however should act just like it is now

P.S. again, thanks for this change, it really made the game much more "reactive" and responsive to the player

dseguin · 2022-05-19T03:15:02Z

About this:

not activate "main" menus [...] by mouse hovering, it should require a click

I tested hiding the submenus when mousing over:

In my opinion, this creates a bit more complexity in the controls, since cycling the options using keys behaves differently than mousing over. It also goes against this point from #57098:

Submenu options (such as the new world/select a world dialogue above) automatically become visible when you highlight the main option ([World] in this case). You don't press enter or space to open a submenu. This reduces a lot of keypresses and menu navigation confusion at no cost, since because of item 3 below, if this isn't the menu you want, you just keep on scrolling.

leemuar · 2022-05-19T06:35:48Z

In my opinion, this creates a bit more complexity in the controls, since cycling the options using keys behaves differently than mousing over. It also goes against this point from #57098:

These are good arguments, I haven't thought about that. Thanks for making it clear for me!

I-am-Erk · 2022-05-19T15:25:06Z

This looks great to me. How does it respond to a touch screen?

dseguin · 2022-05-19T17:17:22Z

How does it respond to a touch screen?

I don't have the hardware to test this, but from looking around it looks like touch gestures are mapped to keys. So tapping once is just a . input, which means "confirm". So it looks like no tapping on menu options, unfortunately.

I think checking for touchscreen tap coordinates would require some voodoo magic (or implementing a native Android UI like in #53132). Brett also pointed out that the buttons might be too small to press accurately on a touch screen, so it might be a whole other project

Edit: I enabled release actions on my fork so there are Android builds if anyone wants to give it a try: https://github.com/dseguin/Cataclysm-DDA/releases/tag/cdda-experimental-2022-05-19-1658

Stone94 · 2022-05-24T17:22:53Z

I've been waiting years for this 😮

src/main_menu.cpp

Co-authored-by: leemuar <[email protected]>

Night-Pryanik · 2022-05-31T17:03:09Z

Should this resolve #53699?

dseguin · 2022-06-01T00:24:07Z

Should this resolve #53699?

Nope, this PR doesn't affect the character creation menu

dseguin added 6 commits May 15, 2022 20:59

Main menu: consolidate basic vertical sub-menus

623eeab

Main menu: implement mouse control

d40443e

Main menu: tertiary menus for New Character

2e52cb2

Main menu: tertiary menus for World Options

658fa8f

Main menu: tertiary menus for Load Character

80ceb9e

Main menu: fix conflicts between submenu hotkeys

80b33c9

github-actions bot added [C++] Changes (can be) made in C++. Previously named `Code` [JSON] Changes (can be) made in JSON json-styled JSON lint passed, label assigned by github actions astyled astyled PR, label is assigned by github actions labels May 17, 2022

Night-Pryanik reviewed May 17, 2022

View reviewed changes

src/main_menu.cpp Outdated Show resolved Hide resolved

Night-Pryanik reviewed May 17, 2022

View reviewed changes

src/main_menu.cpp Outdated Show resolved Hide resolved

Night-Pryanik reviewed May 17, 2022

View reviewed changes

src/main_menu.cpp Outdated Show resolved Hide resolved

github-actions bot added Code: Tooling Tooling that is not part of the main game but is part of the repo. BasicBuildPassed This PR builds correctly, label assigned by github actions labels May 17, 2022

Main menu: cleanup + spelling fixes

67df929

Co-authored-by: Anton Burmistrov <[email protected]>

dseguin force-pushed the main_menu_overhaul branch from 25646d1 to 67df929 Compare May 17, 2022 04:16

dseguin added Info / User Interface Game - player communication, menus, etc. SDL: Tiles / Sound Tiles visual interface and sounds. Controls / Input Keyboard, mouse, keybindings, input UI, etc. labels May 17, 2022

Main menu: highlight menu items when mousing over

7d2ac93

dseguin force-pushed the main_menu_overhaul branch from 3c80a70 to 7d2ac93 Compare May 17, 2022 08:43

Main menu: limit height of display_text + mousewheel scrolling

29dd5ff

leemuar reviewed May 29, 2022

View reviewed changes

src/main_menu.cpp Outdated Show resolved Hide resolved

Update src/main_menu.cpp

ac259d3

Co-authored-by: leemuar <[email protected]>

kevingranade merged commit 369fc6f into CleverRaven:master Jun 2, 2022

dseguin deleted the main_menu_overhaul branch June 2, 2022 14:03

leemuar mentioned this pull request Jun 3, 2022

[Project] Add mouse support to all UI windows (where it is appropriate) #58106

Open

33 tasks

dseguin mentioned this pull request Jun 5, 2022

Main menu overhaul (Part 1.5): mouse control fixes & improvements #58142

Merged

5 tasks

olanti-p mentioned this pull request Mar 31, 2023

Port DDA title screen update with BN-specific tweaks cataclysmbnteam/Cataclysm-BN#2519

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Main menu overhaul (Part 1): Mouse controls + Vertical submenus #57764

Main menu overhaul (Part 1): Mouse controls + Vertical submenus #57764

dseguin commented May 17, 2022 •

edited

Loading

github-actions bot commented May 17, 2022

Night-Pryanik commented May 17, 2022

dseguin commented May 17, 2022

Night-Pryanik commented May 17, 2022

dseguin commented May 17, 2022 •

edited

Loading

leemuar commented May 17, 2022

dseguin commented May 17, 2022

leemuar commented May 17, 2022

ZeroInternalReflection commented May 17, 2022

Inglonias commented May 17, 2022 •

edited

Loading

dseguin commented May 17, 2022 •

edited

Loading

ZeroInternalReflection commented May 18, 2022

dseguin commented May 18, 2022 •

edited

Loading

leemuar commented May 18, 2022 •

edited

Loading

dseguin commented May 19, 2022

leemuar commented May 19, 2022 •

edited

Loading

I-am-Erk commented May 19, 2022

dseguin commented May 19, 2022 •

edited

Loading

Stone94 commented May 24, 2022

Night-Pryanik commented May 31, 2022

dseguin commented Jun 1, 2022

Main menu overhaul (Part 1): Mouse controls + Vertical submenus #57764

Main menu overhaul (Part 1): Mouse controls + Vertical submenus #57764

Conversation

dseguin commented May 17, 2022 • edited Loading

Summary

Purpose of change

Describe the solution

Mouse controls

Vertical submenus

Describe alternatives you've considered

Testing

Additional context

github-actions bot commented May 17, 2022

Night-Pryanik commented May 17, 2022

dseguin commented May 17, 2022

Night-Pryanik commented May 17, 2022

dseguin commented May 17, 2022 • edited Loading

leemuar commented May 17, 2022

dseguin commented May 17, 2022

leemuar commented May 17, 2022

ZeroInternalReflection commented May 17, 2022

Inglonias commented May 17, 2022 • edited Loading

dseguin commented May 17, 2022 • edited Loading

ZeroInternalReflection commented May 18, 2022

dseguin commented May 18, 2022 • edited Loading

leemuar commented May 18, 2022 • edited Loading

dseguin commented May 19, 2022

leemuar commented May 19, 2022 • edited Loading

I-am-Erk commented May 19, 2022

dseguin commented May 19, 2022 • edited Loading

Stone94 commented May 24, 2022

Night-Pryanik commented May 31, 2022

dseguin commented Jun 1, 2022

dseguin commented May 17, 2022 •

edited

Loading

dseguin commented May 17, 2022 •

edited

Loading

Inglonias commented May 17, 2022 •

edited

Loading

dseguin commented May 17, 2022 •

edited

Loading

dseguin commented May 18, 2022 •

edited

Loading

leemuar commented May 18, 2022 •

edited

Loading

leemuar commented May 19, 2022 •

edited

Loading

dseguin commented May 19, 2022 •

edited

Loading