use actual Valheim key strings

Author: nbusseneau

CHANGELOG.md

@@ -11,6 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Replace Hugin cartography table tutorial vanilla text to be consistent with the mod's functionality.
 
+### Changed
+
+- Display cartography modifier key hint using actual Valheim key strings instead of raw key code.
+
 ## [0.5.5] - 2024-06-08
 
 ### Changed

src/Extensions/KeyCode.cs

@@ -0,0 +1,44 @@
+using UnityEngine;
+using UnityEngine.InputSystem;
+using UnityEngine.InputSystem.LowLevel;
+
+namespace BetterCartographyTable.Extensions;
+
+public static class KeyCodeExtensions
+{
+  public static string ToKeyHintString(this KeyCode keyCode)
+  {
+    var (isMouseButton, mouseButton) = ZInput.KeyCodeToMouseButton(keyCode, logWarning: false);
+    if (isMouseButton)
+    {
+      var mouseString = mouseButton switch
+      {
+        MouseButton.Left => "$button_mouse0",
+        MouseButton.Right => "$button_mouse1",
+        MouseButton.Middle => "$button_mouse2",
+        MouseButton.Forward => Mouse.current?.forwardButton.displayName ?? "Mouse Forward",
+        MouseButton.Back => Mouse.current?.backButton.displayName ?? "Mouse Back",
+        _ => null,
+      };
+      if (mouseString is not null) return mouseString;
+    }
+
+    var key = ZInput.KeyCodeToKey(keyCode, logWarning: false);
+    return key switch
+    {
+      Key.Comma => ",",
+      Key.Period => ".",
+      Key.Space => "$button_space",
+      Key.LeftShift => "$button_lshift",
+      Key.RightShift => "$button_rshift",
+      Key.LeftAlt => "$button_lalt",
+      Key.RightAlt => "$button_ralt",
+      Key.LeftCtrl => "$button_lctrl",
+      Key.RightCtrl => "$button_rctrl",
+      Key.Enter => "$button_return",
+      Key.NumpadEnter => "$button_return",
+      Key.None => "$menu_none",
+      _ => Keyboard.current?[key].displayName ?? key.ToString(),
+    };
+  }
+}

src/Model/Managers/MapTableManager.cs

@@ -78,7 +78,7 @@ public string GetHoverText()
     if (!GuildsManager.IsEnabled) return hoverText;
 
     var toggleTo = this.IsGuild ? $"$MapTable_HoverText_MakePublic" : $"$MapTable_HoverText_RestrictToGuild";
-    return hoverText + $"\n[<b><color=yellow>{Plugin.ModifierKey}</color> + <color=yellow>$KEY_Use</color></b>] {toggleTo}";
+    return hoverText + $"\n[<b><color=yellow>{Plugin.ModifierKey.ToKeyHintString()}</color> + <color=yellow>$KEY_Use</color></b>] {toggleTo}";
   }
 
   private void TryToggleMode(Humanoid user)

src/UI/MinimapKeyHint.cs

@@ -8,7 +8,7 @@ public class MinimapKeyHint(GameObject keyHint)
   private readonly GameObject _gameObject = keyHint;
   public string Text { set => this._gameObject.SetText(value); }
 
-  public static MinimapKeyHint Clone(MinimapKeyHint original, string name, KeyCode key)
+  public static MinimapKeyHint Clone(MinimapKeyHint original, string name, string key)
   {
     // clone original MinimapKeyHint and set clone as its first sibling
     var clone = Object.Instantiate(original._gameObject, original._gameObject.transform.parent);
@@ -22,7 +22,7 @@ public static MinimapKeyHint Clone(MinimapKeyHint original, string name, KeyCode
     var keyBkg = KeyHints.m_instance.m_buildHints.transform.Find("Keyboard/AltPlace/key_bkg").gameObject;
     var keyBkgClone = Object.Instantiate(keyBkg, clone.transform);
     keyBkgClone.name = "key_bkg";
-    keyBkgClone.SetText(key.ToString());
+    keyBkgClone.SetText(key);
 
     // hide clone by default
     clone.SetActive(false);

src/UI/MinimapUI.cs

@@ -46,7 +46,7 @@ public static void PrepareKeyHints()
     KeyHints.DoubleClick = new(keyHints.Find("keyboard_hints/AddPin").gameObject);
     KeyHints.LeftClick = new(keyHints.Find("keyboard_hints/CrossOffPin").gameObject);
     KeyHints.RightClick = new(keyHints.Find("keyboard_hints/RemovePin").gameObject);
-    KeyHints.ModifierKey = MinimapKeyHint.Clone(KeyHints.DoubleClick, "ModifierKey", Plugin.ModifierKey);
+    KeyHints.ModifierKey = MinimapKeyHint.Clone(KeyHints.DoubleClick, "ModifierKey", Plugin.ModifierKey.ToKeyHintString());
   }
 
   public static void ShowTableUI()