WhiteSur-gtk-theme/README.md

382 lines
12 KiB
Markdown
Raw Normal View History

2021-04-08 02:09:27 +02:00
<h1 align="center"> WhiteSur GTK Theme </h1>
2021-06-16 13:57:29 +02:00
<p align="center"> <img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/macbook.png"/> </p>
2020-07-14 18:35:03 +02:00
2021-04-08 02:09:27 +02:00
<br>
2021-04-08 02:53:50 +02:00
<p align="center"> <b> A macOS BigSur-like theme for your GTK apps </b> </p>
2021-04-08 02:09:27 +02:00
<br>
2020-07-14 18:35:03 +02:00
2021-04-08 02:09:27 +02:00
# Installation is easy!
<details> <summary> Required dependencies info for nerds </summary>
2020-07-14 18:35:03 +02:00
2021-06-08 16:03:41 +02:00
### "Install from source" deps
2021-04-10 09:35:40 +02:00
- sassc
2021-04-10 09:26:38 +02:00
- libglib2.0-dev-bin `ubuntu 20.04`
- libglib2.0-dev `ubuntu 18.04` `debian 10.03` `linux mint 19`
- libxml2-utils `ubuntu 18.04` `debian 10.03` `linux mint 19`
- glib2-devel `Fedora` `Redhat`
2020-07-14 18:35:03 +02:00
### Misc deps
- imagemagick `(optional for GDM theme tweak)`
2021-04-10 09:35:40 +02:00
- dialog `(optional for installation in dialog mode)`
- optipng `(optional for asset rendering)`
- inkscape `(optional for asset rendering)`
2021-04-08 02:09:27 +02:00
Don't worry, WhiteSur installer already provides all of those dependencies.
</details>
2020-07-14 18:35:03 +02:00
<details> <summary> Recommended GNOME Shell extensions </summary>
2021-04-29 05:50:55 +02:00
- [dash-to-dock](https://extensions.gnome.org/extension/307/dash-to-dock) `gnome-shell <= 3.38`
- [dash-to-dock](https://github.com/ewlsh/dash-to-dock/tree/ewlsh/gnome-40)
(GNOME Shell 40 patch) `gnome-shell >= 40.0`
- [floating-dock](https://extensions.gnome.org/extension/3730/floating-dock)
(Dash to Dock alternative) `gnome-shell <= 3.38`
2021-04-29 05:50:55 +02:00
- [blur-my-shell](https://extensions.gnome.org/extension/3193/blur-my-shell)
</details>
2021-04-08 02:09:27 +02:00
## Quick install
2021-04-10 09:09:46 +02:00
2021-06-07 13:31:45 +02:00
### Installing from source
Run `./install.sh` to install the default WhiteSur GTK theme pack which includes
2021-04-08 02:09:27 +02:00
GNOME Shell (Pantheon), Cinnamon, XFWM (XFCE), Metacity, and Plank themes.
2021-01-16 05:53:17 +01:00
2021-04-08 02:09:27 +02:00
## There's so many customizations you can do!
Usage: `./install.sh [OPTIONS...]`
2020-12-26 10:50:59 +01:00
<details> <summary> Options </summary>
2021-05-09 08:25:44 +02:00
```bash
2021-07-19 16:24:56 +02:00
-d, --dest DIR
Set destination directory. Default is '/home/vince/.themes'
2021-05-09 08:25:44 +02:00
2021-07-19 16:24:56 +02:00
-n, --name NAME
Set theme name. Default is 'WhiteSur'
2021-05-09 08:25:44 +02:00
2021-07-19 16:24:56 +02:00
-o, --opacity [normal|solid]
Set theme opacity variants. Repeatable. Default is all variants
2021-05-09 08:25:44 +02:00
2021-07-19 16:24:56 +02:00
-c, --color [light|dark]
Set theme color variants. Repeatable. Default is all variants
2021-05-09 08:25:44 +02:00
2021-07-19 16:24:56 +02:00
-a, --alt [normal|alt|all]
Set window control buttons variant. Repeatable. Default is 'normal'
2021-05-09 08:25:44 +02:00
2021-07-19 16:24:56 +02:00
-t, --theme [default|blue|purple|pink|red|orange|yellow|green|grey|all]
Set theme accent color. Repeatable. Default is BigSur-like theme
2021-05-09 08:25:44 +02:00
2021-08-21 05:41:37 +02:00
-p, --panel-opacity [default|30|45|60|75]
2021-07-19 16:24:56 +02:00
Set panel transparency. Default is 15%
2021-05-09 08:25:44 +02:00
2021-08-21 05:41:37 +02:00
-P, --panel-size [default|smaller|bigger]
Set Gnome shell panel height size. Default is 32px
2021-07-19 16:24:56 +02:00
-s, --size [default|180|220|240|260|280]
Set Nautilus sidebar minimum width. Default is 200px
2021-05-09 08:25:44 +02:00
2021-08-06 17:11:51 +02:00
-i, --icon [standard|simple|gnome|ubuntu|arch|manjaro|fedora|debian|void|opensuse|popos|mxlinux|zorin]
2021-07-19 16:24:56 +02:00
Set 'Activities' icon. Default is 'standard'
2021-05-09 08:25:44 +02:00
2021-07-19 16:24:56 +02:00
-b, --background [default|blank|IMAGE_PATH]
Set gnome-shell background image. Default is BigSur-like wallpaper
2021-05-09 08:25:44 +02:00
2021-07-19 16:24:56 +02:00
-m, --monterey
Set to MacOS Monterey style.
2021-05-09 08:25:44 +02:00
2021-07-19 16:24:56 +02:00
-N, --nautilus-style [stable|normal|mojave|glassy]
Set Nautilus style. Default is BigSur-like style (stabled sidebar)
2021-05-09 08:25:44 +02:00
2021-07-19 16:24:56 +02:00
-HD, --highdefinition
Set to High Definition size. Default is laptop size
2021-05-09 08:25:44 +02:00
2021-07-19 16:24:56 +02:00
--normal, --normalshowapps
Set gnome-shell show apps button style to normal. Default is bigsur
2021-05-09 08:25:44 +02:00
2021-07-19 16:24:56 +02:00
--round, --roundedmaxwindow
Set maximized window to rounded. Default is square
2021-05-09 08:25:44 +02:00
2021-07-19 16:24:56 +02:00
--right, --rightplacement
Set Nautilus titlebutton placement to right. Default is left
2021-05-09 08:25:44 +02:00
2021-07-19 16:24:56 +02:00
--black, --blackfont
Set panel font color to black. Default is white
--dialog, --interactive
Run this installer interactively, with dialogs.
--silent-mode
Meant for developers: ignore any confirm prompt and params become more strict.
-r, --remove, -u, --uninstall
Remove all installed WhiteSur themes.
-h, --help
Show this help.
2021-05-09 08:25:44 +02:00
```
</details>
2021-04-08 02:53:50 +02:00
### <p align="center"> <b> Change theme color and accent </b> </p>
2021-06-16 13:57:29 +02:00
<p align="center"> <img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/colors-themes.png"/> </p>
2020-07-31 11:33:11 +02:00
2021-04-08 02:09:27 +02:00
#### Install theme color
Parameter: `--color` `-c` (repeatable)
2020-12-26 10:50:59 +01:00
2021-04-08 02:09:27 +02:00
Example:
2020-12-26 10:50:59 +01:00
2020-12-26 16:56:11 +01:00
```bash
2021-04-08 02:09:27 +02:00
./install.sh -c light # install light theme color only
./install.sh -c dark -c light # install dark and light theme colors
2020-12-26 16:56:11 +01:00
```
2020-12-07 07:44:28 +01:00
2021-04-08 02:09:27 +02:00
#### Install theme accent
Parameter: `--theme` `-t` (repeatable)
Example:
2020-12-07 07:44:28 +01:00
2021-01-23 09:12:24 +01:00
```bash
2021-04-08 02:09:27 +02:00
./install.sh -t red # install red theme accent only
./install.sh -t red -t green # install red and green theme accents
./install.sh -t all # install all available theme accents
2021-01-23 09:12:24 +01:00
```
2021-04-08 02:53:50 +02:00
### <p align="center"> <b> Change Nautilus sidebar minimum width </b> </p>
2021-06-16 13:57:29 +02:00
<p align="center"> <img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/sidebars.png"/> </p>
2021-01-16 05:45:10 +01:00
2021-04-08 02:09:27 +02:00
Parameter: `--sidebar` `-s`
2021-01-16 05:45:10 +01:00
2021-04-08 02:09:27 +02:00
Example: `./install.sh -s 220`
2021-04-08 02:53:50 +02:00
### <p align="center"> <b> Change GNOME Shell 'Activities' icon </b> </p>
2021-06-16 13:57:29 +02:00
<p align="center"> <img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/icons.png"/> </p>
2021-04-08 02:09:27 +02:00
Parameter: `--icon` `-i`
Example: `./install.sh -i fedora`
2021-04-08 02:53:50 +02:00
### <p align="center"> <b> Change Nautilus style </b> </p>
2021-06-16 13:57:29 +02:00
<p align="center"> <img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/nautilus.png"/> </p>
2021-04-08 02:09:27 +02:00
Parameter: `--nautilus-style` `-N`
Example: `./install.sh -N mojave`
2021-04-08 02:53:50 +02:00
### <p align="center"> <b> Explore more customization features! </b> </p>
2021-04-08 02:09:27 +02:00
You can run `./install.sh -h` to explore more customization features we have
like changing panel opacity, theme opacity (normal and solid variant), window
control button variant, etc.
# Let's tweak!
Usage: `./tweaks.sh [OPTIONS...]`
<details> <summary> Options </summary>
2021-05-24 07:18:19 +02:00
```bash
2021-07-19 16:24:56 +02:00
-f, --firefox [default|monterey]
Install 'WhiteSur|Monterey' theme for Firefox and connect it to the current Firefox profiles. Default is WhiteSur
2021-05-24 07:18:19 +02:00
-e, --edit-firefox
2021-07-19 16:24:56 +02:00
Edit 'WhiteSur' theme for Firefox settings and also connect the theme to the current Firefox profiles.
2021-05-24 07:18:19 +02:00
-F, --flatpak
2021-07-19 16:24:56 +02:00
Connect 'WhiteSur' theme to Flatpak.
2021-05-24 07:18:19 +02:00
-s, --snap
2021-07-19 16:24:56 +02:00
Connect 'WhiteSur' theme the currently installed snap apps.
2021-05-24 07:18:19 +02:00
-g, --gdm
2021-07-19 16:24:56 +02:00
Install 'WhiteSur' theme for GDM. Requires to run this shell as root
2021-05-24 07:18:19 +02:00
-d, --dash-to-dock
2021-07-19 16:24:56 +02:00
Install 'WhiteSur' theme for Dash to Dock and connect it to the current Dash to Dock installation(s).
2021-05-24 07:18:19 +02:00
-N, --no-darken
2021-07-19 16:24:56 +02:00
Don't darken 'WhiteSur' GDM theme background image.
2021-05-24 07:18:19 +02:00
-n, --no-blur
2021-07-19 16:24:56 +02:00
Don't blur 'WhiteSur' GDM theme background image.
2021-05-24 07:18:19 +02:00
-b, --background [default|blank|IMAGE_PATH]
2021-07-19 16:24:56 +02:00
Set 'WhiteSur' GDM theme background image. Default is BigSur-like wallpaper
2021-05-24 07:18:19 +02:00
-o, --opacity [normal|solid]
2021-07-19 16:24:56 +02:00
Set 'WhiteSur' GDM theme opacity variants. Default is 'normal'
2021-05-24 07:18:19 +02:00
-c, --color [light|dark]
2021-07-19 16:24:56 +02:00
Set 'WhiteSur' GDM and Dash to Dock theme color variants. Default is 'light'
2021-05-24 07:18:19 +02:00
-t, --theme [default|blue|purple|pink|red|orange|yellow|green|grey]
2021-07-19 16:24:56 +02:00
Set 'WhiteSur' GDM theme accent color. Default is BigSur-like theme
2021-05-24 07:18:19 +02:00
2021-08-21 05:41:37 +02:00
-p, --panel-opacity [default|30|45|60|75]
2021-07-19 16:24:56 +02:00
Set 'WhiteSur' GDM (GNOME Shell) theme panel transparency. Default is 15%
2021-05-24 07:18:19 +02:00
2021-08-21 05:41:37 +02:00
-P, --panel-size [default|smaller|bigger]
Set 'WhiteSur' Gnome shell panel height size. Default is 32px
-i, --icon [standard|simple|gnome|ubuntu|arch|manjaro|fedora|debian|void|opensuse|popos|mxlinux|zorin]
2021-07-19 16:24:56 +02:00
Set 'WhiteSur' GDM (GNOME Shell) 'Activities' icon. Default is 'standard'
2021-05-24 07:18:19 +02:00
-r, --remove, --revert
2021-07-19 16:24:56 +02:00
Revert to the original themes, do the opposite things of install and connect.
--silent-mode
Meant for developers: ignore any confirm prompt and params become more strict.
2021-05-24 07:18:19 +02:00
-h, --help
2021-07-19 16:24:56 +02:00
Show this help.
2021-05-24 07:18:19 +02:00
```
2021-05-24 07:20:26 +02:00
</details>
2021-04-08 02:09:27 +02:00
## There's more themes you can try!
2021-04-08 02:53:50 +02:00
### <p align="center"> <b> Install and edit Firefox theme </b> </p>
2021-06-23 06:50:40 +02:00
<p align="center"> <a href="src/other/firefox">
2021-06-25 07:23:01 +02:00
<img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/firefox-whitesur.png"/>
2021-06-23 06:50:40 +02:00
</a> </p>
2021-04-08 02:09:27 +02:00
#### Install Firefox theme
Parameter: `--firefox` `-f`
Example: `./tweaks.sh -f`
#### Edit Firefox theme
Parameter: `--edit-firefox` `-e`
Example:
2020-12-26 16:56:11 +01:00
```bash
2021-04-08 02:09:27 +02:00
./tweaks.sh -f -e # install and edit Firefox theme
./tweaks.sh -e -f # it's reversible!
./tweaks.sh -e # edit the installed Firefox theme
```
2021-04-08 02:09:27 +02:00
2021-07-04 17:20:05 +02:00
#### Use Monterey style
<p align="center"> <a href="src/other/firefox">
<img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/firefox-monterey.png"/>
</a> </p>
Run:
```bash
./tweaks.sh -f monterey # install Monterey Firefox theme
```
2021-04-08 02:53:50 +02:00
### <p align="center"> <b> Install and customize Dash to Dock theme </b> </p>
2021-06-16 13:57:29 +02:00
<p align="center"> <img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/dash-to-dock.png"/> </p>
2021-04-08 02:09:27 +02:00
#### Install Dash to Dock theme
Parameter: `--dash-to-dock` `-d`
Example: `./tweaks.sh -d`
#### Change its color
Parameter: `--color` `-c`
Example: `./tweaks.sh -d -c dark`
2021-04-08 02:53:50 +02:00
### <p align="center"> <b> Install and customize GDM theme </b> </p>
2021-06-16 13:57:29 +02:00
<p align="center"> <img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/gdm.png"/> </p>
2021-04-08 02:09:27 +02:00
#### Install GDM theme
Parameter: `--gdm` `-g` (requires to be run as root)
2021-04-08 02:09:27 +02:00
Example: `sudo ./tweaks.sh -g`
#### Change the background
Parameter: `--background` `-b`
2021-04-10 09:23:57 +02:00
Example:
2021-04-08 02:09:27 +02:00
2020-12-26 16:56:11 +01:00
```bash
2021-04-08 02:09:27 +02:00
sudo ./tweaks.sh -g -b "my picture.jpg" # use the custom background
sudo ./tweaks.sh -g -b default # use the default background
sudo ./tweaks.sh -g -b blank # make it blank
```
2021-04-08 02:09:27 +02:00
#### Don't darken the background
Parameter: `--no-darken` `-N`
2021-04-08 02:09:27 +02:00
2021-04-10 09:23:57 +02:00
Example:
2021-04-08 02:09:27 +02:00
2020-12-26 16:56:11 +01:00
```bash
2021-05-24 07:18:19 +02:00
sudo ./tweaks.sh -g -N # darken the default background
sudo ./tweaks.sh -g -N -b "wallpapers/snow.jpg" # darken the custom background
```
2021-04-08 02:09:27 +02:00
#### Don't blur the background
Parameter: `--no-blur` `-n`
2021-04-10 09:23:57 +02:00
Example:
2021-04-08 02:09:27 +02:00
2020-12-26 16:56:11 +01:00
```bash
2021-04-08 02:09:27 +02:00
sudo ./tweaks.sh -g -n # don't blur the default background
sudo ./tweaks.sh -g -n -b "wallpapers/rocks.jpg" # don't blur the custom background
```
2021-04-08 02:09:27 +02:00
#### Do more GDM customizations
2021-04-08 05:33:30 +02:00
You can do [the similar customization features in `./install.sh`](#theres-so-many-customizations-you-can-do)
like changing theme color (dark and light variant) and accent, GNOME Shell
'Activities' icon, etc. related to GDM. Run `./tweaks.sh -h` to explore!
2021-04-08 02:09:27 +02:00
## Using WhiteSur theme on app sandboxing platforms
2021-06-16 13:57:29 +02:00
<p align="center"> <img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/sandboxes.png"/> </p>
2021-04-08 02:09:27 +02:00
2021-04-08 02:53:50 +02:00
### <p align="center"> <b> Connect WhiteSur theme to Flatpak </b> </p>
2021-04-08 02:09:27 +02:00
Parameter: `--flatpak` `-F`
Example: `./tweaks.sh -F`
2021-04-08 02:53:50 +02:00
### <p align="center"> <b> Connect WhiteSur theme to your Snap apps </b> </p>
Parameter: `--snap` `-s`
2021-04-08 02:09:27 +02:00
Example: `./tweaks.sh -s`
2021-04-08 02:09:27 +02:00
Note:
> This can only connect WhiteSur theme to your currently installed Snap
> apps. You may need to run this command again to connect to your newly installed
> Snap apps
# Other recommended stuffs
2021-06-23 07:18:04 +02:00
## WhiteSur KDE Theme
2021-04-08 02:09:27 +02:00
<p align="center"> <a href="https://github.com/vinceliuice/WhiteSur-kde">
2021-06-16 13:57:29 +02:00
<img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/whitesur-kde-theme.png"/>
2021-04-08 02:53:50 +02:00
</a> </p>
2021-04-08 03:35:56 +02:00
<br>
2021-04-08 02:53:50 +02:00
<p align="center"> <a href="https://github.com/vinceliuice/WhiteSur-kde">
2021-06-25 07:12:26 +02:00
<img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/download-button.svg"/>
2021-04-08 02:09:27 +02:00
</a> </p>
2021-04-08 03:35:56 +02:00
<br>
2021-04-08 02:09:27 +02:00
2021-06-23 07:18:04 +02:00
## WhiteSur Icon Theme
2021-04-08 02:09:27 +02:00
<p align="center"> <a href="https://github.com/vinceliuice/WhiteSur-icon-theme">
2021-06-16 13:57:29 +02:00
<img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/whitesur-icon-theme.png"/>
2021-04-08 02:53:50 +02:00
</a> </p>
2021-04-08 03:35:56 +02:00
<br>
2021-04-08 02:53:50 +02:00
<p align="center"> <a href="https://github.com/vinceliuice/WhiteSur-icon-theme">
2021-06-25 07:12:26 +02:00
<img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/download-button.svg"/>
2021-04-08 02:09:27 +02:00
</a> </p>
2021-04-08 03:35:56 +02:00
<br>
2021-04-08 02:09:27 +02:00
2021-06-23 07:18:04 +02:00
## WhiteSur Wallpaper
2021-07-02 17:26:23 +02:00
<p align="center"> <a href="https://github.com/vinceliuice/WhiteSur-gtk-theme/tree/wallpapers">
2021-07-02 17:23:35 +02:00
<img class="image" src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/wallpapers/1080p/WhiteSur-light.png"/>
2021-06-23 07:31:13 +02:00
</a> </p>
<br>
2021-07-02 17:26:23 +02:00
<p align="center"> <a href="https://github.com/vinceliuice/WhiteSur-gtk-theme/tree/wallpapers">
2021-07-02 17:23:35 +02:00
<img class="image" src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/wallpapers/1080p/Monterey-light.png"/>
2021-06-23 04:38:41 +02:00
</a> </p>
<br>
2021-07-02 17:26:23 +02:00
<p align="center"> <a href="https://github.com/vinceliuice/WhiteSur-gtk-theme/tree/wallpapers">
2021-06-25 07:12:26 +02:00
<img src="https://github.com/vinceliuice/WhiteSur-gtk-theme/blob/pictures/pictures/download-button.svg"/>
2021-04-08 02:09:27 +02:00
</a> </p>
2021-06-23 07:35:16 +02:00
<br>
2021-04-08 02:53:50 +02:00
2021-04-08 02:09:27 +02:00
# Technical details and getting involved
2021-06-09 16:15:05 +02:00
Please go read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for more info