HIP: Historical Immersion Project

HIP Installation Instructions: Using HIP's Automatic Installer


HIP's automatic installer enables players to choose exactly the combination of modules and options that they desire — seamless and flexible modularity simply not possible with Steam Workshop.

Locate Your Crusader Kings II Mod Folder

This is the folder in which CKII looks for mods when it starts. If you know where your CKII mod/ folder is located, skip right past this section and on to Installation Instructions.

Otherwise, it's critical to know the proper location of the mod folder to get started. CKII's default mod folder location varies by operating system:

Windows: ~\Documents\Paradox Interactive\Crusader Kings II\mod\
Linux: ~/.paradoxinteractive/Crusader Kings II/mod/
Mac OS X: ~/Documents/Paradox Interactive/Crusader Kings II/mod/

Note that the special ~/ folder is simply a common convention for indicating your local account's home directory. On Windows, this is typically C:\Users\YOUR_USERNAME\; on Mac OS X, it's typically /Users/YOUR_USERNAME/; and on Linux, it's typically /home/YOUR_USERNAME/. Simple.

If this is your first time installing a mod for CKII, then you may need to create the actual mod/ subfolder in its parent folder yourself. The parent folder also happens to hold other CKII stuff specific to your local user account (known as the "userdir") — settings, savegames, caches, logs, etc. In the mod folder location table above, you can see that you'd be creating the mod/ subfolder within a folder called Crusader Kings II/ that's located somewhere under your home directory tree.

NEVER install mods directly within the game folder itself (i.e., within the Steam library folders): in short, doing so will fuck-up everything and never work.


Installation Instructions

Start here, regardless of whether you're using Windows, Mac OS X, or Linux:
  1. If you have a modules/ subfolder in your mod folder, delete it now. It's from a past HIP release and will prevent a correct, clean installation of the new version of HIP if not removed before the next step.
  2. Unzip everything inside the downloaded .7z archive for the latest HIP release directly into your mod folder.
    NOTE: The official 7-Zip archive (de)compression software (free, open source, and cross-platform) is highly recommended over all other extractors for this archive file type.
  3. If installing on Mac or Linux, proceed to those platforms' specific instructions below.
    If installing on Windows, continue to the next step.
  4. Run HIP.exe, which was unzipped directly into your mod folder moments ago. You should now see a console window on the screen. This is the installer.
  5. The installation process is brief, but if you are new to it, please take care to read through your options (there are many) and pay attention to everything the installer tells you (it's important). Even HIP veterans should pay attention, because options/features change over time.
  6. Start CKII and enable the HIP - Historical Immersion Project mod in the launcher.
    NOTE: If you use the installer's feature to assign a custom name to your installation (very handy for keeping different variants of HIP for different purposes), then the mod name in the launcher will be HIP - MyCustomName.
  7. At this point, you should also disable ALL other mods for your first run — or any time you encounter issues — to first ensure that everything's as you wanted and working as intended. It's much easier to add any [compatible] 3rd-party mods after doing so.
  8. Play!

Mac OS X Instructions

  1. Complete steps (1)-(3) in the general installation instructions in this document.
  2. Find the application Terminal that comes with your Mac. It is impossible to uninstall and bundled with every Mac.
    If it's not on your launcher already, then search Finder under Applications for Terminal. It should be in a subfolder in Applications with other system utilities.
  3. Run Terminal.
  4. The Terminal application will start in your home directory. The following command assumes Terminal is still in your home directory.
    Copy and then paste the following line of text, precisely, into the Terminal window, and then hit ENTER:

    python "Documents/Paradox Interactive/Crusader Kings II/mod/main.py"
  5. You should now be running the automatic installer, and your experience should be identical to that of Windows or Linux. Resume at step (5) in the general install instructions in this document.

Linux Instructions

  1. Complete steps (1)-(3) in the general installation instructions in this document.
  2. Open a terminal window. There are many terminal applications available for Linux, and if you're running Linux, you probably know how to access at least one. The gist is that we're going to hit up the command line, so open up a new terminal window.
  3. Copy and then paste the following line of text, precisely, into the terminal window, and then hit ENTER:

    python ~/.paradoxinteractive/"Crusader Kings II"/mod/main.py
  4. You should now be running the automatic installer, and your experience should be identical to that of Windows or Mac OS X. Resume at step (5) in the general install instructions in this document.


[ Home ]
[ Forum | Wiki | Steam Group | GitHub | Discord ]
[ Latest Release Thread | Latest Download | Install Instructions ]
[ EMF Beta | EMF Beta Changelog | EMF Changelog Archive ]