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
m (→Steam Workshop tokens: Added overwriting disclaimer to description token) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 15: | Line 15: | ||
|- | |- | ||
| {{text anchor|STEAM_TITLE}} | | {{text anchor|STEAM_TITLE}} | ||
| − | | string | + | | single 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'' | + | | ''<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] | ||
| Line 26: | Line 26: | ||
| | | | ||
| 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). | ||
| + | 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>'' | | ''<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] | ||
| Line 58: | Line 59: | ||
| | | | ||
| 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. | ||
| − | | Initial example: <nowiki> | + | | Initial example: ''<nowiki>[STEAM_CHANGELOG:Initial release]</nowiki>'' |
| − | + | Update example: ''<nowiki>[STEAM_CHANGELOG:Update the mod compatible with...]</nowiki>'' | |
| | | | ||
Latest revision as of 05:22, 12 March 2024
(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 required for the mod to function properly on Steam Workshop.
| Token | Type | Req? | Description | Example | External Doc |
|---|---|---|---|---|---|
| STEAM_TITLE | single string | Req | The title of the mod on Steam Workshop. | [STEAM_TITLE:Imani's Tweaks] | SetItemTitle |
| STEAM_DESCRIPTION | single string | The description of the mod on Steam Workshop. Maximum size is 8000 bytes (about 400 words).
Will overwrite the existing description of the mod on the workshop, can be omitted to avoid this behavior. |
[STEAM_DESCRIPTION:This is my collection of small changes and additional content.] | SetItemDescription | |
| STEAM_TAG | multi string | Any number can be used. Use a separate STEAM_TAG for each one. Each string must be under 255 chars. | [STEAM_TAG:ui][STEAM_TAG:tweak] | SetItemTags | |
| STEAM_KEY_VALUE_TAG | multi string1, string2 | Any number can be used. | SetReturnKeyValueTags | ||
| STEAM_METADATA | multi 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 | single 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. | Initial example: [STEAM_CHANGELOG:Initial release]
Update example: [STEAM_CHANGELOG:Update the mod compatible with...] |
||
| STEAM_FILE_ID | uint64 | Req, autogen | 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.) |