@gestaltrun/dsh-client-ui-skin-center
v0.3.21-gestaltrun.0
Published
In-GUI skin center for the dsh web GUI — the single skin package: skins are pure asset directories (built-in plus $DSH_HOME/skins) loaded and rendered only by the skin center; live try-on and one-click apply switch atomically in the page (no reload, no co
Readme
皮肤中心(GUI 内置皮肤中心)
English | 中文
@gestaltrun/dsh-client-ui-skin-center(cordis 插件 id ui-skin-center)是 dsh Web GUI 唯一的皮肤包:它把皮肤列表 / 试穿 / 应用做成一级设置分区「皮肤中心」(设置 → 皮肤中心,只列已安装皮肤),并且是所有皮肤的唯一加载器与渲染器。皮肤是纯资产目录——没有 package.json、不发 npm、不接 cordis 接线——只与皮肤中心契约(contracts/)耦合;皮肤中心把对官方 DSH 的全部耦合吸收在契约之后。卡片自带总开关(关闭即停用试穿、应用与背景控制)。
- 列表:展示「官方默认」加目录册里已安装的皮肤(名称、标语、强调色),当前应用目标带「使用中」标记。目录册合并两个来源:随本包内置的默认皮肤(
skins/blue-fantasy/)与放进$DSH_HOME/skins/<id>/的用户皮肤(同 id 时用户皮肤遮蔽内置皮肤)。皮肤集中的其余皮肤都是市场条目:在 DSH 市场商店一键按需安装到$DSH_HOME/skins/<id>/,即由同一目录册作为用户皮肤管理——无需重启,重开卡片或刷新页面即收录。skin.json校验失败的皮肤按 fail-closed 排除,并作为目录诊断上报。 - 自定义主题:列表末尾提供一张基于官方默认外观派生的用户级主题卡,与「官方默认」及目录册皮肤相互独立。浅色、深色分别编辑强调色、背景色、前景色和对比度(0–100),支持即时试穿、应用、恢复当前模式默认值和刷新持久化。生成的 CSS 只能覆盖经审计的官方 token 白名单,不接收选择器、任意 CSS 或资源 URL;不会修改任何第三方皮肤定义,目录册皮肤激活时自定义主题层自动停用。
- 试穿 / 应用:两者走同一个原子切换引擎(
src/client/runtime/skin-controller.ts)。一次切换 = 一个新的 activation identity:取回已限定作用域的样式表,安装样式、背景媒体与可选 hooks,翻转html[data-dsh-skin="<id>"],然后销毁上一个 activation(append-only 效果账本,幂等清理)。最新请求永远胜出;失败或被淘汰的切换完整保留旧皮肤。试穿是同一个切换但不落盘——「退出试穿」恢复已提交的皮肤。应用会持久化选择(POST /api/skin-center/v2/active)。不刷新页面、不改写cordis.patch.yml、不重建启动图。 - 首屏:host 半区注册一个 index.html 转换(
webServer.tapIndex,单一适配模块src/tap-index-adapter.ts),向每份送达的文档盖html[data-dsh-skin]属性并插入样式表链接,刷新后直接以当前皮肤启动,无官方原貌闪屏。tap 出任何问题都 fail-closed 回官方原貌。 - 皮肤格式(v2):
skin.json(fail-closed 校验,v1 字段package/wiring/bodyAttr忽略并给迁移警告)、skin.css(L1 token 重映射 + L2 语义选择器)、可选patches.css(L3 自由选择器,高敏感)、可选hooks.mjs(受信逃逸舱,高敏感)、assets/、preview/。所有 CSS 经过安全管线(src/core/css-safety/transform.ts):每个选择器强制限定在html[data-dsh-skin]下,@import/ 远程或协议相对 URL / 越界路径直接报错。见contracts/README.md。 - 覆盖契约:L1 重映射官方
--dsw-*设计 token;L2 样式语义属性(data-dsh-surface/data-dsh-part/data-dsh-plugin,枚举见contracts/semantic-attrs-v1.md),由兼容适配器(src/client/runtime/semantic-adapter.ts)从稳定锚点(data-slot出口、data-chat-flow-kind等)为官方壳层 DOM 打标;L3 补丁任意选择器,脆弱性由皮肤作者自负。主动输出语义属性的插件获得完整 L2 覆盖;不输出的只享受 L1。目录皮肤、自定义主题或壁纸激活期间还会启用公共壳层渲染适配器:它清除工作区列表末端 fade,将 composer 占位符固定为不透明的主题次级文本色,并为会话滚动口保留底部安全间距以保证吸底正文不被输入区覆盖(#978),各皮肤无需重复补丁。 - 背景优先级:Wallpaper Engine 壁纸永远优先于用户手动背景遮罩,后者优先于皮肤清单背景媒体;开关壁纸会实时重估优先级。
- 背景控制:背景遮蔽滑杆(0–100%)为画背景的皮肤在面板后加纱,两个按状态的高斯模糊滑杆(0–20 px)分别控制空对话与有内容时的背景,输入卡模糊滑杆(0–20 px)只控制输入卡背后的磨砂区域,气泡不透明度滑杆(0–100%)控制支持气泡 alpha 的皮肤消息气泡。整张壁纸模糊仍是独立的壁纸设置。背景模糊通过外壳之后的固定
backdrop-filter元素施加;0 完全关闭(无元素、无 GPU 开销)。 - Wallpaper Engine 桥:卡片可把本机 Wallpaper Engine 库用作 GUI 背景。host 半区(
src/we-library.ts+src/we-routes.ts)定位 WE 安装(Steam 应用 431960:Windows 注册表、libraryfolders.vdf中的全部库路径、持久的appmanifest_431960.acf所有权事实与探测路径),扫描项目与创意工坊内容及可选手动文件夹,经同源/api/skin-center/we/*路由提供清单、媒体(Range 流式)、预览图、web 壁纸项目文件(注入 WE API shim)与场景壁纸主贴图 PNG(由src/pkg-extract.ts进程内解码 PKG/TEX,磁盘缓存)。视频壁纸用<video>渲染,web 壁纸用沙箱<iframe>,场景壁纸经内置 WebGL 播放器实时渲染(2D 图层场景与 3D 模型场景按 WE 材质/着色器语义回放);场景内嵌脚本会被忽略,但受支持的图像、反射、水面与粒子通道仍保持实时渲染,「静态帧」模式可为任意类型钉一张零动画开销的图。单张壁纸的导入会把项目复制进<harness-home>/skin-center/wallpapers/,脱离 Steam 库变更也能用,并检测创意工坊原作更新。壁纸都是用户本机文件,从不上传或再分发——创意工坊内容归原作者。「手动文件夹」行可接收零散.mp4/.webm媒体、单个项目、项目合集、Wallpaper Engine 安装根目录或 Steam 库根目录(~展开为主目录)。 - 旧版迁移:v2 升级后的首次启动,一次性桥(
src/legacy-bridge.ts)读取 harness home 根cordis.patch.yml(v1 CLI 写入处;活动 profile 的cordis.patch.yml作为次级位置也会探测)里已退役的dsh-skin受管段,把活动皮肤 id 迁进 v2 选择存储,并清除旧行。迁移幂等且 fail-closed(出错时旧状态原样保留)。仅在发生迁移、清理或失败时输出日志,无 legacy 状态的稳态保持静默(issue #788)。
安装
dsh plugin --profile web add @gestaltrun/dsh-client-ui-skin-center
# 仓库开发:dsh plugin --profile web add link:$(pwd)/packages/skins/skin-center$(pwd) 是 dsh-web monorepo 的本地克隆。只有默认皮肤(蓝色幻想)随这个包发布;其余皮肤在 dsh-market.com 按需安装到 $DSH_HOME/skins/<id>/,社区皮肤同样是放进该目录的普通目录(均无安装命令、无需重启——重开卡片或刷新页面即收录)。新装默认激活蓝色幻想(宿主种子);升级后原激活皮肤已不可用时回退官方主题。包内只发布 skins/blue-fantasy;其余皮肤保留在仓库 skins/ 下,作为市场构建与画廊的目录来源,绝不进入 npm 包。
皮肤中心是符合官方 DSH 插件标准的自包含 bundle(dsh.bundle.patch 指向 cordis.patch.yml);也可经 git 安装:dsh plugin --profile web add github:<org>/dsh-web#<sha>(prepare 脚本就地构建 lib/)。pnpm ≥10 安装 git 依赖前需授权 allowBuilds;本地 link: 安装无此要求。
配置
- 总开关:开关整张卡片(试穿 / 应用 / 背景控制);持久化在 v2 活跃状态文档中。
- 背景滑杆:遮蔽(0–100%)、两个背景模糊半径、输入卡模糊(0–20 px)与气泡不透明度(0–100%),持久化在同一 v2 文档中。
- 背景持久化(支持远程):背景设置存放在 v2 活跃状态文档(
$DSH_HOME/skin-center-active.json的background段),经GET|POST /api/skin-center/v2/active读写,因此已配对的远程桌面(settings 通道仅限本机回环)也能读取并跨会话保存。旧的skin-background设置命名空间保留为官方设置页的输入面:已定制的配置在启动时一次性迁移进 v2 存储,之后的设置页修改由客户端转发。卡片内的修改不回写settings.yaml,设置页可能显示旧值,直到下一次从设置页修改。 - 壁纸面板:媒体库文件夹、选择、渲染模式(实时 / 静态帧)、压暗、模糊、隐藏时暂停、声音开关与音量;持久化在
skin-wallpaper命名空间。 - 自定义主题:浅色/深色的强调色、背景色、前景色、对比度配置及应用标记,以版本化契约独立持久化在
skin-custom-theme命名空间;壁纸选择与渲染仍完全由skin-wallpaper负责。 - 用户皮肤目录:
$DSH_HOME/skins/<id>/;覆盖优先级为DSH_SKINS_HOME、DSH_SKINS_DIR、$DSH_HOME/skins。
安全模型
- 所有
/api/skin-center/*路由仅接受同源请求:写操作拒绝跨站请求(Sec-Fetch-Site / Origin 围栏),资产读取限定在各皮肤目录之内(路径逃逸 fail-closed)。 - 皮肤 CSS 在服务前经白名单净化;
patches.css(L3)按设计就是任意 CSS 并如实公示——它拥有完整页面样式能力,不构成安全边界。 - 自定义主题编辑器只会从
CUSTOM_THEME_ALLOWED_TOKENS生成固定声明,且每个 token 都对照官方 token 注册表校验。用户输入只作为规范化后的颜色/对比度数据,不会成为选择器、URL 或自由 CSS 载荷。 hooks.mjs是与本仓库同审同发的受信代码,仅同源 serve,其 import/apply 错误永远不会拖垮静态皮肤。hooks 对内置皮肤及可按字节验证为官方市场已审查内容的用户目录皮肤放行:当前 Workshop 安装使用dsh-market.provenance.json,而早于 provenance 的历史安装必须同时匹配生成的src/reviewed-hooks.generated.ts身份中的 id、声明入口、完整skin.json与 hooks 字节(由src/provenance.ts校验,issue #1073)。回退只读且离线;任何被修改、改名、手工投放或篡改的目录都会继续拒绝 hooks facet,声明式部分仍正常加载。
已知限制
- 插件运行时写入的内联样式只能经 L3
!important补丁覆盖。 - 不输出语义属性(且无稳定 DOM 锚点)的插件只享受 L1 token 覆盖。
- 皮肤视频背景不受壁纸「隐藏时暂停」设置影响;该设置仅作用于 Wallpaper Engine 桥。
数据遥测
浏览器半区每个 UTC 日向 dsh-market.com 发送一次匿名安装心跳:仅含一个 localStorage 随机 ID 与本包名,无其他数据。服务端只存储该 ID 的加盐哈希,不存 IP,且只暴露聚合计数。完整契约见 docs/telemetry.md。
目录结构
skins/skin-center/
contracts/ # 面向皮肤的契约面(schema、hooks API、语义属性)
src/core/manifest-v2/ # manifest v2 类型 + fail-closed 校验器
src/core/css-safety/ # lightningcss 作用域限定 + 白名单管线
src/index.ts # host 入口:路由、tapIndex 适配器、旧版迁移桥
src/skin-repo.ts # 双来源皮肤目录册(内置 + $DSH_HOME/skins)
src/provenance.ts # 官方市场安装 provenance 校验(hooks 信任)
src/routes-v2.ts # /api/skin-center/v2/* 路由
src/tap-index-adapter.ts # 单一 tapIndex 适配器(防 FOUC)
src/active-state.ts # 活动皮肤选择持久化
src/legacy-bridge.ts # 一次性 v1 → v2 迁移
src/http-utils.ts / harness-home.ts # 路由共享助手 / DSH 路径解析
src/we-library.ts / we-routes.ts / we-shim-source.ts / pkg-extract.ts # Wallpaper Engine 桥
src/client/runtime/ # 效果账本、装饰层、语义适配器、切换控制器、启动存储
src/client/SkinCenter.tsx # 设置卡片
src/core/custom-theme.ts # 版本化配色契约 + 经审计的纯 token CSS 生成器
src/client/custom-theme-controller.ts / CustomThemePanel.tsx # 持久化/运行时控制器 + 编辑卡片
src/client/background.ts / wallpaper.ts / WallpaperPanel.tsx # 遮罩 + 模糊 / WE 桥 UI
skins/<id>/ # 内置皮肤(纯资产目录)验收清单
- [x] 皮肤中心出现在 设置 → 皮肤中心,无控制台报错
- [x] 列表展示官方默认加目录册全部皮肤;当前使用者有标记;非法皮肤以诊断形式呈现
- [x] 试穿即时生效,退出完整恢复已提交皮肤;页面上永远只有一套皮肤
- [x] 一键应用原子切换、无需刷新;后续页面加载直接以该皮肤启动(无 FOUC)
- [x] 自定义主题保留独立浅色/深色配置、刷新后恢复,且不会覆盖已激活的目录册皮肤
- [x] Wallpaper Engine 桥、背景遮罩与模糊控制不受换肤影响
