VSCode-WallpaperCustom static / animated wallpapers for VS Code — with real Wallpaper Engine English | 简体中文
Features
InstallFrom a VSIX (local build)
From source
Quick start
How it worksVS Code's workbench is a single
For Settings (highlights)
The full list lives in Settings → Extensions → VSCode-Wallpaper. Editing
|
| Platform | Path |
|---|---|
| Windows | %APPDATA%\Code\User\settings.json |
| macOS | ~/Library/Application Support/Code/User/settings.json |
| Linux | ~/.config/Code/User/settings.json |
Or, from anywhere: Ctrl+Shift+P → Preferences: Open User Settings (JSON).
A complete example
{
"vsw.enabled": true,
"vsw.wallpaper.source": "wallpaperEngine",
"vsw.wallpaper.weId": "3401773707",
"vsw.wallpaper.sceneMode": "live",
"vsw.wallpaper.dim": 0.25,
"vsw.wallpaper.fit": "cover",
"vsw.glass.enabled": true,
"vsw.glass.blur": 26,
"vsw.glass.opacity": 0.5,
"vsw.glass.saturation": 1.45,
"vsw.glass.regions": ["titlebar", "activitybar", "sidebar", "auxiliarybar",
"editor", "panel", "statusbar", "tabs"],
"vsw.layout.radius": 0,
"vsw.layout.panelRadius": 12,
"vsw.layout.gapTop": 4,
"vsw.layout.tabRadius": 8,
// scene wallpapers expose their own properties; keys come from project.json
"vsw.sceneProps": {
"y": false,
"newproperty17": 0.06,
"bgm": 0.5
}
}
vsw.wallpaper.source accepts three values:
file—vsw.wallpaper.filepoints at one image / video /scene.pkg.folder—vsw.wallpaper.folderis rotated everyintervalSec, honouringshuffleandrecursive.wallpaperEngine— follows the currently selected Wallpaper Engine wallpaper; setweIdto pin one item instead.
After editing
Save the file. The extension re-injects the runtime automatically, then reload the window once —
Ctrl+Shift+P → Developer: Reload Window, or click Reload window in the sidebar panel.
(Ctrl+R does not reload the VS Code window.) With vsw.autoReload on, the extension does the reload for you.
All settings
| Setting | Default | Description |
|---|---|---|
vsw.enabled |
false |
Master switch. |
vsw.wallpaper.source |
file |
Wallpaper source: file / folder / wallpaperEngine. |
vsw.wallpaper.file |
"" |
Path to one wallpaper — image, video or scene.pkg. |
vsw.wallpaper.folder |
"" |
Folder to rotate through. |
vsw.wallpaper.recursive |
true |
Recurse into subfolders while rotating. |
vsw.wallpaper.intervalSec |
300 |
Rotation interval in seconds. |
vsw.wallpaper.shuffle |
true |
Randomise rotation order. |
vsw.wallpaper.fit |
cover |
How the wallpaper fills: cover / contain / fill. |
vsw.wallpaper.opacity |
1 |
Opacity of the whole wallpaper layer (0–1). |
vsw.wallpaper.dim |
0.25 |
How much the wallpaper is darkened (0–1). |
vsw.wallpaper.blur |
0 |
Blur applied to the wallpaper itself (px). |
vsw.wallpaper.pauseOnBlur |
true |
Pause video playback when the window loses focus. |
vsw.glass.enabled |
true |
Frosted glass on/off. |
vsw.glass.blur |
24 |
Frosted glass blur radius (px). |
vsw.glass.opacity |
0.55 |
Panel tint opacity (0–1). |
vsw.glass.saturation |
1.4 |
Saturation multiplier for the glass. |
vsw.glass.border |
true |
Draw a hairline border around panels. |
vsw.glass.regions |
["activitybar", "sidebar", "editor", "panel", "statusbar", "tabs"] |
Which workbench regions get glass. |
vsw.layout.tabRadius |
8 |
Tab corner radius (px). |
vsw.layout.compactTabs |
false |
Compact tabs. |
vsw.layout.hideStatusbar |
false |
Hide the status bar. |
vsw.layout.hideActivityBar |
false |
Hide the activity bar. |
vsw.layout.activityBarLocation |
default |
Activity bar position: default / top / hidden. |
vsw.layout.sideBarLocation |
left |
Side bar position: left / right. |
vsw.layout.borderless |
true |
Remove panel border lines. |
vsw.autoReload |
true |
Reload the window automatically after applying. |
vsw.wallpaper.weId |
"" |
Pin one Wallpaper Engine workshop item by ID. |
vsw.layout.radius |
0 |
Window corner radius (px); 0 = square. |
vsw.layout.radiusTopLeft |
-1 |
Top-left corner only; -1 follows radius. |
vsw.layout.radiusTopRight |
-1 |
Top-right corner only; -1 follows radius. |
vsw.layout.radiusBottomLeft |
-1 |
Bottom-left corner only; -1 follows radius. |
vsw.layout.radiusBottomRight |
-1 |
Bottom-right corner only; -1 follows radius. |
vsw.layout.gapTop |
0 |
Top padding of the content area (px). |
vsw.layout.gapSide |
0 |
Left/right padding of the content area (px). |
vsw.layout.panelRadius |
0 |
Sidebar / editor corner radius (px). |
vsw.layout.gapBottom |
0 |
Bottom padding of the content area (px). |
vsw.glass.editorDelta |
0 |
Brightness offset for the editor (higher = lighter). |
vsw.glass.barDelta |
0 |
Brightness offset for title/status bars. |
vsw.wallpaper.sceneMode |
live |
live renders scene.pkg; preview falls back to preview.gif/jpg. |
vsw.debug |
false |
Draw a debug log box over the wallpaper layer. |
vsw.sceneProps |
{} |
User properties for a scene wallpaper (keys come from project.json). |
Known limitations
- Window control buttons (minimize / maximize / close) are drawn by Electron's
titleBarOverlayon Windows and cannot be styled by CSS. - A very narrow element cannot share the same frosted look as a wide one:
backdrop-filteraverages what is behind it, so a 44 px activity bar always looks flatter than a 300 px sidebar. scenewallpapers that rely on heavy GPU effects may run slower than in Wallpaper Engine itself.
Development
npm install
node esbuild.js # bundles src/extension.ts -> dist/extension.js, src/media/loader.ts -> dist/loader.js
npx tsc --noEmit # type check
src/media/loader.ts is the injected runtime (runs inside the workbench page), everything else runs in the extension host.
Credits
- webwallgl — WebGL2 Wallpaper Engine renderer (MIT).
- Inspired by vscode-background for the HTML injection approach.
License
MIT