v50 Steam/Premium information for editors
- v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
- Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.
Editing Template:Steam workshop tokens
Jump to navigation
Jump to search
Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 2: | Line 2: | ||
== Steam Workshop tokens == | == Steam Workshop tokens == | ||
− | These tokens are | + | These tokens are used to get the mod to work on Steam Workshop. |
{| {{prettytable}} | {| {{prettytable}} | ||
− | |- bgcolor="# | + | |- bgcolor="#999999" |
! Token | ! Token | ||
− | ! | + | ! Arguments |
− | ! | + | ! Usage |
! Description | ! Description | ||
− | ! | + | ! Ext Doc |
− | |||
|- | |- | ||
| {{text anchor|STEAM_TITLE}} | | {{text anchor|STEAM_TITLE}} | ||
− | | | + | | string |
− | | {{tc|red| | + | | {{tc|red|Required}} |
| The title of the mod on Steam Workshop. | | The title of the mod on Steam Workshop. | ||
− | | | + | | |
− | |||
|- | |- | ||
| {{text anchor|STEAM_DESCRIPTION}} | | {{text anchor|STEAM_DESCRIPTION}} | ||
− | | | + | | string |
+ | | | ||
+ | | The description of the mod on Steam Workshop. | ||
| | | | ||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| {{text anchor|STEAM_TAG}} | | {{text anchor|STEAM_TAG}} | ||
− | | | + | | string |
+ | | | ||
+ | | Any number can be used. | ||
| | | | ||
− | |||
− | |||
− | |||
|- | |- | ||
| {{text anchor|STEAM_KEY_VALUE_TAG}} | | {{text anchor|STEAM_KEY_VALUE_TAG}} | ||
− | | | + | | string1, |
+ | string2 | ||
| | | | ||
− | | Any number can be used. | + | | Any number can be used. |
| | | | ||
− | |||
|- | |- | ||
| {{text anchor|STEAM_METADATA}} | | {{text anchor|STEAM_METADATA}} | ||
− | | | + | | string |
| | | | ||
| Sets arbitrary metadata for an item. This metadata can be returned from queries without having to download and install the actual content. Toady doesn't know what it does [http://www.bay12forums.com/smf/index.php?topic=169696.msg8431542#msg8431542]. | | Sets arbitrary metadata for an item. This metadata can be returned from queries without having to download and install the actual content. Toady doesn't know what it does [http://www.bay12forums.com/smf/index.php?topic=169696.msg8431542#msg8431542]. | ||
− | |||
|[https://partner.steamgames.com/doc/api/ISteamUGC#SetItemMetadata SetItemMetadata] | |[https://partner.steamgames.com/doc/api/ISteamUGC#SetItemMetadata SetItemMetadata] | ||
|- | |- | ||
| {{text anchor|STEAM_CHANGELOG}} | | {{text anchor|STEAM_CHANGELOG}} | ||
− | | | + | | string |
| | | | ||
− | | A | + | | A changelog for the version you're uploading. This should be different each time you update a mod, and only include the changes in the new version. Steam Workshop congregates all version changelogs, so a full changelog can be seen there. |
− | |||
− | |||
| | | | ||
|- | |- | ||
| {{text anchor|STEAM_FILE_ID}} | | {{text anchor|STEAM_FILE_ID}} | ||
− | | | + | | string |
− | | {{tc|red| | + | | {{tc|red|Required (subsequent times)}} |
| Connects the mod to an entry on the Steam Workshop. | | Connects the mod to an entry on the Steam Workshop. | ||
− | Generated automatically the first time you upload a mod to Workshop, '''do not include it manually'''. If you upload a mod with an existing STEAM_FILE_ID token, it will update the Workshop entry connected to the ID. | + | Generated automatically the first time you upload a mod to Workshop, '''do not include it manually'''. If you upload a mod with an existing STEAM_FILE_ID token, it will update the Workshop entry connected to the ID. You can presumably only do this if you're the original uploader of said mod. |
− | |||
| | | | ||