@dsh-use/wallpaper-engine
把 Wallpaper Engine 的 scene(场景)壁纸搬进 DeepSeek Harness 的 Web GUI —— 在浏览器里实时渲染粒子、水波、云卷、布料摆动,让动态壁纸成为你写代码时的背景。
不需要 Wallpaper Engine 在后台运行,不需要 WebGPU,不重新分发任何第三方素材。
# 一行安装(dsh web;桌面版 App 请用侧边栏「插件」页,不能用 CLI)
dsh plugin --profile web add "@dsh-use/wallpaper-engine" && dsh plugin --profile web install
⭐ 如果它让你的界面好看了,点个 Star 就是最大的支持。 发现哪张壁纸渲染不正常,欢迎提 Issue —— 壁纸写法千差万别,你的反馈是项目改进的主要来源。
🎬 在 DSH 里的真实效果
下面两段动图都是在 DSH Web GUI 的真实页面上录的(不是离线贴图,也不是设计稿):壁纸由插件在浏览器里实时渲染 / 播放,DSH 界面叠加在其上。
|
yuki恋冢爱 Video · Girls
|
Knight in a red cloak · 红披风骑士 Anime
|
录制方式(如实说明):两段动图与视频都是在真实运行的 DSH 页面上、由本插件的生产构建(
lib/)实时渲染本机 workshop 壁纸后录制的浏览器画面,未做后期合成;壁纸通过插件自身的切换入口window.__wallpaperEngine.select(id)切换,因此画面里只有 DSH 界面与壁纸本身。画面已裁掉浏览器窗口边框(地址栏 / 标题栏)。yuki恋冢爱 是 HEVC(H.265)视频壁纸,这段用 Chrome 录制 —— 浏览器能否解码播放视频壁纸取决于它自身的解码能力:同一系统上 Edge 缺少 HEVC 解码会回退到预览图并提示(v0.8 起),Chrome 正常播放。壁纸素材版权归原作者所有,此处仅作效果展示,不再分发。
✨ 能做什么
| 能力 | 说明 | |
|---|---|---|
| 🎨 | Scene 动态壁纸 | 在浏览器里实时算出来,不是静态图贴上去:背景图层与粒子系统各司其职,背景的缩放、透明度、亮度按原作者的设定还原 |
| 🌊 | 粒子效果基本完整 | 雪、雨、花瓣、火星、雾、气泡等都按壁纸里的原始参数运动:重力、风向、湍流、寿命、颜色与大小渐变;沿速度方向拉伸的拖尾(雨丝、风痕、余烬,即 WE 的 spritetrail)也已实现;起播相位(starttime)按原设定预推进,对象级实例覆盖(instanceoverride,含编辑器的 `{user |
| 🖼️ | 各种纹理都能解 | 主流压缩格式(DXT1/3/5、RGBA、R8、RG88)与多帧精灵动画(火把、雾、光晕)都能正确解出原图,不糊、不露黑边;标记为精灵表的 image 只显示当前帧:有作者脚本的按脚本帧(可 pause / setFrame),无脚本的按约 1 帧/秒自动循环,不再把整张帧表压进一个图标 |
| 🎞️ | 视频 / 网页 / 图片壁纸 | 视频循环播放(编码不支持时自动回退预览并提示;视频壁纸自带音轨跟随「声音」开关播放,无音轨素材会提示);网页壁纸在沙箱里加载,页内 <audio>/<video> 声音同样跟随「声音」开关与音量(Web Audio 自建声源控制不到);图片壁纸用预览图 + 缓慢缩放动效 |
| 🪜 | 多级降级链 | scene 渲染失败时依次尝试 内嵌 MP4 → 抓帧 PNG → 作者预览图 → 空态;每级失败只跳过,不白屏、不黑屏卡死 |
| 🎬 | 视频编码兜底 | HEVC / H.265 等浏览器解不了的编码会回退到预览图,并在面板提示原因与自救建议,不再停在黑背景 |
| 🧩 | 常见特效会动 | 水波、涟漪、水流、云飘、植物摆动、抖动、脉冲、淡入淡出,以及模糊、泛光、光轴、局部对比度这类需要多趟渲染的特效(少数特效仍然看不到,见下节) |
| 🌟 | 壁纸级 bloom | 作者在 scene 里开的泛光(general.bloom*,阈值/强度按原参数)会叠加到画面上,亮部外溢;与面板「光晕」是两个独立开关 |
| 🔉 | 音效音量与播放模式 | 音效对象的音量按原设定生效;single 播一次、random 随机选一首,多文件不再同时叠播 |
| 🖌️ | 场景底色 | 纯文本/透明场景按作者的 general.clearcolor 铺底(兼容 WE 的 0-1 色值),不再是恒黑 |
| 🕒 | 文本对象会显示 | 壁纸里的时间/日期文本会实时走字(如 VHS 时间与日期),不再是空一块;作者挂在文字上的效果链(模糊、VHS、水波)现在也会执行;带脚本的文本写法差异见下节 |
| 🔋 | 省电与画质档位 | 一键暂停壁纸;切到后台自动暂停;渲染分辨率可降到 0.5× 省显存、提流畅 |
| 🔁 | 自动轮播 | 收藏 ≥2 张时只轮播收藏,否则轮播全部非隐藏壁纸;1 / 5 / 10 / 30 分钟、顺序或随机;暂停联动、手动选择重置计时、本轮失败跳过 |
| 🔎 | 壁纸库管理 | 标题搜索、类型筛选、仅收藏、隐藏 / 恢复、最近使用排序;收藏与隐藏只存本地,不改壁纸文件、不打断当前播放 |
| 🎛️ | 显示效果面板 | 遮罩不透明度、背景模糊、Ken Burns、画面适配(裁剪铺满 / 完整显示 / 拉伸铺满)都在面板里直接调,改完立即生效 |
| 🎚️ | 用户属性面板 | 壁纸自带的属性(bool / slider / color / combo 可调,只显示当前壁纸真正引用的属性,不出现假控件)在面板里直接调;切换/调整后自动重装配生效,滑块与取色防抖提交(不逐帧重建) |
| 🎵 | 系统媒体集成 | 在 Windows 上读取系统媒体会话(SMTC),让壁纸的专辑封面 / 歌名 / 歌手 / 主色与播放状态实时联动;仅内存、不落盘,面板可关 |
| 🎥 | 开机动画 | 打开 DSH / 新窗口时全屏播一段片头:素材可用 WE 库的视频 / 图片壁纸或本地视频文件(桌面端可直接用系统文件选择器选视频),四种展示方式,播完或到上限淡出;声音默认开启(面板可关,桌面版直接出声、浏览器首次交互后出声),片头播放期间壁纸声音自动静音、播完按设置恢复,每次会话只播一次,8 秒未就绪静默跳过;DSH 启动加载页(Loading plugins…)显示期间持续接管(视频循环 / 图片保持),主界面就绪后淡出 |
| 🛡️ | 失败不砸界面 | scene 渲染失败走多级降级链(内嵌 MP4 → 抓帧 → 预览图);video 解码失败 / 首帧超时回退预览图并提示。web 壁纸目前没有失败回退(跨源 iframe 探测不到子帧错误,失败会停在空白);界面本身始终可用 |
| ⚙️ | 开箱即用 | 自动探测 Steam 壁纸目录(注册表 + Steam 库配置 + 常见路径),也可手动填写;改设置立刻生效,不用重启 |
| 🚫 | 不依赖运行时 | 不需要 Wallpaper Engine 在后台运行;所需的引擎内置素材在你本机读取,不随插件分发第三方素材 |
💬 换了几张壁纸却发现某张显示不正常? 那是我们需要知道的——请按下方「使用前请了解」末尾的说明提交 Issue,附上壁纸名称与 ID 即可。
🚀 快速开始
1. 安装插件
桌面版 App:用侧边栏「插件」页
⚠️ 桌面版不能用下面那几条
dsh plugin命令 —— 桌面版 profile(desktop)由 App 独占管理,CLI 会直接拒绝:profile "desktop" is managed exclusively by the Electron application。
-
打开桌面版,点左侧栏的 插件 页。「设置 → 内置插件」是只读清单,装不了东西。
-
点 添加插件,在包名框里填下面任一种 —— 写法就是
dsh plugin add后面那一段:装法 填什么 npm(稳定版) @dsh-use/wallpaper-engineGitHub(最新) github:yu502950715yang/dsh-use-wallpaper本地仓库(改码即时生效) E:\code\dsh-use-wallpaper(绝对路径即可,不必写link:;装好后记为link:)输入框下方的 插件安装引导和示例 给出这三种形式的示例,填入示例 可一键填入(GitHub 与本地路径记得替换成实际值)。
-
点 安装。首次使用会先探测 npm 官方源与国内镜像、选最先响应者;GitHub 连不上时会提示 无法访问 GitHub,可点 改用国内镜像。
-
装完刷新页面即可生效(新装插件会即时挂载,不必重启 App)。
例外:装的是本地仓库、且随后改了它的
dist/client.js时,必须整个 App 重启(托盘退出再启动)—— 桌面版 host 在启动时就把客户端 bundle 拍成内存快照,刷新页面拿不到新代码。 -
接着做下面的「2. 启用并选择壁纸」。
可能挡住你的两个环节:① 插件声明的 DSH 版本不兼容时会被拦下,放行等于接受「可能崩溃或损坏数据」的风险,需要你明确确认;② 插件带
prepare/postinstall安装脚本时 pnpm 会拦下,插件页会问你是否允许执行这些脚本。 卸载也在这一页(会二次确认);「官方」分组里随安装提供的组合包是锁定的,不可卸载。
以下三条适用于 dsh web(npm 版 CLI,profile 名 web)
从 GitHub 安装(推荐,最新)
dsh plugin --profile web add github:yu502950715yang/dsh-use-wallpaper
dsh plugin --profile web install
从 npm 安装
dsh plugin --profile web add "@dsh-use/wallpaper-engine"
dsh plugin --profile web install
npm registry 当前最新为 1.0.1(发布包只含
lib+dist+cordis.patch.yml,构建产物已随包提交,装完无需本地构建)。npm 版与 GitHub 版的差别:npm 走版本发布,更新节奏慢于仓库
master;想第一时间拿到修复请用上面的 GitHub 方式。
本地开发(link: 符号链接,改码即时生效)
# 必须在**本仓库根目录**执行:link:. 会被锚定到当前目录
dsh plugin --profile web add link:E:/code/dsh-use-wallpaper
仓库根
package.json已声明dsh.bundle,bundle 由cordis.patch.yml自动注册 —— 不要手动改 profile 的package.json,也不要往 profile 的cordis.patch.yml插条目(重复 insert 会报duplicate loader entry id)。
2. 启用并选择壁纸
- 重启
dsh web,打开 GUI。 - 进入 设置 → 侧边栏「Wallpaper 壁纸」。
- 填写壁纸目录(workshop)与引擎目录(particle 纹理),或点 自动探测 采用探测结果。典型路径:
- 壁纸目录:
D:/Steam/steamapps/workshop/content/431960 - 引擎目录:
D:/Steam/steamapps/common/wallpaper_engine
- 壁纸目录:
- 在缩略图网格中点选壁纸即可生效。
3. 验证
GET /wallpapers/list返回 JSON 壁纸数组。- 浏览器 Console 出现
[three] scene loaded id=… background=N particleLayers=M(M ≥ 1表示粒子层已建)。
4. 用插件市场索引源订阅(可选)
本仓库根目录提供一份 format-1 插件市场索引(index.json,已用官方 @deepseek-ai/dsh-plugin-market-index 校验)。DSH 0.2.1 起可以把它加成一个索引源,之后在「插件 → 发现」里浏览与安装:
- 插件 → 发现 → 索引源 → 添加
- 粘贴:
https://cdn.jsdelivr.net/gh/yu502950715yang/dsh-use-wallpaper@master/index.json - 回到「发现」,搜索 Wallpaper Engine
也可以直接用上面的
dsh plugin add命令安装,两条路径等价;索引源只是让插件在客户端里「可被逛到」。
🧰 配置项
下表的设置字段都能写进 profile cordis.patch.yml 的 config(面板里改过的值优先)。面板按分区暴露的是:
- 当前壁纸 / 壁纸目录:
selectedWallpaperId(缩略图点选)、wallpaperDir/weAssetsDir(手填 +「自动探测」)。 - 显示效果:
overlayOpacity、blurEnabled/blurRadius、kenBurns、fitMode、glowEnabled/glowThreshold/glowStrength。 - 声音:
soundEnabled+soundVolume(壁纸音效:scene 音效对象 + 视频壁纸自带音轨,共用音量)。 - 性能与省电:
paused、pauseOnHidden、qualityScale。 - 轮播:
rotationEnabled、rotationIntervalMs、rotationOrder。 - 文字可读性:
textColorMode、textColor、textOutline。 - 开机动画(设置页顶部 tab「日常壁纸 / 开机动画」切换,与壁纸设置互不影响):
bootAnimationEnabled、bootAnimationSource、bootAnimationWallpaperId/bootAnimationWallpaperKind、bootAnimationLocalPath、bootAnimationFitMode、bootAnimationMaxDurationMs、bootAnimationSoundEnabled、bootAnimationVolume。
frameCacheEnabled 没有面板控件(默认 true;要改只能写 profile config)。壁纸库的收藏 / 隐藏 / 最近使用与用户属性不是设置字段,只存 localStorage(见本节末尾);搜索 / 类型 / 排序是面板临时状态,刷新即恢复默认。
| 字段 | 默认 | 说明 |
|---|---|---|
selectedWallpaperId | 空 | 选中的壁纸(空 = 恢复 DSH 默认背景) |
wallpaperDir | 空 | Steam workshop 壁纸目录 |
weAssetsDir | 空 | Wallpaper Engine 安装目录(读内置粒子/效果纹理) |
overlayOpacity | 0.35 | 壁纸层上方遮罩的不透明度;面板「显示效果」可调 |
blurEnabled / blurRadius | false / 12 | 背景模糊与半径;面板「显示效果」可调 |
kenBurns | true | 图片壁纸的缓慢缩放动效;面板「显示效果」可调 |
fitMode | cover | 画面适配:cover 裁剪铺满 / contain 完整显示(可能留边)/ stretch 拉伸铺满;面板可调 |
glowEnabled | true | 应用级光晕(全屏后处理,仅 scene 壁纸) |
glowThreshold | 0.65 | 光晕亮度门槛(0–0.99,越低发光区域越多) |
glowStrength | 0.35 | 光晕强度(0–4;2026-09-21 由 1.0 下调,防亮部过曝 —— 旧值在亮部多的壁纸上 luma>200 占比会涨 1.5 倍以上) |
paused | false | 暂停壁纸渲染(省电;视频壁纸同时停播) |
pauseOnHidden | true | 页面切到后台/最小化时自动暂停,回到前台恢复 |
qualityScale | 1 | 画质档位:渲染像素比倍率(0.5–1,越小越省显存) |
soundEnabled | true | 壁纸声音总开关:scene 壁纸的音效对象 + 视频壁纸自带音轨;面板「声音」卡有开关,改完立即生效 |
soundVolume | 1 | 壁纸声音音量 0–1:scene 音效对象与视频壁纸共用;面板「声音」卡滑杆,拖动即时生效 |
rotationEnabled | false | 自动轮播开关 |
rotationIntervalMs | 300000 | 轮播间隔(1–30 分钟;面板档位为 1 / 5 / 10 / 30 分钟) |
rotationOrder | sequential | 轮播顺序:sequential 顺序 / random 随机 |
frameCacheEnabled | true | scene 首帧抓帧缓存(写入数据目录 frames/,供降级链使用);面板无控件 |
bootAnimationEnabled | false | 开机动画总开关(设置 →「Wallpaper 壁纸」→「开机动画」tab,默认关闭;默认不记忆 tab) |
bootAnimationSource | we | 素材来源:we = WE 库壁纸 / local = 本地视频文件 |
bootAnimationWallpaperId | 空 | WE 素材的壁纸 id(面板选择时与 kind 一起写入) |
bootAnimationWallpaperKind | 空 | 素材类型:video / image(启动时免拉列表判断) |
bootAnimationLocalPath | 空 | 本地视频的绝对路径(桌面端点「选择文件…」用系统选择器自动填入;web 端手填。host 仅回环来源流式读取,拒绝 UNC / 网络路径) |
bootAnimationFitMode | cover | 展示方式:tile 平铺(仅图片)/ contain 居中 / stretch 挤压 / cover 裁切填满 |
bootAnimationMaxDurationMs | 6000 | 最长播放(0–30000 ms;0 = 视频播完为止,图片固定约 4 秒) |
bootAnimationSoundEnabled | true | 开机动画声音(桌面版直接出声;浏览器冷启动没有用户手势时自动播放策略会先静音) |
bootAnimationVolume | 1 | 开机动画音量 0–1(开机动画 tab「声音」卡滑杆) |
texMaxMipBytes | 536870912(512 MiB) | 纹理解压预算:单条 mip 解压上限(安全加固,正常素材用不到) |
texMaxTextureBytes | 1073741824(1 GiB) | 单个 .tex 全部 mip 解压总和上限 |
texMaxMipCount | 4096 | 单个 .tex 的 mip 条数上限 |
texMaxDimension | 16384 | 单条 mip 宽/高上限(WebGL2 最大纹理尺寸) |
纹理解压预算(
texMax*)一般不需要改:它是 1.0 的安全加固——.tex里「解压后多大」是第三方素材自己写的,此前按它直接分配内存,恶意/损坏素材可让页面内存爆掉。现在分配大小按「格式 + 宽高」推导,声明不一致、空载荷或超预算的纹理会被拒绝(该纹理缺失,走正常降级链)。只有当某张合法壁纸的超大纹理被误拒(表现为该纹理缺失/白图/该壁纸回退预览)时,才需要按需调大对应上限,改完刷新页面生效。建议按需只调大被触发的那个字段(例如 8K RGBA 素材只需确认
texMaxMipBytes ≥ 268435456)。
优先级:用户设置 > profile cordis.patch.yml 的 config > 缺省。
DSH 版本兼容(1.0 起):本插件 1.0 要求 DSH
>=0.2.0-rc.1 <0.3.0(声明在package.json的engines.dsh;DSH 0.2.1 起会优先按该字段做安装/加载兼容检查)。设置命名空间 = profile 条目 iddsh-wallpaper-engine,改动写进 profilecordis.patch.yml。
- 1.0 移除了对 DSH ≤0.1.6 的旧设置路径(
~/.dsh/settings.yaml)。仍使用 0.1.x 的用户需先升级 DSH 再安装本插件;继续用旧版 DSH 的请停留在 0.13.1。- 0.1.7-alpha.1 ~ 0.1.x 的设置机制与 0.2.x 相同,但 1.0 只在 0.2.0-rc.1 / 0.2.2-rc.1 上做过真机验证;
engines.dsh按实测下限 + 当前 minor 上界声明。想手工预置配置,写 profile
cordis.patch.yml:- id: dsh-wallpaper-engine config: wallpaperDir: D:/Steam/steamapps/workshop/content/431960 weAssetsDir: D:/Steam/steamapps/common/wallpaper_engine selectedWallpaperId: "3789244610"升级、跨版本行为变更与废弃策略见 CHANGELOG.md 与 CONTRIBUTING.md。
💡 设置字段与本地状态:上表的都是设置字段,可写进 profile
cordis.patch.yml的config;面板改动除用户属性(提交后重装配当前壁纸才生效)外都立即生效。其中fitMode/ Ken Burns 只对图片 / 视频壁纸生效(scene 由渲染器自绘;Ken Burns 仅图片)。壁纸库的收藏 / 隐藏 / 最近使用(we:fav/we:hidden/we:recent)与用户属性(we:userprop:<wallpaperId>:<key>)是浏览器侧 UI 状态,只存 localStorage,不能写进 profile config,也不跨浏览器 / 端口同步。⚠️ 光晕默认值
0.65/0.35是 2026-09-21 由用户在真机面板上试出来的(先按「亮部不过曝」把强度从1.0下调,阈值保持0.65以保留光晕感;6 张壁纸的参数网格数据见AGENT.md§7.1)。它只保证「亮部不过曝 + 光晕仍可感」,不是与桌面 WE 逐像素对齐的结果 —— 你觉得还要更亮/更暗,面板两个滑杆可即时微调。
💡 效果为什么值得期待
- 动态是真的,不是贴图:粒子会按原作者的设定运动(重力、风向、湍流、寿命、闪烁),水会流动起波纹,云会缓缓飘。不是拿一张静态图做位移。
- 尽量还原原版观感:混合方式、粒子大小、发光叠加、色调都照着 Wallpaper Engine 的规则来,并对可复现样本做过桌面版逐像素对拍校准。
- 支持格式够全:主流 scene 壁纸的纹理压缩格式(DXT1/3/5、RGBA、R8、RG88)与多帧精灵动画(火把、雾、光晕)都能解出原图,不会糊成一片或露黑边。
- 高清屏不浪费:按设备像素比渲染,Retina / 高 DPI 屏上线条依然锐利。
- 出问题也不会砸掉你的界面:scene 渲染失败或算不出可见内容时按多级降级链逐级回退(内嵌 MP4 → 抓帧 → 预览图);视频壁纸解码失败或首帧超时会回退预览图并提示。web 壁纸没有失败回退(跨源 iframe 探测不到子帧错误),但界面本身始终可用。
- 换来这些的代价很小:纯浏览器原生能力 + WebGL,不需要 Wallpaper Engine 在后台运行,也不需要 WebGPU。
⚠️ 使用前请了解
这一节帮你判断自己的壁纸能不能正常显示。壁纸库越冷门、效果越复杂,越可能命中下面几条。
如果你的壁纸出现异常,请务必拉到本节末尾 —— 那里写了反馈方式。壁纸写法千差万别,你的反馈是项目改进的主要来源。
支持矩阵
| 维度 | 支持情况 | 说明 |
|---|---|---|
| 操作系统 | Windows 10/11(完整支持,唯一实测平台) | macOS / Linux 未测试。1.0 起在 package.json 声明 dsh.bundle.platforms = ["win32"],DSH 会在其它平台跳过本插件并报告原因;自行安装时自动探测、媒体集成、系统音频不可用 |
| DSH 宿主 | 0.2.x(>=0.2.0-rc.1 <0.3.0) | 0.2.0-rc.1 / 0.2.2-rc.1 真机验证;DSH ≤0.1.6 自 1.0 起不再支持(见 CHANGELOG) |
| 宿主形态 | dsh web(npm CLI)/ DSH 桌面 App | 桌面版只能用侧边栏「插件」页安装,CLI 不适用桌面 profile |
| 浏览器 | Chrome / Edge(WebGL2) | 推荐 Chrome(更接近 WE 观感);HEVC 视频能否播放取决于浏览器/系统解码扩展 |
| Wallpaper Engine | 本机安装(读内置粒子/特效素材) | 不需要 WE 在后台运行;没装或路径未配时粒子退化为纯色圆点,画面仍在 |
| 网络环境 | 回环地址(127.0.0.1 / localhost) | 局域网 IP / 隧道访问 GUI 时,web 壁纸中依赖 WebGL 贴图的会空白(opaque origin 沙箱限制) |
| 显示器 | 单窗口任意分辨率 / 高 DPI | 多显示器每屏独立壁纸不支持(插件是单页背景层,受 DSH 宿主能力限制) |
画面表现
- 少数壁纸可能出现黑块或整体偏暗:带复杂遮罩或特殊混合方式的壁纸会这样,不是你没配好。
- 粒子的旋转、拖尾(雨丝 / 风痕)、近大远小都已支持,但能不能看出来取决于壁纸本身 —— 只有规格里给了对应参数的粒子才会动。绳索类拖尾(
ropetrail)尚未支持,会退化成普通贴图;子粒子(子发射器,如火焰火星、雷电二次放电)尚未支持。起播相位(starttime)按原作者设定预推进,最多 15 秒;对象级实例覆盖(instanceoverride)也按原设定生效。 - 鼠标互动粒子尚未支持:粒子控制点
link_mouse/worldspace(跟随光标 / 世界坐标吸引点)、vortex旋涡算子、mapsequencearoundcontrolpoint以及boids/remapvalue算子会退化 —— 粒子不跟手、漩涡不旋转、鸟群不聚散。 - 骨骼模型(puppet)已能播真实动画:
scene.json的animationlayers引用的.mdl动画(MDLS 骨骼 + MDLA 关键帧)会驱动骨骼,角色身上的对象级效果(披风 / 衣摆的水波、涟漪等)也能执行。边界:MDLE(世界绑定矩阵)不消费、MDLS 多扩展块不解析、多条可见动画层只应用第一条(blend/additive不混合)、puppet 材质的colorBlendMode ≠ 0与自定义 shader 不复刻、puppet 的 color / alignment 未接。 - 时间 / 日期类文字会实时走字,作者挂在文字上的模糊 / VHS / 水波效果也会执行;隔离渲染的文本尺寸在装配时固定,跨分钟变宽时可能轻微裁边或拉伸。壁纸自带的脚本跑不通时,退回内置时钟或跳过该层,不会把作者的占位文字画到屏幕上。
- 闪烁类粒子(火花、雨滴溅开等)已按桌面端表现对齐:桌面上不显示的,这里也不画。
- 模糊、泛光、光轴、局部对比度会在本地实时执行,挂在这些效果上的对象越简单越容易看出效果;极少数(如光轴)目前只确认到已执行,画面观感待确认。
- 依赖「背景副本」的效果未实现:
copybackground字段不解析——把背景当作效果输入的壁纸,相关层效果可能与桌面不同(例:2937346640的光轴合成、2911105183的广告牌折射);2597392171的光轴背景合成已生效。 - 壁纸声音默认播放、音量可调(设置 → 壁纸 →「声音」卡):scene 壁纸的音效对象、视频壁纸自带音轨、web 壁纸页内的
<audio>/<video>都跟随开关与音量滑杆(音量默认 100%,拖动即时生效,共用同一音量;单次/循环模式仍按原设定生效)。web 壁纸声音通过 host 注入的 shim 控制(页面在播放时会自己改muted的也能兜住;帧刚加载的 <1 秒可能短暂有声):网页用 Web Audio API 自建的声源、以及禁止内联脚本的 CSP 页面控制不到(保持网页原样)。桌面版直接出声;浏览器 GUI 受自动播放策略限制,冷启动时视频壁纸会先静音,点过页面后才出声。多文件音效每对象只播一首(OWE 的多文件轮播 / 播完重随机未实现)。随声音变化的效果也会跟着动;包内音效驱动的频谱竖条已支持(Simple_Audio_Bars等效果;v0.8.2 起Simple Visualizer也会代建 64 条;v0.9 起其它 visualizer 家族按脚本参数代建、静音也有最小高度)。系统音频(supportsaudioprocessing)已支持浏览器模式:用浏览器打开 GUI → 面板「系统音频」→ 授权共享系统音频即可驱动视觉条;桌面版 App 因宿主权限策略不可用(面板会提示改用浏览器)。 - 应用级光晕默认开启(设置 → 壁纸 → 「光晕」,阈值 / 强度可调、改完立即生效):这是"桌面更亮"的主要来源。嫌亮就调低强度或调高阈值;觉得偏暗就把强度调到 1~1.5。 仅对 scene 壁纸生效。
- 壁纸级 bloom 也会按作者设定生效(
general.bloom*,阈值 / 强度原样):与上面的「光晕」互相独立,同时开启时顺序固定为「壁纸 bloom → 应用级光晕」;hdr未实现。 - 精灵表图标由作者脚本控制帧:调用
pause/setFrame的壁纸(如3765967112的日/夜图标)静止在脚本帧;无脚本的仍约 1 帧/秒自动循环。生产 GUI 里背景层不吃点击(pointer-events:none),按产品决策不做点击转发 ⇒ 点击切帧为已知边界(e2e/harness 内可触发)。壁纸内点击/悬停交互均不可用:脚本的getLayer(name)写入、getEffect().visible与cursorEnter/Leave/Down/Up回调尚未实现,依赖交互的壁纸会保持初始状态。 - 纯文本 / 透明场景会铺作者设定的底色(
general.clearcolor,WE 多为 0-1 色值);clearenabled开关未消费。 - 输入框用半透明玻璃底(不模糊),避免桌面端在输出回复时出现滚动条抖动。
- 视频壁纸能不能播,取决于浏览器的解码能力:视频壁纸直接交给浏览器的
<video>解码 —— HEVC / H.265 需要系统装有对应的解码扩展。缺解码扩展时不再停在黑背景:解码失败或 1.5 秒内没有首帧,会自动回退到预览图,并在设置 →「Wallpaper 壁纸」面板里提示原因(没有预览图则回退空态并同样提示)。想真正播放 HEVC,请换 Chrome 等能解该编码的浏览器,或把视频转成 H.264。 - scene 渲染失败时按多级降级链回退:见下方「降级链(scene 渲染失败时)」小节。
- 抓帧缓存放在本机数据目录:scene 首帧渲染成功后会抓一张 PNG 存到
~/.dsh-use-wallpaper/frames/;设环境变量DSH_USE_WALLPAPER_DATA_DIR可整体搬走。单张 ≤ 12MB、最多 200 张(按修改时间淘汰最旧),随时可删 —— 删掉只会让下次渲染成功时重新抓,不影响画面。 - Workshop 里的「预设壁纸」(preset)也能用:这类项只有预览图和
dependency(依赖的主壁纸)+ 你保存的参数,自己不含场景;选中后会按依赖壁纸渲染,并套用预设里的参数值(列表标签显示 PRESET)。 - 越大的壁纸越吃显存:4K 分辨率下单张壁纸可能占用数百 MB 显存。追求省电/流畅可以用小分辨率或选择简单的壁纸。
环境要求
- 平台与宿主兼容见上方「支持矩阵」。
- 多个 Steam 库都能探测到:自动探测读
steamapps/libraryfolders.vdf(新版 Steam 的实际位置)与config/副本;此前只读安装根,装在第二个库里的壁纸会探测不到。 - 需要本机装有 Wallpaper Engine:插件要从中读取内置的粒子与特效素材。没装或路径没配对时,粒子会退化为纯色圆点(画面仍在,不会白屏)。
- 浏览器需支持 WebGL2(Chrome / Edge 均可);为了更接近 Wallpaper Engine 的效果,推荐使用 Chrome。不支持 WebGL2 时自动退回预览图。
降级链(scene 渲染失败时)
scene 壁纸是实时算出来的,素材写法又千差万别,所以渲染失败是正常可能出现的情况。此时画面按下面的顺序逐级回退,每一级失败只跳过、不弹错、不白屏:
实时渲染(three.js 播放器:背景图层 + 粒子)
│ 模块加载 / 装配失败,或渲染出 0 个可见对象 / 渲染异常
▼
① 内嵌 MP4 —— 作者打包在 .tex 里的视频纹理(动态画面优先)
│ 没有内嵌视频 / 解码失败 / 1.5s 内无首帧
▼
② 抓帧 PNG —— 上次成功渲染时缓存的当前画面(最接近作者构图)
│ 还没有抓到 / 帧文件已被删除
▼
③ 作者预览图 —— Wallpaper Engine 工坊页的封面(图片或 GIF)
│ 作者没有提供 preview
▼
④ 空态 —— 恢复 DSH 默认背景
- 顺序的理由:动态优先于静态(内嵌 MP4 是作者原意),当前构图优先于封面(抓帧比工坊封面更接近实际画面)。
- 视频壁纸(非 scene)走另一条更短的链:
<video>解码 → 失败 / 首帧超时 → 预览图 → 空态,并在面板提示编码问题。 - 抓帧缓存目录是
~/.dsh-use-wallpaper/frames/(可用DSH_USE_WALLPAPER_DATA_DIR覆盖),详见上面的「画面表现」。
发现壁纸有问题?欢迎反馈
上面几条是已知情况,但壁纸库非常庞杂(每张壁纸都是原作者自己搭的效果,写法千奇百怪),没被覆盖到的异常一定还有。如果你发现某张壁纸渲染不对,请提 issue —— 这类反馈是项目最主要的改进来源。
👉 提交 Issue
为了能快速定位,麻烦带上这几项(第一项最关键):
- 壁纸名称与 Workshop ID —— 例如「Crimson Horizon,ID
3765967112」。ID 可以在设置面板的壁纸目录里找到(workshop/content/431960/<ID>/)。 - 现象描述 —— 是整屏黑掉、局部黑块、某个效果不动、粒子消失,还是画面偏色/过暗?
- 对比信息(如果方便) —— 同一张壁纸在桌面版 Wallpaper Engine 上的表现(截图对比最好)。有对比就能立刻区分「我们的缺陷」和「原作者的设定」。
- 环境 —— 浏览器与版本、是否装了 Wallpaper Engine、显示器分辨率。
- Console 报错(可选但很有用) —— 打开开发者工具 Console,搜
[three]或[warn]相关的行,贴出来。
若某张壁纸能稳定复现问题,把它设为唯一变量(其他设置保持默认)会让排查快很多。
想看实现细节、效果链覆盖率和工程现状(如显存实测、性能门槛状态、未接入的备用路径),见 docs/technical-notes.md。
🏗️ 架构一览
面向开发者与贡献者 —— 只想用的话可以跳过这一节。
展开目录结构与降级链
src/host/ Node 侧(Cordis 插件):扫描壁纸目录、解包 PKGV0001、HTTP 路由、Steam 路径探测、settings
├─ data-dir / scene-frame-store 插件数据目录与抓帧 PNG 存储(原子写 + 限额淘汰)
├─ scene-media-probe 从 .tex 头探测内嵌 MP4(video-probe / embedded-video)
└─ user-props project.json × scene.json 的四类型用户属性聚合(只返回被引用的键)
src/client/ 浏览器侧(esbuild → dist/client.js),渲染主路径在这里
├─ threejs-player.ts three.js 播放器(背景 Mesh + 粒子 billboard)
├─ three-renderer.ts 生产接线(loadSceneToThree + resize/dpr + 材质混合解析)
├─ tex-loader.ts TEXV0005 解码(RGBA/DXT/RG88/R8 + 幂填充裁剪 + sprite 帧 + 行序)
├─ object-effects.ts 对象级效果链编排(ObjectEffectStage)
├─ effect-runner.ts 效果执行器(uniform 绑定 / 纹理槽 / pass 推进)
├─ scene-json / scene-assets / scene-graph / visibility 场景解析与几何
├─ scene-fallback / frame-export scene 降级链(内嵌 MP4 → 抓帧 → 预览)与首帧 PNG 导出
├─ rotation / library-view / local-store 轮播调度、库筛选/收藏/隐藏、localStorage 封装
├─ wallpaper-properties / media-health 用户属性读写、视频解码失败提示
├─ wasm-loader.ts wasm 引擎加载(只服务 CPU 粒子模拟)
└─ index / wallpaper-controller / background-layer / settings / styles 引导、控制、背景层、设置
src/shared/ 跨 host/client 类型(WallpaperInfo、SceneDescription、SceneObject 等)
wasm/ Rust 引擎(wasm-bindgen):particle(CPU 粒子模拟)—— 旧 WebGPU 渲染器已删除
scripts/ build-client.mjs(esbuild 打包 + wasm 复制);check-known-failures.mjs(CI 失败基线门禁)
tests/ vitest 单测(node + jsdom 双环境)
e2e/ 端到端渲染验证(headless Edge + 生产 lib/ 逐像素判定,可上 CI)
.github/ CI:tsc + lib/ 产物新鲜度 / vitest 新增失败 / Windows 渲染 e2e
docs/ 开发配置(dev-setup.md);设计文档与实施计划(superpowers/*);技术细节(technical-notes.md);效果视频(videos/*)
降级链
scene 壁纸:
three.js 播放器(背景图层 + 粒子)
│ 模块加载/创建失败,或渲染出 0 个可见对象
▼
内嵌 MP4(.tex 里的 Video 纹理)
│ 无 / 播放失败 / 1.5s 无首帧
▼
抓帧 PNG(<dataDir>/frames/<id>.png;默认 ~/.dsh-use-wallpaper)
│ 无缓存
▼
作者 preview 图 + Ken Burns
│ 无 preview
▼
空态(DSH 默认背景)
video 壁纸:<video> 解码 → 失败 / 首帧超时 → preview 图 → 空态(面板提示编码问题)
🛠️ 构建与开发
pnpm install
pnpm run build # tsc -p tsconfig.json → lib/(host 编译,strict)
pnpm run build:wasm # cd wasm && wasm-pack build --target web --release --features cpu-sim → wasm/pkg/
pnpm run build:client # node scripts/build-client.mjs → dist/client.js
pnpm test # vitest run(node + jsdom 双环境)
# 端到端渲染验证(headless Edge + 生产 lib/,逐像素判定;失败置非零退出码)
pnpm run e2e:colorblend # 不依赖本机素材,CI 里跑的就是它
pnpm run e2e:hidpi # 需本机 Wallpaper Engine 壁纸库
pnpm run e2e:compare # A/B 截图逐像素对拍(零回归验收)
- 改过
wasm/(Rust)必须先build:wasm再build:client—— client 复制的是wasm/pkg的现成产物,顺序反了会复制旧 wasm。 - client 侧改动(
dist/)通常自动热重载:web profile 始终挂载@deepseek-ai/dsh-client-hmr,轮询 bundle 的mtime/size变化并推rebuilt帧。(桌面版除外:桌面版 host 在启动时就把客户端 bundle 拍成内存快照,改完dist/必须整个 App 重启 —— 见上面「1. 安装插件」的桌面版说明。) - host 侧改动(
lib/)必须重启dsh web(host 模块热重载默认disabled)。 - CI(
.github/workflows/ci.yml):tsc+lib/产物新鲜度守卫、vitest只对新增失败判红(基线在scripts/known-failures.json)、Windows 上跑渲染 e2e(软件光栅化,不需要 GPU)。
🔐 数据与隐私
本插件不联网、无遥测、不上传任何数据。落盘只有两处:
| 数据 | 位置 | 内容与清理 |
|---|---|---|
| 首帧抓帧缓存 | ~/.dsh-use-wallpaper/frames/<壁纸id>.png(设 DSH_USE_WALLPAPER_DATA_DIR 可改根目录) | scene 首帧成功后的截图,供降级链回退;单张 ≤12MB、最多 200 张(按修改时间淘汰最旧);随时可删,删了下次渲染成功会重新抓 |
| 浏览器本地状态 | localStorage:we:fav / we:hidden / we:recent / we:userprop:<壁纸id>:<key> / we:renderfail:<壁纸id> / we:setup-tip | 收藏 / 隐藏 / 最近使用 / 用户属性 / 渲染失败记忆;随站点数据清除 |
设置本身写在 profile cordis.patch.yml 的 dsh-wallpaper-engine 条目 config 里(见「配置项」)。
只在内存、不落盘:媒体集成(Windows SMTC)读到的歌曲标题/歌手/封面、系统音频频谱、壁纸音效解码数据、视频健康采样。
权限提示:系统音频可视化需要浏览器 getDisplayMedia 授权(可随时停止共享、不落盘不上传);媒体集成可在面板关闭;开机动画的本地视频只经回环路由读取。
⬆️ 升级
升级方式与安装方式一一对应(见「快速开始」):
| 安装方式 | 升级方式 |
|---|---|
| npm(稳定版) | dsh plugin --profile web add "@dsh-use/wallpaper-engine@latest" → dsh plugin --profile web install → 重启 dsh web |
| GitHub(最新) | dsh plugin --profile web add github:yu502950715yang/dsh-use-wallpaper → dsh plugin --profile web install |
| 桌面版 App | 侧边栏 插件 页 → 该插件 → 更新(npm 版)/ 重新添加本地路径 |
| 插件市场索引源 | 「插件 → 发现」里更新 |
重启语义(重要):
dsh web:host 侧改动必须重启命令;client 侧改动刷新页面即可(dsh-client-hmr自动重载)。- 桌面版 App:host 启动时把客户端 bundle 拍成内存快照 ⇒ 升级后必须完全退出 App 再启动(托盘退出),只刷新页面拿不到新客户端代码。
跨版本兼容承诺(1.x):设置字段、localStorage 键、数据目录只增不改;重命名/删除走 major 版本并在 CHANGELOG 给出迁移步骤。升级不需要手工迁移配置。
从 0.x 升级到 1.0:见 CHANGELOG.md 的「破坏性变更」段——1.0 要求 DSH ≥ 0.2.0-rc.1、移除了 ≤0.1.6 的旧设置路径、新增 engines.dsh / 平台声明;设置字段无重命名或删除。
🧹 卸载
dsh plugin --profile web remove "@dsh-use/wallpaper-engine"
dsh plugin --profile web install
# 重启 dsh web
桌面版在侧边栏 插件 页卸载(会二次确认);
dsh plugin同样不适用于桌面版 profile(见「1. 安装插件」)。
卸载后如需彻底清理残留(不清理也不影响使用,残留只有抓帧缓存与几个 localStorage 键):
# 1) 抓帧缓存与插件数据目录(Windows)
Remove-Item -Recurse -Force "$env:USERPROFILE\.dsh-use-wallpaper"
# 2) 浏览器 localStorage 键:在 GUI 开发者工具 Console 里执行
# Object.keys(localStorage).filter(k => k.startsWith('we:'))
# .forEach(k => localStorage.removeItem(k))
# 3) profile 配置残留:从 cordis.patch.yml 删掉 dsh-wallpaper-engine 条目
📄 许可与致谢
- 代码:MIT(见 LICENSE);第三方依赖清单与壁纸素材边界见 THIRD-PARTY-NOTICES.md。
- 壁纸、纹理等素材版权归原作者 / Wallpaper Engine 所有;本插件只在其上渲染,不重新分发第三方素材(WE 内置纹理在运行时从你本机安装目录读取)。
- 格式与行为语义对齐自 linux-wallpaperengine 及开源 Wallpaper Engine 逆向实现。
- 版本变更见 CHANGELOG.md;参与贡献见 CONTRIBUTING.md;安全问题报告见 SECURITY.md。
- 感谢Linux.do社区对本项目的推广。
- README 中的效果视频由本插件的生产渲染代码在本机实测录制,仅用于展示。
🔗 相关链接
- GitHub 仓库
- 版本变更 CHANGELOG
- 贡献指南 CONTRIBUTING
- 安全策略 SECURITY
- 第三方依赖与素材边界 THIRD-PARTY-NOTICES
- 插件市场索引源
index.json(可粘贴到「插件 → 发现 → 索引源」) - dsh-plugin 主题页
- DeepSeek Harness
- 开发环境配置(docs/dev-setup.md)

