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.
Difference between revisions of "Template:Steam workshop tokens"
Jump to navigation
Jump to search
| Line 5: | Line 5: | ||
{| {{prettytable}} | {| {{prettytable}} | ||
| − | |- bgcolor="# | + | |- bgcolor="#1c2939" |
! Token | ! Token | ||
! Arguments | ! Arguments | ||
! Req? | ! Req? | ||
! Description | ! Description | ||
| − | ! | + | ! Example |
| + | ! External Doc | ||
|- | |- | ||
| Line 16: | Line 17: | ||
| string | | string | ||
| {{tc|red|Req}} | | {{tc|red|Req}} | ||
| − | | The title of the mod on Steam Workshop. | + | | The title of the mod on Steam Workshop. |
| + | | ''Imani's Tweaks'' | ||
| [https://partner.steamgames.com/doc/api/ISteamUGC#SetItemTitle SetItemTitle] | | [https://partner.steamgames.com/doc/api/ISteamUGC#SetItemTitle SetItemTitle] | ||
| Line 23: | Line 25: | ||
| 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). |
| + | | ''This is my collection of small changes and additional content.'' | ||
| [https://partner.steamgames.com/doc/api/ISteamUGC#SetItemDescription SetItemDescription] | | [https://partner.steamgames.com/doc/api/ISteamUGC#SetItemDescription SetItemDescription] | ||
| Line 30: | Line 33: | ||
| string | | string | ||
| | | | ||
| − | | Any number can be used. Each string must be under 255 chars. | + | | Any number can be used. Each string must be under 255 chars. |
| + | | ''mod:qol:tweak'' | ||
| [https://partner.steamgames.com/doc/api/ISteamUGC#SetItemTags SetItemTags] | | [https://partner.steamgames.com/doc/api/ISteamUGC#SetItemTags SetItemTags] | ||
| Line 46: | Line 50: | ||
| | | | ||
| 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] | ||
| Line 52: | Line 57: | ||
| 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. |
| + | | ''Made the mod compatible with yada yada'' | ||
| | | | ||
| Line 61: | Line 67: | ||
| 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. (Presumably only if you're the original uploader of said mod.) |
| + | | | ||
| | | | ||
Revision as of 00:52, 26 January 2023
(view - edit - history - purge) Documentation
Description
Simple container for the steam workshop tokens table. Doesn't even necessarily need to be in the template namespace. Moved this info so it could be transcluded on multiple pages, but maintained in one place.
Usage
{{Steam workshop tokens}}
Output
Steam Workshop tokens
These tokens are used to get the mod to work on Steam Workshop.
| Token | Arguments | Req? | Description | Example | External Doc |
|---|---|---|---|---|---|
| STEAM_TITLE | string | Req | The title of the mod on Steam Workshop. | Imani's Tweaks | SetItemTitle |
| STEAM_DESCRIPTION | string | The description of the mod on Steam Workshop. Maximum size is 8000 bytes (about 400 words). | This is my collection of small changes and additional content. | SetItemDescription | |
| STEAM_TAG | string | Any number can be used. Each string must be under 255 chars. | mod:qol:tweak | SetItemTags | |
| STEAM_KEY_VALUE_TAG | string1,
string2 |
Any number can be used. | SetReturnKeyValueTags | ||
| 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 [1]. | SetItemMetadata | ||
| STEAM_CHANGELOG | 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. | Made the mod compatible with yada yada | ||
| STEAM_FILE_ID | uint64 | Req | 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.) |