Marble-shell-theme/README.md

# Marble shell theme
Shell theme for GNOME DE. Based on https://www.pling.com/p/1939902/.

![Available colors:](https://shields.io/badge/-Available%20colors:-0d1117?style=flat-square)
![red](https://shields.io/badge/-red-red?style=flat-square)
![yellow](https://shields.io/badge/-yellow-yellow?style=flat-square)
![green](https://shields.io/badge/-green-green?style=flat-square)
![blue](https://shields.io/badge/-blue-blue?style=flat-square)
![purple](https://shields.io/badge/-purple-purple?style=flat-square)
![or different Hue color.](https://shields.io/badge/-or%20different%20Hue%20color.-0d1117?style=flat-square)

## 🏞 Screenshots

<details><summary>Click me 🐈</summary>

Icon theme: https://github.com/vinceliuice/Colloid-icon-theme

#### Overview [[Blur My Shell](https://extensions.gnome.org/extension/3193/blur-my-shell/) / Light / Dark] ([Neon Gas Station](https://www.heroscreen.cc/2025/03/neon-gas-station-4k-wallpaper.html) - AI Generated)
![Overview with Blur My Shell](./readme-images/overview_blur-my-shell.png?raw=true "Overview with Blur My Shell")
![Overview in light mode](./readme-images/overview_light.png?raw=true "Overview in light mode")
![Overview in dark mode](./readme-images/overview_dark.png?raw=true "Overview in dark mode")

#### Panel
![Panel look](./readme-images/panel.png?raw=true "Panel look")
#### Quick settings ([Fresh green leaves with fragile veins](https://www.pexels.com/photo/fresh-green-leaves-with-fragile-veins-6423448/) / [Close-Up Photo of Wrinkled Parchment Paper](https://www.pexels.com/photo/close-up-photo-of-wrinkled-parchment-paper-7233131/))
![Quick settings look](./readme-images/qs.png?raw=true "Quick settings look")

#### Modal dialog ([Wide Angle Photography of Mountain](https://www.pexels.com/photo/wide-angle-photography-of-mountain-1612559/))
![Modal dialog look](./readme-images/modal.png?raw=true "Modal dialog look")
#### Calendar & notifications
![Calendar & notifications look](./readme-images/datemenu.png?raw=true)

#### Dash ([Dash To Dock](https://extensions.gnome.org/extension/307/dash-to-dock/ "Dash To Dock"))
- Position and size:
  - Icon size: 42px.
- Appearance:
  - Shrink the dash.
  - Default opacity.

![Dash look](./readme-images/dash.png?raw=true "Dash look")

</details>

## 🚧 Requirements
- GNOME 42-48. Correct functionality on other versions is not guaranteed.
- [User Themes](https://extensions.gnome.org/extension/19/user-themes/ "User Themes") extension.
- Python 3.10 or higher.

## 💡 Installation

> [!IMPORTANT]  
> If you have another theme installed globally (changed the appearance of the login window (GDM)), please remove it before installing this theme.

1. Open the terminal.
2. Clone the git repository and change the directory:
   ```shell
   git clone https://github.com/imarkoff/Marble-shell-theme.git
   cd Marble-shell-theme
   ```
3. Run the program (install all accent colors, light and dark mode): 
   ```shell
   python install.py -a
   ```
   - [more vibrant color](./readme-images/qs.png?raw=true) in active buttons:
      ```shell
      python install.py -a --filled
      ``` 
4. After successful file creation open Extensions app, go to `User Themes - ··· - Settings`.
![User Themes in Extensions](./readme-images/user-themes-settings.png)
5. Select the shell theme you want.

> [!TIP]
> For updating the theme, run the `git pull` command in the `Marble-shell-theme` directory and run the program again. 
> If Marble theme is used, updates will be applied automatically.

> [!TIP]
> If you want to install only one color, use the `--red`, `--yellow`, `--green`, `--blue`, `--purple`, `--gray` option.

See the [installation tweaks](#-installation-tweaks) section for more information.

If you want to remove the theme, see the [uninstallation](#%EF%B8%8F-uninstallation--reinstallation) section.

## 🖥️ GDM theme

![GDM theme](./readme-images/gdm.png)
> **Image:** [Network Abstract](https://4kwallpapers.com/abstract/network-abstract-background-blue-background-5k-8k-8270.html).
> 
> **Config:** `sudo python install.py --gdm --blue --filled --gdm-image /path/to/image.jpg --gdm-blur=40 --gdm-darken=30`

> [!WARNING]  
> I am not responsible for any damage caused by the installation of the theme. If you have any problems, please open an issue.

### 🚧 Additional requirements
- `glib2-devel` (`libglib2.0-dev` on Debian-based distros).
- `imagemagick` (if you want to apply filters to the background image).

1. Open the terminal.
2. Go to the directory with the theme.
3. Run the program with the `--gdm` option
   ```shell
   sudo python install.py --gdm (--your color) (--is filled)
   ```
    - Example:
        ```shell
        sudo python install.py --gdm --blue --filled
        ```
        ```shell
        sudo python install.py --gdm --gray --gdm-image /path/to/image.jpg --gdm-blur=40 --gdm-darken=30
        ```
4. After successful file restart GDM service:
   ```shell
   sudo systemctl restart gdm
   ```

- 🗑️ If you want to remove the theme or theme is broken, run the program with the `--remove` option:
    ```shell
    sudo python install.py --gdm -r
    ```
- ☠️ If you got a death screen, you can switch to the console with the `Ctrl + Alt + F3` key combination, log in, go to the `Marble-shell-theme` directory and run the command above. If it doesn't help, try reinstalling `gnome-shell` package.


## 🏮 Installation tweaks

> [!TIP]
> Wanna use accent color from your favorite wallpaper? Use [Chromaflow](https://github.com/Felixdiamond/chromaflow).

#### Install default color

| Option    | Description                  |
|-----------|------------------------------|
| -a, --all | Install all available colors |
| --red     | red theme only               |
| --yellow  | yellow theme only            |
| --green   | green theme only             |
| --blue    | blue theme only              |
| --purple  | purple theme only            |
| --gray    | gray theme only              |

> [!TIP]
> You can install several themes in one string: `python install.py --red --green --blue`

> [!TIP]
> If you don't like these colors, you can change them in the `colors.json` file (after the `elements`).

#### Install custom color
| Option | Secondary option | Description                              |
|--------|------------------|------------------------------------------|
| --hue  | (0 - 360)        | Generate theme from Hue prompt [0 - 360] |
| --name | NAME             | Custom theme name                        |

#### Theme colors
| Option       | Description                                                       |
|--------------|-------------------------------------------------------------------|
| --filled     | Make accent color [more vibrant](./readme-images/qs.png?raw=true) |
| -O, --opaque | Make background color opaque (by default is translucent)          | 

#### Optional theme tweaks
| Option | Secondary option | Description                                                |
|--------|------------------|------------------------------------------------------------|
| --mode | light / dark     | light / dark theme only                                    |
| --sat  | (0 - 250)        | custom color saturation (<100% - reduce, >100% - increase) |

#### GDM tweaks

| Option        | Secondary option         | Description                 |
|---------------|--------------------------|-----------------------------|
| --gdm-image   | /absolute/path/to/image/ | set background image to GDM |
| --gdm-blur    | 0+                       | apply blur to image (px)    |
| --gdm-darken  | 0 - 100                  | darken image (%)            |
| --gdm-lighten | 0 - 100                  | lighten image (%)           |

#### Panel tweaks

**Panel default size**

![Panel default size](./readme-images/tweaks/panel-default-size.png "Panel default size")

**Panel without button background**

![Panel without buttons background](./readme-images/tweaks/panel-no-pill.png "Panel without buttons background")

| Option                     | Secondary option | Description                    |
|----------------------------|------------------|--------------------------------|
| -Pds, --panel-default-size |                  | set default panel size         |
| -Pnp, --panel-no-pill      |                  | remove panel button background |
| -Ptc, --panel-text-color   | #abcdef          | custom panel HEX(A) text color |
| --wider-panel              |                  | make the panel a bit wider     |

#### Overview tweaks

**Launchpad icon**

![Dash with launchpad icon](./readme-images/tweaks/dash-with-launchpad.png "Dash with launchpad icon")

| Command     | Description                                   |
|-------------|-----------------------------------------------|
| --launchpad | Change Show Apps icon to macOS Launchpad icon |

#### Examples
| Command                                                   | Description                                                              |
|-----------------------------------------------------------|--------------------------------------------------------------------------|
| -a                                                        | Install all accent colors with light & dark mode                         |
| --all --mode dark                                         | Install all accent colors with dark mode only                            |
| --purple --mode=light                                     | Install purple accent color with light mode only                         |
| --hue 150 --name coldgreen                                | Install custom coldgreen accent color, light & dark mode                 |
| --red --green --sat=70                                    | red, green accent colors, 70% of the stock saturation                    |
| --hue=200 --name=grayblue --sat=50 --mode=dark            | custom grayblue accent color, 50% of the stock saturation, dark mode     |
| --gdm --blue --gdm-image /path/to/image.jpg --gdm-blur=40 | Install GDM theming in blue color with own GDM background image and blur |


## 🗑️ Uninstallation / Reinstallation

- To remove the theme, run the program with the `--remove` option:
    ```shell
    python install.py -ra
    ```
- To reinstall the theme, run the program with the `--reinstall` option:
    ```shell
    python install.py -ri -a  # (other installation options)
    ```
  
> [!TIP]
> If you want to remove the GDM theme, use the `--gdm` option with the `--remove` option.


The program allows you to specify the color of the theme and the mode to remove.
For example, to remove purple and green themes in light mode, use the command:
```shell
python install.py -r --purple --green --mode light
```

Also, you can use the command above to reinstall purple and green themes in light mode with the `--reinstall` option.
```shell
python install.py -ri --purple --green --mode light
```

#### Options

| Option           | Description           |
|------------------|-----------------------|
| -r, --remove     | Remove the theme      |
| -ri, --reinstall | Reinstall the theme   |