{"id":20418375,"url":"https://github.com/katsutedev/background","last_synced_at":"2025-06-15T21:33:30.309Z","repository":{"id":37919140,"uuid":"506347689","full_name":"KatsuteDev/Background","owner":"KatsuteDev","description":"The most advanced background image extension for VSCode","archived":false,"fork":false,"pushed_at":"2025-06-10T11:26:59.000Z","size":92870,"stargazers_count":99,"open_issues_count":1,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-10T12:32:27.446Z","etag":null,"topics":["background","background-image","backgrounds","extension","ide-theme","nodejs","theme","ts","typescript","visual-studio-code","visual-studio-code-extension","visual-studio-code-theme","vscode","vscode-background","vscode-extension","vscode-theme"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=katsute.code-background","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KatsuteDev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"custom":["katsute.dev"]}},"created_at":"2022-06-22T17:40:10.000Z","updated_at":"2025-06-10T11:27:01.000Z","dependencies_parsed_at":"2022-07-08T00:20:27.618Z","dependency_job_id":"510940de-02e0-4773-9e72-7b50a3ed8907","html_url":"https://github.com/KatsuteDev/Background","commit_stats":null,"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"purl":"pkg:github/KatsuteDev/Background","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KatsuteDev%2FBackground","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KatsuteDev%2FBackground/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KatsuteDev%2FBackground/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KatsuteDev%2FBackground/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KatsuteDev","download_url":"https://codeload.github.com/KatsuteDev/Background/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KatsuteDev%2FBackground/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260053291,"owners_count":22951851,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["background","background-image","backgrounds","extension","ide-theme","nodejs","theme","ts","typescript","visual-studio-code","visual-studio-code-extension","visual-studio-code-theme","vscode","vscode-background","vscode-extension","vscode-theme"],"created_at":"2024-11-15T06:32:11.532Z","updated_at":"2025-06-15T21:33:30.289Z","avatar_url":"https://github.com/KatsuteDev.png","language":"TypeScript","readme":"\u003cdiv id=\"top\" align=\"center\"\u003e\n    \u003cbr\u003e\n    \u003ca href=\"https://github.com/KatsuteDev/Background#readme\"\u003e\n        \u003cimg alt=\"logo\" width=\"100\" height=\"100\" src=\"https://raw.githubusercontent.com/KatsuteDev/Background/main/assets/icon.png\"\u003e\n    \u003c/a\u003e\n    \u003ch3\u003eBackground\u003c/h3\u003e\n    \u003ch4\u003eThe most advanced background image extension for VSCode\u003c/h4\u003e\n    \u003ch5\u003eWindows + Mac + Linux\u003c/h5\u003e\n    \u003ca href=\"https://marketplace.visualstudio.com/items?itemName=katsute.code-background\"\u003e\u003cimg alt=\"rating\" src=\"https://img.shields.io/visual-studio-marketplace/stars/katsute.code-background?style=for-the-badge\u0026logo=visualstudiocode\u0026labelColor=252526\u0026color=0098FF\u0026label=Rating\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://marketplace.visualstudio.com/items?itemName=katsute.code-background\"\u003e\u003cimg alt=\"installs\" src=\"https://img.shields.io/visual-studio-marketplace/i/katsute.code-background?style=for-the-badge\u0026logo=visualstudiocode\u0026labelColor=252526\u0026color=0098FF\u0026label=Installs\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://marketplace.visualstudio.com/items?itemName=katsute.code-background\"\u003e\u003cimg alt=\"downloads\" src=\"https://img.shields.io/visual-studio-marketplace/d/katsute.code-background?style=for-the-badge\u0026logo=visualstudiocode\u0026labelColor=252526\u0026color=0098FF\u0026label=Downloads\"\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\nAdd multiple background images for the window, editors, sidebars, or the panel. Load backgrounds from file, [glob](https://github.com/isaacs/node-glob#glob-primer), or URL. Transition between multiple background images.\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg alt=\"editor background\" src=\"https://raw.githubusercontent.com/KatsuteDev/Background/main/assets/editor.gif\"\u003e\n\u003c/div\u003e\n\n## Installation\n\n - Install from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=katsute.code-background).\n - Install directly from VSCode using the id [`katsute.code-background`](https://marketplace.visualstudio.com/items?itemName=katsute.code-background).\n\nCustomize using the \u003ckbd\u003eBackground: Configuration\u003c/kbd\u003e command or press the **Background** button in the bottom right to access the configuration menu.\n\nInstall using the \u003ckbd\u003eBackground: Install\u003c/kbd\u003e command or press the **Install** button in the configuration menu to install the background.\n\n## Features\n\n#### Multiple Backgrounds\n\nAdd background images for the whole window, editors, sidebars, or the panel. Transition between multiple background images.\n\n\u003cdiv align=\"center\"\u003e\n    \u003ch6\u003eFull Window\u003c/h6\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/KatsuteDev/Background/main/assets/window.gif\"\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\u003cdiv align=\"center\"\u003e\n    \u003ch6\u003eEditor, Sidebar, and Terminal\u003c/h6\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/KatsuteDev/Background/main/assets/editor.gif\"\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\u003cdiv align=\"center\"\u003e\n    \u003ch6\u003eSlideshow\u003c/h6\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/KatsuteDev/Background/main/assets/transition.gif\"\u003e\n\u003c/div\u003e\n\n#### Configuration Menu\n\nUse the \u003ckbd\u003eBackground: Configuration\u003c/kbd\u003e command or press the **Background** button in the bottom right to access the configuration menu.\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/KatsuteDev/Background/main/assets/configuration.gif\"\u003e\n\u003c/div\u003e\n\n#### Glob, URL, and Environment Variable Support\n\nAdd background images by file, folder, or URL. Supports [glob](https://github.com/isaacs/node-glob#glob-primer) and [environment variables](#environment-variables).\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/KatsuteDev/Background/main/assets/glob.gif\"\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"right\"\u003e\u003ca href=\"#top\"\u003e\u003ccode\u003e▲\u003c/code\u003e\u003c/a\u003e\u003c/div\u003e\n\n## Commands\n\n| Command | Description |\n|:--|:--|\n|\u003ckbd\u003eBackground: Install\u003c/kbd\u003e|Installs and enables the background|\n|\u003ckbd\u003eBackground: Uninstall\u003c/kbd\u003e|Uninstalls and disables the background|\n|\u003ckbd\u003eBackground: Reload\u003c/kbd\u003e|Randomizes the current background|\n|\u003ckbd\u003eBackground: Configuration\u003c/kbd\u003e|Opens the configuration menu|\n|\u003ckbd\u003eBackground: Changelog\u003c/kbd\u003e|Opens the changelog|\n\n\u003cdiv align=\"right\"\u003e\u003ca href=\"#top\"\u003e\u003ccode\u003e▲\u003c/code\u003e\u003c/a\u003e\u003c/div\u003e\n\n## Configuration\n\nUse the \u003ckbd\u003eBackground: Configuration\u003c/kbd\u003e command or press the **Background** button in the bottom right to access the configuration menu.\n\n|Background|Description|\n|:--|:--|\n|Window Backgrounds|The list of files or globs to use for the window background image|\n|Editor Backgrounds|The list of files or globs to use for editor background images|\n|Sidebar Backgrounds|The list of files or globs to use for the sidebar background images|\n|Panel Backgrounds|The list of files or globs to use for the panel background image|\n|||\n|**Style Option**|**Description**|\n|Alignment|Background alignment|\n|Alignment Value|Background alignment (CSS)|\n|Blur|Background blur (CSS)|\n|Opacity|Background opacity, 1 is fully visible and 0 is invisible|\n|Repeat|Background repeat|\n|Size|Background size|\n|Size Value|Background size (CSS)|\n|Change Time|How often to change the background image in seconds, set to 0 to never change|\n|||\n|**Advanced Option**|**Description**|\n|Auto Install|Automatically install backgrounds on startup|\n|Render Content Above Background|Show images, PDFs, and markdown previews on top of the background|\n|Use Inverted Opacity|Use an inverted opacity, so 0 is visible and 1 is invisible|\n|Smooth Image Rendering|Use smooth image rendering when resizing images instead of pixelated|\n|Setting Scope|Where to save background settings - Global or Workspace|\n|CSS|Custom CSS|\n\n\u003cdiv align=\"right\"\u003e\u003ca href=\"#top\"\u003e\u003ccode\u003e▲\u003c/code\u003e\u003c/a\u003e\u003c/div\u003e\n\n## Environment Variables\n\nIf the path is not working, add an additional `/` after the variable.\n\n|Variable|Description|\n|:--|:--|\n|`${vscode:workspace}`|Current VSCode project folder|\n|`${vscode:user}`|VSCode user directory, either `Code/User` or `data/user-data/User`|\n|`${user:home}`|Current user's home directory|\n|`${...}`|System environment variable|\n\n\u003cdiv align=\"right\"\u003e\u003ca href=\"#top\"\u003e\u003ccode\u003e▲\u003c/code\u003e\u003c/a\u003e\u003c/div\u003e\n\n## \u0026nbsp;\n\n### API\n\nAdd this extension to your `package.json`.\n\n```json\n{\n    ...\n    \"extensionDependencies\": [\n        \"katsute.code-background\"\n    ]\n    ...\n}\n```\n\nAccess the api by using:\n\n```js\nconst background = vscode.extensions.getExtension(\"katsute.code-background\").exports;\n```\n\n * `install(): void`\n\n   Runs the `Background: Install` command.\n * `uninstall(): void`\n\n   Runs the `Background: Uninstall` command.\n * `reload(): void`\n\n   Runs the `Background: Reload` command.\n * `get(ui): string[]?`\n   * `ui` : Background to get from; either `window`, `editor`, `sidebar`, `panel`.\n\n   Returns an array of globs for the specified background.\n * `add(ui, glob): Promise\u003cboolean\u003e`\n   * `ui` : Background to add to; either `window`, `editor`, `sidebar`, `panel`.\n   * `glob`: Glob to add.\n\n   Returns true if successful.\n * `replace(ui, old, glob): Promise\u003cboolean\u003e`\n   * `ui` : Background to replace from; either `window`, `editor`, `sidebar`, `panel`.\n   * `old`: Glob to replace.\n   * `glob`: Updated glob.\n\n   Returns true if successful.\n * `remove(ui, glob): Promise\u003cboolean\u003e`\n   * `ui` : Background to remove from; either `window`, `editor`, `sidebar`, `panel`.\n   * `glob`: Glob to remove.\n\n   Returns true if successful.\n\n\u003cdiv align=\"right\"\u003e\u003ca href=\"#top\"\u003e\u003ccode\u003e▲\u003c/code\u003e\u003c/a\u003e\u003c/div\u003e\n\n## \u0026nbsp;\n\nThis extension is released under the [GNU General Public License (GPL) v2.0](https://github.com/KatsuteDev/Background/blob/main/LICENSE).","funding_links":["katsute.dev"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkatsutedev%2Fbackground","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkatsutedev%2Fbackground","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkatsutedev%2Fbackground/lists"}