Skip to content

Document layout publishing without preview images #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wangdiandao merged 1 commit into from
Nov 4, 2026
Merged

Document layout publishing without preview images #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/en/guide/publishing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ In Preview and publish, choose Publish or Update. Publish shows the work title,

New publications start public. Review metadata, preview, tags and actual content using the host workflow. Failure must preserve the usable installation. Service availability, account consent and terms depend on Steam and the environment.

Publish in a layout detail drawer opens the same dialog directly, with a Publish/Update selector. Layout dialogs list included component names and UUIDs instead of a preview image, upload file list, or raw layout JSON. Select and review shareable configuration values in that same dialog: none are selected for a new draft, and saved drafts retain the selection. Sharing choices remain available when updating and use only the configuration snapshot validated by the host when preparing the draft.
Publish in a layout detail drawer opens the same dialog directly, with a Publish/Update selector. Layout dialogs list included component names and UUIDs instead of a preview image, upload file list, or raw layout JSON. Select and review shareable configuration values in that same dialog: none are selected for a new draft, and saved drafts retain the selection. Sharing choices remain available when updating and use only the configuration snapshot validated by the host when preparing the draft. Layout publications and updates do not generate or upload preview images; updates preserve any existing Steam cover. Workshop layouts use the layout library's image-free card style, showing an unknown resolution when the summary omits it. Widget publications continue to use the component preview or the product placeholder.

The host manages layout work versions on save, overwrite and rename. Before upload it checks the remote version and freezes a higher version; retries after failure or uncertainty keep that version and content. Changing shared configuration after freezing requires a new draft. Importing a layout with an existing identity creates a separate local copy and preserves the original. Layout details show dependency and compatibility checks without an arrangement diagram.

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/publishing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

草稿和上传操作仍在对应开发组件抽屉；新发布默认公开，检查标题、描述、预览、标签和发布内容后再按宿主流程提交。上传失败不应损坏当前可运行版本。实际服务可用性、账号同意与条款由 Steam 和用户环境决定。

布局从布局抽屉的“发布”直接进入同一弹窗，也可切换为更新。布局弹窗以组件名称与 UUID 列表代替预览图、实际上传文件和原始布局 JSON；可分享配置直接在同一弹窗中勾选并核对值，新草稿默认不选，保存后保留选择。更新时同样可调整分享选择，只会使用准备草稿时服务筛选的配置快照。
布局从布局抽屉的“发布”直接进入同一弹窗，也可切换为更新。布局弹窗以组件名称与 UUID 列表代替预览图、实际上传文件和原始布局 JSON；可分享配置直接在同一弹窗中勾选并核对值，新草稿默认不选，保存后保留选择。更新时同样可调整分享选择，只会使用准备草稿时服务筛选的配置快照。布局发布与更新不生成或上传预览图，更新保留 Steam 条目原有封面。工坊中的布局采用布局库的无图卡片样式；分辨率摘要缺失时显示“分辨率未知”。组件发布仍使用组件预览图或产品占位图。

布局保存、覆盖与重命名由宿主管理作品版本。上传前核对远端并冻结更高版本；失败或结果未知后重试保持同一内容和版本，冻结后改变分享配置须新建草稿。导入同身份布局会创建新的本地副本并保留原布局。布局详情展示依赖与兼容性检查，不显示排布示意图。

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/modules/workshop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Steam 适配器负责 SDK 初始化、回调泵和退出，与组件恢复独立

新发布默认公开，可明确选择其他可见范围；已有草稿保留所选范围。未填写更新条目 ID 时不能提交或保存；保存更新草稿同时保存条目 ID 和更新说明。已关联条目的草稿固定为更新，目标只读；创建结果未知时只能选择更新并找回原条目 ID，避免重复创建。草稿卡片在作品名右侧显示清洁上传副本的版本，上传成功只显示“上传成功”；仍需处理的错误、协议和创建结果未知状态保持明确。

组件发布显示预览图和实际上传文件清单。布局从布局抽屉直接进入同一个发布/更新弹窗，不再先弹出“发布布局内容”；布局弹窗不显示预览图、实际上传文件清单或原始布局JSON，改为列出包含的组件名称与UUID。可分享普通配置在同一弹窗中逐项显示名称和值并供勾选，新草稿默认不选，保存后保留选择；发布和更新使用相同的分享选择。配置候选和值在准备草稿时由服务筛选并冻结，后续只接受候选中的UUID/字段键，不接受界面传入任意配置值。保存只提交草稿，实际上传前由草稿生成并校验布局文件；失败保留可重试草稿。缺少 preview 时使用产品占位图，不自动截图用户桌面。
组件发布显示预览图和实际上传文件清单；组件缺少 preview 时使用产品占位图，不自动截图用户桌面。布局从布局抽屉直接进入同一个发布/更新弹窗，不再先弹出“发布布局内容”；布局弹窗不显示预览图、实际上传文件清单或原始布局JSON，改为列出包含的组件名称与UUID。布局发布和更新均不生成、读取或上传预览图，不调用 SetItemPreview；更新不删除 Steam 条目上原有的封面。布局展示摘要附带可选 sourceResolution，供工坊无图卡片显示物理像素分辨率；未提供或无效时显示“分辨率未知”，摘要不用于安装校验。可分享普通配置在同一弹窗中逐项显示名称和值并供勾选，新草稿默认不选，保存后保留选择；发布和更新使用相同的分享选择。配置候选和值在准备草稿时由服务筛选并冻结，后续只接受候选中的UUID/字段键，不接受界面传入任意配置值。保存只提交草稿，实际上传前由草稿生成并校验布局文件；失败保留可重试草稿。

创建条目得到 PublishedFileId 后保存发布草稿，更新同一作品时复用身份，不能因重试自动创建多个条目。上传目录为清洁副本，只含作者内容和所选元数据；组件来源记录、运行数据、绑定、日志和秘密不得进入。

Expand Down
4 changes: 2 additions & 2 deletions host-snapshot.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@
{
"source": "docs/modules/workshop.md",
"destination": "docs/reference/modules/workshop.md",
"sourceSha256": "8ae8e49d86bf37a34a242bbf6159a9e4fccefe7def4e679f48a2553c44d5d99f",
"sha256": "eab7891fabf1deda6412f7a21517aade25597ebea605c130491a1f93e183a74c"
"sourceSha256": "5a94b7b73eb9f74ae4c0434767cb1bd389a413ccbb2d02e981da55e71e19932d",
"sha256": "f96db07ce21248048b4a0aeb252b0ad8e123bfda9fb2e2686241538bdc96e9b5"
},
{
"source": "examples/edge-garden/audio.js",
Expand Down
Loading