marble-shell-theme-packaging/README.md

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

## Screenshots

![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)
![pink](https://shields.io/badge/-pink-pink?style=flat-square)
![or different Hue color.](https://shields.io/badge/-or%20different%20Hue%20color.-0d1117?style=flat-square)

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

#### Overview (Pasta [white](https://addons.opera.com/en/wallpapers/details/pasta-white/) / [night](https://addons.opera.com/en/wallpapers/details/pasta-night/))
![Overview look](./readme-images/overview.png?raw=true "Overview look")
#### 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/))
![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 "Modal dialog look")
#### Calendar & notifications ([Wallpaper](https://www.zedge.net/wallpaper/7e10d448-6440-405d-a847-30b6146eeb55))
![Calendar & notifications look](./readme-images/notifications.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")

## Requirements
- GNOME 43, 44. I don't guarantee correct functionality on other versions.
- [User Themes](https://extensions.gnome.org/extension/19/user-themes/ "User Themes") extension.
- [GNOME Tweaks](https://gitlab.gnome.org/GNOME/gnome-tweaks "GNOME Tweaks").
- Python 3.2+.

## Installation
1. Open the terminal.
2. Clone git and change directory:
```shell
git clone https://github.com/imarkoff/Marble-shell-theme.git && cd Marble-shell-theme
```
3. Run the program: 
```shell
python install.py -h
```
4. Follow instructions inside the program.
5. After successful file creation open GNOME Tweaks, go to `Appearance - Themes - Shell`.
6. Select shell theme you want.

## Installation tweaks

#### Install default color
You can install several themes in one string: `python install.py --red --green --blue`

| Option    | Description                                            |
|-----------|--------------------------------------------------------|
| -A, --all | Install all available accent colors, light & dark mode |
| --red     | red theme only                                         |
| --pink    | pink theme only                                        |
| --purple  | purple theme only                                      |
| --blue    | blue theme only                                        |
| --green   | green theme only                                       |
| --yellow  | yellow theme only                                      |
| --gray    | gray theme only                                        |

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

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

#### Panel tweaks
![Panel default size](./readme-images/tweaks/panel-default-size.png "Panel default size")
![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 |

#### 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 |