Paths

Table of Contentst

Diffusion 0 A.D. Public Repository rP24215

Let players remap hotkeys in-game, fix default hotkeys being qwerty-specific.
rP24215
Actions

Description

Let players remap hotkeys in-game, fix default hotkeys being qwerty-specific.

Provide a "Hotkey" screen to let players remap hotkeys in-game using a convenient setup.
Make all .cfg hotkeys refer to scancodes (i.e. position on the keyboard), so that default hotkeys now translate correctly for AZERTY, QWERTZ and other layouts.
'BackSpace' is now an alias for 'Delete', and works for killing units. This fixes #1917, as macs don't have a proper delete key and would need to use Fn+Del otherwise. This shifts "timewarp" to Shift+BackSpace.

Functionally, this switches hotkeys to scancodes, as that makes more sense (they are combinations of key positions, not actual text output).
SDL includes are cleaned and key names are reused.

Fixes #2850, Fixes #2604, Refs #1810, Fixes #1917.

Follows work in rP19624.

Various diffs tested by: Angen, Stan, Freagarach

Comments by: Nescio

Differential Revision: https://code.wildfiregames.com/D2814

Details

Committed

wraitii

Nov 19 2020, 10:27 AM

Differential Revision

D2814: Allow remapping hotkeys from inside the game / fix QWERTY hotkeys

Parents

rP24214: Deactivate RTTI (except in AtlasUI) on all platforms.

Branches

Unknown

Tags

Unknown

Build Status

Buildable 13779
Build 28311: Trigger Windows Autobuild
Build 28310: Post-Commit Build	Jenkins
Build 28309: Post-Commit Build (macOS)	Jenkins

Event Timeline

wraitii committed rP24215: Let players remap hotkeys in-game, fix default hotkeys being qwerty-specific..Nov 19 2020, 10:27 AM

wraitii added an edge: D2814: Allow remapping hotkeys from inside the game / fix QWERTY hotkeys.

Suggest improvements here: #5867

Concerning the in-game manual, previously it was:

Now it is:

I may be biased, but I think the old + and or are better readable than the new + and , . Moreover, the new version has ↑ but LeftBracket, whereas the previous version displayed ↑ (Up) and [ (Left Bracket), which I think was clearer.
Ideally, though, the manual ought to use columns, with the key combination nicely aligned in one and the description in another.

Also, when running the checkrefs.pl script, I get:

Loading GUI XML...
Unexpected GUI XML root element 'page':
$VAR1 = {
          'page' => {
                      'include' => [
                                     'common/modern/setup.xml',
                                     'common/modern/styles.xml',
                                     'common/modern/sprites.xml',
                                     'common/setup.xml',
                                     'common/sprites.xml',
                                     'common/styles.xml',
                                     'common/global.xml',
                                     'hotkeys/sprites.xml',
                                     'hotkeys/hotkeys.xml'
                                   ]
                    }
        };

Harbormaster completed building B13779: rP24215: Let players remap hotkeys in-game, fix default hotkeys being qwerty-specific..Nov 19 2020, 11:52 AM

Stan added a subscriber: Stan.Nov 19 2020, 5:00 PM

Stan added inline comments.

/ps/trunk/source/gui/ObjectTypes/CHotkeyPicker.cpp
21–25	#include "gui/ObjectBases/IGUIObject.h" #include "lib/timer.h" #include "ps/CLogger.h" #include "ps/Hotkey.h" #include "ps/KeyName.h" #include "scriptinterface/ScriptConversions.h"
/ps/trunk/source/gui/ObjectTypes/CHotkeyPicker.h
21–23	#include "gui/CGUI.h" #include "lib/external_libraries/libsdl.h" #include "ps/CStr.h" #include <vector>
/ps/trunk/source/ps/KeyName.h
22	#include "CStr.h" Or see below.
26	`CStr8`?
/ps/trunk/source/ps/scripting/JSInterface_Hotkey.cpp
20–29	#include "lib/external_libraries/libsdl.h" #include "ps/CLogger.h" #include "ps/Hotkey.h" #include "ps/KeyName.h" #include "scriptinterface/ScriptConversions.h" #include <unordered_map> #include <vector> #include <set> Missing + wrong order.

wraitii mentioned this in D3123: Fix PCH and chekrefs following rP24215.Nov 20 2020, 9:17 AM

wraitii mentioned this in rP24222: Fix no-PCH builds and checkrefs following rP24215.Nov 20 2020, 12:42 PM

Stan raised a concern with this commit.Nov 27 2020, 1:16 PM

Stan added inline comments.

/ps/trunk/source/gui/CGUI.cpp
255–260	This change broke copy pasting in CInput fields

This commit now has outstanding concerns.Nov 27 2020, 1:16 PM

wraitii mentioned this in D3154: Fix Hotkey/input handling in input boxes.Nov 27 2020, 3:04 PM

wraitii added inline comments.Nov 27 2020, 3:15 PM

/ps/trunk/source/gui/CGUI.cpp
255–260	D3154

wraitii mentioned this in rP24278: Fix Hotkey/input handling in input boxes..Nov 28 2020, 9:24 AM

wraitii requested verification of this commit.Nov 28 2020, 9:25 AM

This commit now requires verification by auditors.Nov 28 2020, 9:25 AM

Stan removed an auditor: Stan.Dec 5 2020, 4:52 PM

This commit no longer requires audit.Dec 5 2020, 4:52 PM

wraitii mentioned this in rP24371: Fix usage of remove_if in CHotkeyPicker.Dec 11 2020, 11:02 AM

Stan mentioned this in D3213: tools/entity/checkref perl to python.Dec 17 2020, 5:10 PM

Seems like it broke checkrefs. Refs D3213

+ cd source/tools/entity/
+ perl checkrefs.pl --check-map-xml --validate-templates
Checking public's integrity. 
The following mod(s) will be loaded: public|mod. 
Loading maps XML...
Loading maps PMP...
Loading entities...
Loading actors...
Loading variants...
Loading art files...
Loading materials...
Loading particles...
Loading sound groups...
Loading audio files...
Loading GUI XML...
Unexpected GUI XML root element 'page':
$VAR1 = {
          'page' => {
                      'include' => [
                                     'common/modern/setup.xml',
                                     'common/modern/styles.xml',
                                     'common/modern/sprites.xml',
                                     'common/setup.xml',
                                     'common/sprites.xml',
                                     'common/styles.xml',
                                     'common/global.xml',
                                     'hotkeys/sprites.xml',
                                     'hotkeys/hotkeys.xml'
                                   ]
                    }
        };

wraitii mentioned this in D3277: Fix hotkey tooltips.Jan 2 2021, 11:07 AM

wraitii mentioned this in rP24504: Fix hotkey tooltips not showing the correct keys..Jan 3 2021, 11:14 AM

wraitii mentioned this in rP24594: Fix xmlvalidator following rP24215.Jan 13 2021, 11:33 AM

s0600204 mentioned this in D3358: Format hotkeys when an alternate variant is specified.Jan 14 2021, 7:29 AM

vladislavbelov added a subscriber: vladislavbelov.Jan 15 2021, 10:23 AM

vladislavbelov added inline comments.