-- Civ5 Hotkey Mod -- v1.1 For Civilization 5 (Complete)

==================== - Installation - ====================
Notes:
- Directory paths are for the Steam version of the game. Directories for non-steam 
  versions will be different.
- '~' is short for 'Users/[YourUserName]/'
- '...' is short for the drive\directory where Steam is installed

Each version contains folders with alternate hotkey layouts. The 'Hotkeys Simplified' 
 layout is used by default, but any layout could be swapped in. The mod reads whichever 
 layout is installed in its 'override' folder. Be sure to follow the installation 
 instructions using the correct version you want.

You will need a text editor (ex. Notepad or Notepad++ on Windows, TextEdit or TextWrangler 
 on Mac) to customize your layouts or to adapt the Hotkey mod to work with conflicting 
 mods. 
  
== Local Version: =================================
  1) If downloaded through Steam Workshop, skip to step 2. Otherwise, copy the 'Civ5 
     Hotkey Mod (v 1)' folder into your Civ5 Mods directory. This should be found in 
	 your 'Documents' folder:
     
      Windows:  ~\Documents\My Games\Sid Meier's Civilization 5\MODS
      Mac:      ~/Documents/Aspyr/Sid Meier's Civilization 5/MODS
      Linux:    ~/.local/share/Aspyr/Sid Meier's Civilization 5/MODS

  2) If using a different/custom layout swap its .xml files into the 'Hotkey Overrides' 
     folder. Overwrite files if necessary. 
     
     Update the InGame.lua file for the Toggle Hex Grid hotkey - it is assigned to 'H' for 
     Hotkeys Simplified but will need to be changed to 'G' for the Default or Steam 
     Controller layouts. 
     
     Update the DiploCorner.lua file for the Chat Focus hotkey - it is assigned to 'Home' 
     for Hotkeys Simplified but will need to be changed to 'Tab' for the Default or Steam 
     Controller layouts.
	 
  3) Access through the mods menu in-game.
        
== DLC Version: ===================================
  1) If you are not using other DLC-type mods, or your other DLC-type mods do not conflict 
     - copy the 'HK_MOD' folder into your Civ5 DLC directory:
     
      Windows:  ...\Steam\SteamApps\common\Sid Meier's Civilization V\Assets\DLC
      Mac:      ~/Library/Application Support/Steam/SteamApps/common/
                Sid Meier's Civilization V/Civilization V.app/Contents/Home/Assets/DLC
      Linux:    ~/.steam/steam/steamapps/common/
                Sid Meier's Civilization V/steamassets/assets/dlc    

  2) If using a different/custom layout swap its files into the 'Override' folder. 
     Overwrite files if necessary.
     
== Conflicting Mods: ==============================
Conflicting mods override the same game files or .xml data as this mod. The conflicting 
 sections of the Civ5 Hotkey Mod will need to be merged into the other mod. You may want 
 to backup files to a separate location before you change them for easier uninstallation.

The Hotkey mod alters the follows files or their DLC/Expansion equivalents:

      Assets/Gameplay/XML/Units/   
        CIV5Controls.xml, CIV5Builds.xml, CIV5Automates.xml, CIV5Commands.xml, 
        CIV5Missions.xml, CIV5UnitPromotions.xml
      Assets/Gameplay/XML/Interface/CIV5InterfaceModes.xml
      Assets/UI/InGame/InGame.lua
      Assets/UI/InGame/WorldView/DiploCorner.lua
    
The conflicting hotkey updates can be added at the end of other mod's corresponding files. 
 Some DLC-type mods overwrite all .xml data into one large file (such as 'CIV5Units.xml') 
 - all the Hotkey mod's .xml changes should be added together at the end of that file.

All the .xml changes from the Civ5 Hotkey Mod have been collected in 'XmlChanges.xml'. 
 Copy from either XmlChanges or the separate sections in the mod folder.
    
= Adapt the Mods ==========================
  1) Find the conflicting file(s) in the other mod.
  2) If using a different/custom layout swap its files into the 'Hotkey Overrides' folder 
     (Local Version) or the 'Override' folder (DLC version. Overwrite files if necessary.
  3) Open 'XmlChanges.xml' or the override folder's .xml files and the conflicting file(s) 
     in a text editor.
  4) Copy the conflicting Hotkey Mod changes and paste them into the corresponding 
     file(s).
   !! Make sure you paste at the end of the other mod's file(s), but above '</GameData>'!!
  5) Save the .xml file changes. 
  6) If the other mod alters 'InGame.lua', open it and edit the line:
         elseif ( wParam == Keys.G ) then
     to change the Toggle Hex Grid hotkey - it needs to be assigned to 'H' for the Hotkeys 
     Simplified layout. Then save the edited 'InGame.lua' file.
     
     If the other mod alters 'DiploCorner.lua', open it and edit the line:
         and wParam == Keys.VK_TAB ) then
     to change the Chat Focus hotkey - it needs to be assigned to 'Home' for the Hotkeys 
     Simplified layout. Then save the edited 'DiploCorner.lua' file.
 
= Install Remaining Hotkey Mod Changes ====   
 If there are sections of the Hotkey mod that DIDN'T conflict with the other mod 
 (including 'InGame.lua' and 'DiploCorner.lua'):
  7) Delete the files that conflicted from the 'Hotkey Overrides' folder (Local version) 
     or the 'Override' folder (DLC version).
  8) Copy the 'Civ5 Hotkey Mod (v 1)' folder (Local version) or the 'HK_MOD' folder (DLC 
     version) with the remaining non-conflicting files into your Civ5 DLC directory (see 
     the sections above for the directory paths).
    
!! Warning !!: 
If another mod adds new content or edits/renames the actions affected by the Hotkey mod 
 then copying this mod's changes may not be enough. New update entries may need to be 
 added to address the other mod's content.

== Uninstall: =====================================
  1) Delete the 'Civ5 Hotkey Mod (v 1)' or 'HK_MOD' folders. 

= If Adapted for Conflicting Mods =========
        If you made backup files:
  2) Replace the changed files with backups.
        If you didn't make backups:
  2) Open any files from the other mod that where changed in a text editor.
  3) Delete the sections at the end from the Hotkey mod.
  4) Save the file changes.