Installing a mod
- Find a mod on the CKII Steam Workshop
- Click "Subscribe"
- In the CKII launcher, click the "Mods" tab and check the box.
If the mod doesn't show up in the launcher:
- Verify you haven't reached the 50 subscribed mods limit.
- In case no download progress appears in Mod tab, check the setting for downloading while game is running (Steam -> Settings -> Downloads -> Allow downloads during gameplay).
- Make sure you have Steam Cloud enabled. Note that Steam cloud sync appears to be broken for mods with capitals in user_dir.
- Try restarting CK2 and Steam client.
- Verify mod file and archive are present in folder ~\Documents\Paradox Interactive\Crusader Kings II\mod. If not, you can force a re-download of the mod by looking into C:\Program Files (x86)\Steam\userdata\<SteamUser>\ugc for files & folders referencing the mod (for instance 203770_subscriptions.vdf and \referenced\45371260977302539\mod\), deleting them and restarting Steam client.
Uploading a mod
Mod upload is managed from within the game:
- (Optional) Define an image banner and tags in .mod file (see mod file).
- Launch the game with the mod activated. Note: mod must be using path format and not archive format.
- On main menu, click Content button, then Manage for the mod, and upload. The zipping to archive format will occur during upload.
- After upload is finished, mod page will open inside the Steam client. Copy the URL (ex: steamcommunity.com/sharedfiles/filedetails/?id=123456) and open in your favorite browser, as it's easier than using the Steam client integrated browser.
- Add a description, screenshots or videos, and edit change notes.
- Once everything looks fine, make the mod public !
Mod file before upload (MyMod.mod):
Mod file when downloaded from Workshop (mymod.mod):
MyMod.zip will contain a generated descriptor.mod which is identical to mymod.mod.
- Manage button is always greyed out: activate Steam Cloud Synch' for CK2 (Steam -> Settings/(Preferences on mac) -> Cloud -> Enable cloud sync), it is (strangely) required to upload mods.
Workshop has limitations, making it currently unsuitable for large mods:
- Modular mods that allow selecting modules at installation steps (for instance HIP) cannot be managed
- Maximum file size prevents large mods from using the Workshop. Biggest mod currently on the workshop is 40Mb zipped.[?]
Mods installed via Steam Workshop will auto-update, so be careful about non-backward compatible changes, as previous saves may become unplayable.