Crate genie_hki

Reader/writer for Age of Empires 2 Hotkey info files.

Hotkey files in AoE2 contain groups, each of which contain some number of hotkeys. Hotkeys have a string ID, a keycode, and flags for Ctrl/Alt/Shift modifiers. The index of the hotkey in its group determines the action that will be taken when it is activated.

Structs

GroupIndexError	Represents an error when accessing a hotkey group that does not exist.
Hotkey	The information about a single hotkey.
HotkeyGroup	Represents a group of Hotkeys.
HotkeyIndexError	Represents an error when accessing a hotkey that does not exist.
HotkeyInfo	Represents a HKI file containing hotkey settings.
HotkeyInfoMetadata	A list of information about hotkey groups in a hotkey file. The length is the number of groups in the file. Each StringKey in the list is the key of the string that names the group. The key is stored at the group's offset index in the hotkey file.

Enums

ArcheryRangeHotkeys	Hotkeys for archery ranges.
BarracksHotkeys	Hotkeys for the barracks.
BlacksmithHotkeys	Hotkeys for the blacksmith.
CastleHotkeys	Hotkeys for castles.
DockHotkeys	Hotkeys for docks.
FormationHotkeys	Hotkeys to change formations.
GameCommandHotkeys	Hotkeys for the game UI.
HotkeyGroupId	Available hotkey groups.
IndexError	Represents an error when binding or unbinding a hotkey that doesn't exist.
MarketHotkeys	Hotkeys for the market.
MilitaryUnitHotkeys	Hotkeys for military units.
MillHotkeys	Hotkeys for mills.
MonasteryHotkeys	Hotkeys for the monastery.
ScrollHotkeys	Hotkeys for scrolling.
SiegeWorkshopHotkeys	Hotkeys for siege workshops.
StableHotkeys	Hotkeys for stables.
TownCenterHotkeys	Hotkeys for the town center.
UnitCommandHotkeys	Hotkeys to control units.
VillagerHotkeys	Hotkeys for villagers.

Functions

default_him	Returns a HotkeyInfoMetadata struct that represents the info metadata for the default Aoe2 hotkeys (both UserPatch and HD).
keycode_id	Returns Ok(id), where id is the id number of the string giving the text representation of keycode in a language file. Returns None if keycode is not represented in a language file.