An open API service indexing awesome lists of open source software.

https://github.com/illixion/vscode-vibrancy-continued

Enable Acrylic/Glass effect for your VS Code.
https://github.com/illixion/vscode-vibrancy-continued

vscode-extension vscode-theme

Last synced: 21 days ago
JSON representation

Enable Acrylic/Glass effect for your VS Code.

Awesome Lists containing this project

README

          

# Visual Studio Code Extension - Vibrancy Continued

Enable Acrylic/Glass effect in VS Code.

> [!TIP]
> Solutions for common issues can be found in the [FAQ](#FAQs) and [Known Errors](https://github.com/illixion/vscode-vibrancy-continued/blob/main/docs/known-errors.md)

> [!IMPORTANT]
> Windows 10/11 users: see [important notice](#️-important-notice-for-windows-1011-users) at the top of the description regarding a known issue with VSCode on Windows.

![screenshot](./images/screenshot.png)

[![VS Code Insiders (nightly)](https://img.shields.io/github/actions/workflow/status/illixion/vscode-vibrancy-continued/test.yml?event=schedule&label=VS%20Code%20Insiders%20%28nightly%29)](https://github.com/illixion/vscode-vibrancy-continued/actions/workflows/test.yml?query=event%3Aschedule)
[![](https://vsmarketplacebadges.dev/version/illixion.vscode-vibrancy-continued.png)](https://marketplace.visualstudio.com/items?itemName=illixion.vscode-vibrancy-continued) 
[![](https://vsmarketplacebadges.dev/rating-star/illixion.vscode-vibrancy-continued.png)](https://marketplace.visualstudio.com/items?itemName=illixion.vscode-vibrancy-continued) 
[![](https://vsmarketplacebadges.dev/installs-short/illixion.vscode-vibrancy-continued.png)](https://marketplace.visualstudio.com/items?itemName=illixion.vscode-vibrancy-continued) 
[![Open VSX Version](https://img.shields.io/open-vsx/v/illixion/vscode-vibrancy-continued?label=Open%20VSX)](https://open-vsx.org/extension/illixion/vscode-vibrancy-continued) 
[![Open VSX Downloads](https://img.shields.io/open-vsx/dt/illixion/vscode-vibrancy-continued?label=Open%20VSX%20downloads)](https://open-vsx.org/extension/illixion/vscode-vibrancy-continued)

[![](https://img.shields.io/github/stars/illixion/vscode-vibrancy-continued.svg?style=social)](https://github.com/illixion/vscode-vibrancy-continued) 
[![](https://img.shields.io/github/watchers/illixion/vscode-vibrancy-continued.svg?style=social)](https://github.com/illixion/vscode-vibrancy-continued)

Links: [GitHub](https://github.com/illixion/vscode-vibrancy-continued) | [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=illixion.vscode-vibrancy-continued) | [Open VSX Registry](https://open-vsx.org/extension/illixion/vscode-vibrancy-continued) | [issues](https://github.com/illixion/vscode-vibrancy-continued/issues)

Maintenance of this project is made possible by all the contributors and sponsors. If you'd like to sponsor this project and have your avatar or company logo appear below, click here. Any support is greatly appreciated 💖


User avatar of user doughayden
User avatar of user hjnnjh

# ❗️ Important notice for Windows 10/11 users

### tl;dr YOU WON'T BE ABLE TO RESIZE THE VSCODE WINDOW unless you do this

By default, when Vibrancy is installed on VSCode 1.86 and newer on Windows, your VSCode windows **may stop being resizable, snappable or maximizable**. This is a known issue related to VSCode 1.86 and Electron 27 and it occurs due to hardware acceleration leading to distorted text. Vibrancy will by default apply a mitigation that enables frameless windows, but this also causes issues with window interaction.

The correct process to install Vibrancy on Windows is:

1. Update your VSCode shortcut to include `--disable-gpu-compositing` at the end of "Target" field, for example: `"C:\Users\User\AppData\Local\Programs\Microsoft VS Code\Code.exe" --disable-gpu-compositing`
2. (optional) Update your shell configuration to add the same argument to `code`, needed if VSCode isn't running when you use `code`
3. Install Vibrancy Continued
4. Go to settings and check **Disable frameless window** (`vscode_vibrancy.disableFramelessWindow`)
5. Press F1 and select **Reload Vibrancy**

For more information, see issues [#140](https://github.com/illixion/vscode-vibrancy-continued/issues/140) and [#122](https://github.com/illixion/vscode-vibrancy-continued/issues/122).

# ⚠️ "Your VSCode installation appears to be corrupt"

This extension works by editing VS Code's checksum-verified HTML files, which means that a warning prompt will appear after installing and enabling Vibrancy Continued. This warning is safe to disregard, and all changes can be reverted. Click on the cogwheel and select **Don't Show Again** to hide it.

![screenshot](./images/warn.png)
![screenshot](./images/warnfix.png)

If you don't have the option to hide the alert, or to fix an `[Unsupported]` warning in VSCode's title bar, please refer to this extension: [Fix VSCode Checksums Next](https://marketplace.visualstudio.com/items?itemName=RimuruChan.vscode-fix-checksums-next).

# Supported Operating Systems

✔ macOS (Intel & Apple Silicon)

✔ Windows 10/11 (x64 & ARM64)

✔ Linux (transparency only, blur requires a compositor such as KWin, Hyprland, or Picom)

# Supported code editors

✔ Visual Studio Code (v1.86 and newer)

✔ VSCodium

✔ Code - OSS

✔ Cursor

✔ Antigravity

Some editors may present a [persistent warning](#️-your-vscode-installation-appears-to-be-corrupt) warning about the installation being corrupted, use this extension to fix it: [Fix VSCode Checksums Next](https://marketplace.visualstudio.com/items?itemName=RimuruChan.vscode-fix-checksums-next).

# Getting Started

1. Install the extension from [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=illixion.vscode-vibrancy-continued).

2. Press F1 and activate command "Reload Vibrancy."

![step-2](./images/step-2.png)

3. Restart VSCode when prompted.

Each time VS Code is updated, please re-enable Vibrancy using the same steps. If you're experiencing issues, please check the [FAQs](#faqs).

## Options

#### Type (`vscode_vibrancy.type`)

Native method of Vibrancy effect. See here for screenshots of all available options: [Vibrancy Types](https://github.com/illixion/vscode-vibrancy-continued/blob/main/docs/vibrancy-types.md)

* auto : Automatically switch with system version.
* transparent: Make VSCode transparent only, without blur. (Linux default)
* acrylic : (Windows 10 only) Fluent Design blur.
* under-window, fullscreen-ui, appearance-based, light, dark, titlebar, selection, menu, popover, sidebar, medium-light, ultra-dark: (MacOS only)

#### Opacity (`vscode_vibrancy.opacity`)

Opacity of Vibrancy effect. -1 is theme default, 0 is maximum transparency, and 1 will remove all transparency.

*value: -1.0 ~ 1.0*

#### Background Override (`vscode_vibrancy.backgroundOverride`)

Override the theme's background color for the vibrancy opacity effect. Uses VSCode's built-in color picker. Leave empty to use the theme default.

*color string (e.g. #000000), default is empty*

#### Custom imports (`vscode_vibrancy.imports`)

Import any custom CSS/JS files into the VSCode editor directly without requiring custom CSS extensions. The files will be imported in the order they are listed. On Windows, forward slashes must be used.

Use this feature to add a custom Vibrancy Continued theme or modify an existing one.

EXAMPLES:

- Windows: `[ C:/Users/MyUserName/Documents/custom.css ]`
- macOS: `[ /Users/MyUserName/Documents/custom.css ]`
- Linux: `[ /home/MyUserName/Documents/custom.css ]`

*value: array[]*

#### Prevent Flash (`vscode_vibrancy.preventFlash`)

Use a new method for preventing window flashing during resizing. Eliminates the need for a refresh interval, but may be less compatible in some cases.

*boolean, default is true*

#### Force Frameless Window (`vscode_vibrancy.forceFramelessWindow`)

Always set VSCode window to use `frame: false`, which can sometimes solve visual rendering issues on Windows/macOS.

#### Disable Frameless Window (`vscode_vibrancy.disableFramelessWindow`)

Disable frameless window, which is a mitigation that fixes a GPU-related render bug on Windows with VSCode 1.86 and newer. You may see distorted and blurry graphics if you disable this mitigation with an affected GPU. Running VSCode with a `--disable-gpu-compositing` argument, such as via a shortcut, will allow for this mitigation to be safely disabled.

#### Disable Theme Fixes (`vscode_vibrancy.disableThemeFixes`)

Disable fixes to Default Dark and Default Light themes for non-VSCode editors like Cursor.

#### Disable Color Customizations (`vscode_vibrancy.disableColorCustomizations`)

Prevent Vibrancy from modifying `workbench.colorCustomizations` which is used to make some elements like the terminal vibrant. Enable this if you want to manage color customizations yourself, or if you use a custom CSS theme that handles its own background colors and transparency. When enabled mid-session, any previously written vibrancy colors will be restored to their original values.

*boolean, default is false*

#### Refresh interval (`vscode_vibrancy.refreshInterval`)

Refresh interval (in milliseconds) for making the background transparent after window resizing. Lower values make the update less visible at the cost of increased CPU utilization. **Ignored when using "Prevent Flash" method.**

*value: 1 ~ 1000, default is 10*

#### Automatic theme switching (`vscode_vibrancy.enableAutoTheme`)

Enable automatic dark/light mode switching based on OS mode. Requires `window.autoDetectColorScheme` VSCode setting to also be enabled.

*boolean, default is false*

#### Preferred dark/light theme (`vscode_vibrancy.preferedDarkTheme / vscode_vibrancy.preferedLightTheme`)

Select which themes to use for light and dark modes, they will be used instead of the main Vibrancy Continued theme selected.

#### theme (`vscode_vibrancy.theme`)

Select Vibrancy theme:

* Default Dark
* Dark (Only Subbar)
* Default Light
* Light (Only Subbar)
* Noir et blanc
* Tokyo Night Storm
* Tokyo Night Storm (Outer)
* Catppuccin Mocha
* Solarized Dark+
* GitHub Dark Default

| Theme | Screenshot |
| ---- | ---- |
| Default Dark | ![](./images/theme-default.jpg) |
| Dark (Only Subbar) | ![](./images/theme-subbar.jpg) |
| Noir et blanc | ![](./images/theme-noir-et-blanc.jpg) |
| Tokyo Night Storm | ![](./images/theme-tokyo-night-storm.png) |
| Tokyo Night Storm (Only Subbar) | ![](./images/theme-tokyo-night-storm-outer.png) |
| Solarized Dark+ (with theme: [Solarized](https://marketplace.visualstudio.com/items?itemName=ryanolsonx.solarized)) | ![](./images/theme-solarized-dark%2B.png)
| Catppuccin Mocha | ![](./images/theme-catppuccin-mocha.png) |
| GitHub Dark Default | ![](./images/theme-github-dark-default.png) |
| [Paradise](https://marketplace.visualstudio.com/items?itemName=nickesc.vscode-paradise-nickesc) Smoked Glass | ![](./images/theme-paradise-smoked-glass.png) |
| [Paradise](https://marketplace.visualstudio.com/items?itemName=nickesc.vscode-paradise-nickesc) Frosted Glass | ![](./images/theme-paradise-frosted-glass.png) |

> You can contribute more themes! [see here](https://github.com/illixion/vscode-vibrancy-continued/tree/master/themes).

# FAQs

### How to uninstall Vibrancy?

Press F1 or ⌘+Shift+P and activate command **"Disable Vibrancy"**, then restart Visual Studio Code.

You can also just uninstall the extension and restart VSCode, which will automatically remove Vibrancy.

### Effect doesn't work correctly in VSCode terminal?

Check your settings. You should change the renderer type of the terminal to `dom`.

`"terminal.integrated.gpuAcceleration": "off"`

### `EROFS: read-only file system` when enabling Vibrancy on macOS?

Your installation of VSCode is affected by [App Translocation](https://developer.apple.com/forums/thread/724969).

To fix this, either use the Finder and move VSCode to `/Applications` (or move it out of `/Applications` and then back in), or run the following terminal command:

```shell
sudo xattr -dr com.apple.quarantine "/Applications/Visual Studio Code.app"
```

### I'm on Windows 10 and I'm experiencing lag when dragging the window

[Please read here for details](https://github.com/EYHN/vscode-vibrancy/discussions/80).

### VSCode window cannot be resized/moved/maximized after enabling Vibrancy

Please see [Important notice for Windows users](#️-important-notice-for-windows-1011-users) at the top of the description.

### Effect doesn't work, but there are no errors

Ensure that you don't have transparency effects disabled globally through your OS settings.

This can usually be found under Accessibility settings, and it may be called "Transparency effects" or "Reduce transparency." If that didn't help, you can also check the Console section in VSCode's Developer Tools, which can be accessed through the command palette.

If nothing else worked, try reinstalling VSCode, you won't lose any settings and this will ensure that your VSCode installation is consistent.

### Linux: Why is the background transparent but not blurred?

Currently, we do not support native blur effects on Linux. While transparency can work on its own, blur usually depends on additional support from the system compositor. To achieve a blur effect, use transparent mode together with a compositor such as KWin, Hyprland, or Picom.

# Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Vibrancy relies on user contributions, and as such, any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

**When creating a PR**, please target the `development` branch.

# License

Distributed under the MIT License. See `LICENSE.txt` for more information.

## Thanks ⭐

[EYHN](https://github.com/EYHN) : for making the original Vibrancy that this is a fork of

[be5invis/vscode-custom-css](https://github.com/be5invis/vscode-custom-css) : The basis of this extension program

[DIYgod](https://github.com/microsoft/vscode/issues/32257#issuecomment-509936623) : Fix issues with VSCode 1.36