BEBR Video Backgrounds

Add multiple background images or videos for the window, editors, sidebars, or the panel. Load backgrounds from file, glob, or URL. Transition between multiple background images.

MP4 and WEBM files are supported as global window backgrounds. Videos autoplay muted, loop continuously, ignore pointer input, and use the background.videoSpeed setting. Add them through Background: Configuration in the Window Backgrounds section, then run Background: Install.

Use Background: Music Player to open an integrated audio player inside VS Code. Add MP3, WAV, OGG, M4A, AAC, or FLAC files, select tracks from the playlist, control volume, play/pause, skip tracks, and enable looping. The playlist is saved globally.

Use Background: Toggle Video Audio to enable or disable sound on the global video background, then run Background: Install. Chromium may still require a user interaction before allowing autoplay with sound.

Installation

• Install the generated .vsix from VS Code using Extensions: Install from VSIX.
• After publication, install it using your Marketplace identifier: backgroundpro.background-pro (replace backgroundpro with your own publisher ID before publishing).

This project preserves the GPL-2.0 license and attribution required by the original Katsute Background code it extends. The global workbench method modifies VS Code installation files and is not an official VS Code API.

Customize using the Background: Configuration command or press the Background button in the bottom right to access the configuration menu.

Install using the Background: Install command or press the Install button in the configuration menu to install the background.

Features

Multiple Backgrounds

Add background images for the whole window, editors, sidebars, or the panel. Transition between multiple background images.

Configuration Menu

Use the Background: Configuration command or press the Background button in the bottom right to access the configuration menu.

Glob, URL, and Environment Variable Support

Add background images by file, folder, or URL. Supports glob and environment variables.

Commands

Configuration

Use the Background: Configuration command or press the Background button in the bottom right to access the configuration menu.

Presets

Use Background: Preset to apply Cinematic, Minimal, Neon, or Dark Focus. Use Background: Toggle Focus Mode to hide or restore the background; both commands notify you when Background: Install is required.

Environment Variables

If the path is not working, add an additional / after the variable.

API

Requires API setting to be turned on in the extension

Add this extension to your package.json.

{
    ...
    "extensionDependencies": [
        "katsute.code-background"
    ]
    ...
}

Access the api by using:

const background = vscode.extensions.getExtension("katsute.code-background").exports;

• install(): void

  Runs the Background: Install command.

• uninstall(): void

  Runs the Background: Uninstall command.

• reload(): void

  Runs the Background: Reload command.

• get(ui): string[]?

  • ui : Background to get from; either window, editor, sidebar, panel.

  Returns an array of globs for the specified background.

• add(ui, glob): Promise<boolean>

  • ui : Background to add to; either window, editor, sidebar, panel.
  • glob: Glob to add.

  Returns true if successful.

• replace(ui, old, glob): Promise<boolean>

  • ui : Background to replace from; either window, editor, sidebar, panel.
  • old: Glob to replace.
  • glob: Updated glob.

  Returns true if successful.

• remove(ui, glob): Promise<boolean>

  • ui : Background to remove from; either window, editor, sidebar, panel.
  • glob: Glob to remove.

  Returns true if successful.

This extension is released under the GNU General Public License (GPL) v2.0.