Skip to content

Added: optional inputs for previewFile, visibility, title, and description - #2

Open
lucashort7 wants to merge 3 commits into
BoldestDungeon:mainfrom
lucashort7:main
Open

Added: optional inputs for previewFile, visibility, title, and description#2
lucashort7 wants to merge 3 commits into
BoldestDungeon:mainfrom
lucashort7:main

Conversation

@lucashort7

Copy link
Copy Markdown

Added all parameters supported via SteamCmd Integration:

"workshopitem"
{
 "appid" "480"
 "publishedfileid" "5674"
 "contentfolder" "D:\\Content\\workshopitem"
 "previewfile" "D:\\Content\\preview.jpg"
 "visibility" "0"
 "title" "Team Fortress Green Hat"
 "description" "A green hat for Team Fortress"
 "changenote" "Version 1.2"
}

It was useful for my use case, where I needed to update a preview.png image from a workshop app.

Since I made the changes based on your fork, feel free to add them to your action if you'd like.

Upstream generates manifest.vdf without a previewfile field, so
workshop_build_item never touches the item's existing preview image
regardless of content changes (confirmed against Steamworks docs and
empirically via GetPublishedFileDetails). This adds an optional
previewFile input, resolved relative to the content root, that gets
included in the manifest only when set -- fully backward compatible.
Same pattern as previewFile: only written into the manifest.vdf when
set, so omitting them leaves the existing Workshop item metadata
untouched. visibility is validated against Steam's 0-3 enum
(Public/FriendsOnly/Private/Unlisted) before use.

Tags aren't supported -- workshop_build_item's VDF manifest has no
documented tags key; that needs the separate Steamworks Web API.
previewFile describes Workshop *listing* metadata, not upload content,
so it needs to stay reachable once path stops being the repo root
(e.g. path: 'Contents' for mods that ship a build-output subfolder as
the actual Workshop item root).
@lucashort7

Copy link
Copy Markdown
Author

Now the correct fork hahaha 😂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant