查看“Steam创意工坊”的源代码

{{version|Timeless}}

'''Steam Workshop''' is a feature of Steam that simplifies [[mods]] discovery and installation for players. Support for [[Crusader Kings II]] was added in March 2014, with [[patch 2.1]]. As of [[patch 2.8]] the limit of 50MB has been lifted, allowing for large overhaul or total conversion mods to be on the workshop.

==Installing a mod==

# '''Important''': Remove any previous manual installation of the mod if any. If a .mod file already exists with same name under <code>~\Documents\Paradox Interactive\Crusader Kings II\mod\</code> it will conflict during the installation.
# Find the mod on the [https://steamcommunity.com/workshop/browse/?appid=203770 CKII Steam Workshop]
# Click "Subscribe"
# Start CKII launcher
## Under "Mods" tab, the new mod will appear at the bottom of the mod list as unselectable, with a red background (which does not reflect download progress !).
## At the same time a "Crusader Kings II - Workshop Content" download will be triggered in Steam client (where you can monitor progress).
# Once the download has completed, tick the checkbox to activate the mod.
# Play !

===Troubleshooting===

If the mod doesn't show up in the launcher:
*Verify you haven't reached the '''50''' subscribed mods limit.
*Try subscribing to the mod in Steam client, while CK2 launcher is already started.
*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<ref>https://steamcommunity.com/app/203770/discussions/0/613958868365189597</ref>. Note that Steam cloud sync appears to be broken for mods with capitals in user_dir.<ref>[[Forum:843464]]</ref>
*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.

If the mod background stays red in the launcher after the download has completed in Steam client, it likely means the installation failed:
* Verify you don't have a pre-existing manual installation of the mod (a .mod file with same name but with a <code>path =</code> entry instead of <code>archive =</code>). If so, delete the original .mod file and the installed .zip archive, then restart the CK2 launcher, in order to force a re-copy of .mod and .zip from Steam client cache to the mod folder.

==Uninstalling a mod==

* Unsubscribe from the mod in Steam. You can see all subscribed mods on CK2 workshop under: ''Browse'' -> ''Subscribed articles''.
* Manually delete the associated .mod and .zip file under ''~\Documents\Paradox Interactive\Crusader Kings II\mod'', so that the mod no longer appears in the launcher.

==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):
<pre>
name="MyMod"
path="mod/MyMod"
</pre>

Mod file when downloaded from Workshop (mymod.mod):
<pre>
name="MyMod"
archive="mod/MyMod.zip"
</pre>
MyMod.zip will contain a generated descriptor.mod which is identical to mymod.mod.

===Updating a mod===

# Unsubscribe from your mod on Steam
# Make sure there isn’t a descriptor.mod file inside the folder
# Check the .mod file. Make sure it’s set to path= not archive=
# Launch the game and click on manage content
# Click on update
# Edit the description in the in-game steam browser and accept the agreement
# After updating, go to the mod page on Steam and set the mod to public again

===Troubleshooting===

*''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.
* Game crashes a few seconds after clicking on ''Update'' and going back to main menu: usually that's ok, the upload will still happen silently in the background, which may take few minutes for a big mod on a low bandwidth connection.
* After changing computer, there is only ''Publish'' instead of ''Update'' for an existing mod: you first need to publish as a new mod, delete that new mod from the workshop, restart the game and then you are able to update the existing mod. ''[Note from October 2019: Doesn't seem to work]''
* Game crashes a few seconds after clicking on ''Update' without going back to the main menu or updating your mod if you have the old descriptor.mod file make sure you delete that before updating

* Beware of the case sensitivity of folder and file names when a mod is archived ! These issues will not be reproducible on Windows with an unzipped mod folder, since Windows file system is case insensitive. For instance:
** A mod file <code>gfx/fonts/MapFont.dds</code> will not override vanilla file <code>gfx/fonts/Mapfont.dds</code>, due to wrong case of file name ''Map'''F'''ont.dds''
** A file inside a mod folder <code>Events/my_events.txt</code> ('''''E'''vents/'') will not be loaded by the game, as the game would expect <code>events/my_events.txt</code> ('''''e'''vents/'').

===Limitations===

* Mods installed via Steam Workshop will '''auto-update''' and only latest version of a given mod can be installed, so be careful about non-backward compatible changes, as [[Save_game_compatibility|previous saves may become unplayable]].
* Installation of meta-mods (for instance [[HIP]]) with selection of modules to install and automatic compatibility patching cannot be triggered automatically.
* The mod size limit has been lifted in [[patch 2.8]] (used to be 50MB), however very large mods (> 350MB) will fail to upload.
* Quotes are removed in the downloaded .mod file<ref>[[forum:1129514]]</ref>. This means sub-mods of a main mod that require <code>dependencies = { "Main Mod" }</code> and whose main mod has some spaces in its name (and thus require quoting) won't work properly via the workshop. You'll have use <code>dependencies = { "\"Main Mod\"" }</code> for when you are updating to the Steam Workshop.

==External links==

*[http://steamcommunity.com/app/203770/workshop/ CKII Workshop]

==References==

<references/>

{{Template:ModdingNavbox}}
[[Category:模组制作]]
[[en:Steam Workshop]]