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 required for the mod to function properly on Steam Workshop.
+
These tokens are used to get the mod to work on Steam Workshop.
  
 
{| {{prettytable}}
 
{| {{prettytable}}
−
|- bgcolor="#DCCF99"
+
|- bgcolor="#999999"
 
! Token
 
! Token
−
! Type
+
! Arguments
−
! Req?
+
! Usage
 
! Description
 
! Description
−
! Example
+
! Ext Doc
−
! External Doc
 
  
 
|-
 
|-
 
| {{text anchor|STEAM_TITLE}}
 
| {{text anchor|STEAM_TITLE}}
−
| single string
+
| string
−
| {{tc|red|Req}}
+
| {{tc|red|Required}}
−
| The title of the mod on Steam Workshop.
+
| The title of the mod on Steam Workshop. Example: ''Imani's Tweaks''
−
| ''<nowiki>[STEAM_TITLE:Imani's Tweaks]</nowiki>''
 
 
| [https://partner.steamgames.com/doc/api/ISteamUGC#SetItemTitle SetItemTitle]
 
| [https://partner.steamgames.com/doc/api/ISteamUGC#SetItemTitle SetItemTitle]
  
 
|-
 
|-
 
| {{text anchor|STEAM_DESCRIPTION}}
 
| {{text anchor|STEAM_DESCRIPTION}}
−
| single string
+
| string
 
|
 
|
−
| The description of the mod on Steam Workshop. Maximum size is 8000 bytes (about 400 words).
+
| The description of the mod on Steam Workshop. Maximum size is 8000 bytes (about 400 words). Example: ''This is my collection of small changes and additional content.''
−
Will overwrite the existing description of the mod on the workshop, can be omitted to avoid this behavior.
 
−
| ''<nowiki>[STEAM_DESCRIPTION:This is my collection of small changes and additional content.]</nowiki>''
 
 
| [https://partner.steamgames.com/doc/api/ISteamUGC#SetItemDescription SetItemDescription]
 
| [https://partner.steamgames.com/doc/api/ISteamUGC#SetItemDescription SetItemDescription]
  
 
|-
 
|-
 
| {{text anchor|STEAM_TAG}}
 
| {{text anchor|STEAM_TAG}}
−
| multi string
+
| string
 
|
 
|
−
| Any number can be used. Use a separate STEAM_TAG for each one. Each string must be under 255 chars.  
+
| Any number can be used. Each string must be under 255 chars.
−
| ''<nowiki>[STEAM_TAG:ui][STEAM_TAG:tweak]</nowiki>''
 
 
| [https://partner.steamgames.com/doc/api/ISteamUGC#SetItemTags SetItemTags]
 
| [https://partner.steamgames.com/doc/api/ISteamUGC#SetItemTags SetItemTags]
  
 
|-
 
|-
 
| {{text anchor|STEAM_KEY_VALUE_TAG}}
 
| {{text anchor|STEAM_KEY_VALUE_TAG}}
−
| multi string1, string2
+
| string1,  
−
|
+
string2
−
| Any number can be used.
 
 
|
 
|
 +
| Any number can be used.
 
| [https://partner.steamgames.com/doc/api/ISteamUGC#SetReturnKeyValueTags SetReturnKeyValueTags]
 
| [https://partner.steamgames.com/doc/api/ISteamUGC#SetReturnKeyValueTags SetReturnKeyValueTags]
  
 
|-
 
|-
 
| {{text anchor|STEAM_METADATA}}
 
| {{text anchor|STEAM_METADATA}}
−
| multi string
+
| 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}}
−
| single string
+
| string
 
|
 
|
−
| A brief description of the changes made. (Optional, set to NULL for no change note). The log message is only 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.  
+
| A brief description of the changes made. (Optional, set to NULL for no change note). The log message is only 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. Example: ''Made the mod compatible with yada yada''
−
| Initial example: ''<nowiki>[STEAM_CHANGELOG:Initial release]</nowiki>''
 
−
Update example: ''<nowiki>[STEAM_CHANGELOG:Update the mod compatible with...]</nowiki>''
 
 
|
 
|
  
Line 66: Line 58:
 
| {{text anchor|STEAM_FILE_ID}}
 
| {{text anchor|STEAM_FILE_ID}}
 
| uint64
 
| uint64
−
| {{tc|red|Req, autogen}}
+
| {{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. (Presumably only if you're the original uploader of said mod.)
+
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.  
−
|
 
 
|
 
|
  

Please note that all contributions to Dwarf Fortress Wiki are considered to be released under the GFDL & MIT (see Dwarf Fortress Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To protect the wiki against automated edit spam, we kindly ask you to solve the following CAPTCHA:

Cancel Editing help (opens in new window)

Templates used on this page:

Retrieved from "https://dwarffortresswiki.org/index.php/Template:Steam_workshop_tokens"