Hotkeys Custom Labels
=====================

Shows your custom hotkey labels on the in-game 5x3 command grid.

Based on "TTs visible Hotkeys (Configurable)" mod by TT (Mod ID: 263889).
The commandpanel.json widget overlay is from that mod — full credit to TT.

This version adds a tool to automatically generate the correct key labels
from your custom .hkp hotkey files, so the overlay always matches your setup.


HOW TO USE
----------

1. Locate your custom hotkey files:
   C:\Users\[username]\Games\Age of Empires 2 DE\[steamid]\profile\

   You need:
   - <profile_name>.hkp
   - <profile_name>\Base.hkp

2. Run the tool (from the hotkeyeditor.com/src/ directory):

   python -m hotkeys.hkp.keys_for_language Base.hkp Profile.hkp -o output.txt

   Options:
   --panel <name>    Generate labels for a specific panel instead of the default.
                     Panels: "Economic Build Menu", "Military Build Menu",
                     "Barracks", "Archery Range", "Stable", "Dock", etc.
   --best-fit        Pick the most common key per grid position across ALL panels.
                     Best option for non-grid hotkey users.

3. Copy the generated file to:
   Hotkeys Custom Labels/resources/en/strings/key-value/key-value-modded-strings-utf8.txt
   (repeat for other languages if needed: de, fr, br, es, etc.)

4. Enable the mod in AoE2:DE.


LIMITATION
----------

The game widget system only supports one static set of 15 labels on the
command grid. The labels cannot change dynamically based on which building
or unit panel is active.

- If you use GRID HOTKEYS (same key per position across all panels), the
  labels are correct everywhere.
- If you use CUSTOM per-building hotkeys, the labels can only be correct
  for one panel at a time. Use --panel to choose which, or --best-fit
  for the best compromise.


CREDITS
-------

- Command panel overlay (commandpanel.json): TT — "TTs visible Hotkeys (Configurable)"
- Label generation tool: hotkeyeditor.com