README.md
ASCII text
Flat-Plat
Flat-Plat is a Material Design-like theme for GNOME/GTK+ based desktop environments. It supports GTK+ 3, GTK+ 2, Metacity, GNOME Shell, Unity, Budgie, MATE, LightDM, GDM, Chrome theme, etc.
Also Flat-Plat has compatibility with oomox.
Features
Supports ripple effect animations for GTK+ 3.
Supports both light and dark variants.
Supports dark or light titlebar versions.
Supports compact version for low resolution.
Requirements
GTK+
>=3.18gnome-themes-standardpixmap (or pixbuf) engine
murrine engine
Build dependency
glib2on Arch Linuxglib2-develon Fedora, openSUSE, etclibglib2.0-devon Debian, Ubuntu, etc
Supported desktop environments
GNOME Shell
>=3.18Unity
>=7.4Budgie
>=10.2.5MATE
>=1.14
Installation
For Arch Linux, the AUR package maintained by @cthbleachbit is available.
sudo yaourt -S flatplat-theme
For Fedora or EPEL, the Copr repository maintained by @LaurentTreguier is available.
sudo dnf copr enable tcg/themes sudo dnf install Flat-Plat-theme
Manual Installation
Run the following commands in the terminal.
cd /tmp && curl -sL https://github.com/nana-4/Flat-Plat/archive/v20170605.tar.gz | tar xz cd Flat-Plat-20170605 sudo ./install.sh
Manual Uninstallation
Delete the installed directories.
sudo rm -rf /usr/share/themes/Flat-Plat{,-compact,-dark,-dark-compact,-light,-light-compact}
Recommendations
Font
Use a font family including
Mediumweight (like Roboto or M+) to properly display the theme.Set the font size to
9.75(= 13px at 96dpi) or10.5(= 14px at 96dpi).
Chrome Theme
To use the Chrome theme, open the chrome folder on /usr/share/themes/Flat-Plat<-variant> and drag and drop the .crx files onto the Chrome/ChromiumExtensions page.
GDM Theme
You can change the GDM theme (a.k.a. lock/login screen) by replacing the default GNOME Shell theme. However, if it fails, the desktop environment may not operate correctly. So please be careful if doing this.
:warning: Cautions:
When applying this, other third-party GNOME Shell themes would look broken until you restore to the original theme.
If GNOME Shell has been updated, it will be restored to the original theme, so you will need to install this again.
Installation
Select a GTK+ theme to decide which variant to install.
Run the following commands to back up and replace the default theme file.
sh
GTK_THEME=$(gsettings get org.gnome.desktop.interface gtk-theme | sed "s/'//g")
sudo cp -v --backup /usr/share{/themes/$GTK_THEME,}/gnome-shell/gnome-shell-theme.gresource
> Note: If you don't want to overwrite the backup on the second and subsequent runs, delete the --backup option.
Uninstallation
Restore to the original theme from the backup.
sh
sudo mv -v /usr/share/gnome-shell/gnome-shell-theme.gresource{~,}
Preview
GNOME Shell
Budgie Desktop
GDM
Preview Details: Icons: Paper | Font: M+ 1C 9.75pt | Dock's icon size: 48px + fixed | Wallpapers
Contributing
If you find bugs or have suggestions, please report it to the issue tracker. Any contribution will be much appreciated.
Planned Features
Supports of Xfce theme (waiting for the upstream to complete
gtk3port)Supports of Firefox theme (in progress, waiting for the upstream to provide next-gen themes)
Supports of overlay scrollbars for Chrome/Chromium extension (low priority)
GNOME Terminal color pallet (if possible, _help wanted_)
Material Design like cursor theme (low priority)
License
Flat-Plat is distributed under the terms of the GNU General Public License, version 2 or later. See the COPYING file for details.
Credits
This theme is based on Adwaita by GNOME.
The included symbolic icons are based on Material Design icons by Google.
Chrome/Chromium scrollbars extension was forked from Adwaita-chrome-scrollbar by GNOME Integration Team.
The original concept is Google's Material Design.
Yauhen Kirylau (@actionless) who is oomox author polished scripts and supported Flat-Plat with oomox.
Also thank you for all contributors and upstream developers.
1
Flat-Plat
2
=========
3
Flat-Plat is a [Material Design](https://material.io)-like theme for GNOME/GTK+ based desktop environments.
4
It supports GTK+ 3, GTK+ 2, Metacity, GNOME Shell, Unity, Budgie, MATE, LightDM, GDM, Chrome theme, etc.
5
6
Also Flat-Plat has compatibility with [oomox](https://github.com/actionless/oomox).
7
8
Features
9
--------
10
<img src="../images/Button.gif" alt="Button" align="right"/>
11
12
- Supports ripple effect animations for GTK+ 3.
13
- Supports both light and dark variants.
14
- Supports dark or light titlebar versions.
15
- Supports compact version for low resolution.
16
17
Requirements
18
------------
19
- GTK+ `>=3.18`
20
- `gnome-themes-standard`
21
- pixmap (or pixbuf) engine
22
- murrine engine
23
24
#### Build dependency
25
- `glib2` on Arch Linux
26
- `glib2-devel` on Fedora, openSUSE, etc
27
- `libglib2.0-dev` on Debian, Ubuntu, etc
28
29
#### Supported desktop environments
30
- GNOME Shell `>=3.18`
31
- Unity `>=7.4`
32
- Budgie `>=10.2.5`
33
- MATE `>=1.14`
34
35
Installation
36
------------
37
For **Arch Linux**, the [AUR package](https://aur.archlinux.org/packages/flatplat-theme) maintained by @cthbleachbit is available.
38
39
```sh
40
sudo yaourt -S flatplat-theme
41
```
42
43
For **Fedora** or **EPEL**, the [Copr repository](https://copr.fedorainfracloud.org/coprs/tcg/themes/) maintained by @LaurentTreguier is available.
44
45
```sh
46
sudo dnf copr enable tcg/themes
47
sudo dnf install Flat-Plat-theme
48
```
49
50
#### Manual Installation
51
Run the following commands in the terminal.
52
53
```sh
54
cd /tmp && curl -sL https://github.com/nana-4/Flat-Plat/archive/v20170605.tar.gz | tar xz
55
cd Flat-Plat-20170605
56
sudo ./install.sh
57
```
58
59
#### Manual Uninstallation
60
Delete the installed directories.
61
62
```sh
63
sudo rm -rf /usr/share/themes/Flat-Plat{,-compact,-dark,-dark-compact,-light,-light-compact}
64
```
65
66
Recommendations
67
---------------
68
#### Font
69
- Use a font family including `Medium` weight (like [Roboto](https://github.com/google/roboto) or [M+](https://mplus-fonts.osdn.jp)) to properly display the theme.
70
- Set the font size to `9.75` (= 13px at 96dpi) or `10.5` (= 14px at 96dpi).
71
72
#### Chrome Theme
73
To use the Chrome theme, open the `chrome` folder on `/usr/share/themes/Flat-Plat<-variant>` and drag and drop the `.crx` files onto the Chrome/Chromium _Extensions_ page.
74
75
GDM Theme
76
---------
77
You can change the GDM theme (a.k.a. lock/login screen) by replacing the default GNOME Shell theme.
78
However, if it fails, the desktop environment may not operate correctly. So please **be careful** if doing this.
79
80
#### :warning: Cautions:
81
- When applying this, other third-party GNOME Shell themes would look broken until you restore to the original theme.
82
- If GNOME Shell has been updated, it will be restored to the original theme, so you will need to install this again.
83
84
### Installation
85
1. Select a **GTK+** theme to decide which variant to install.
86
2. Run the following commands to back up and replace the default theme file.
87
88
```sh
89
GTK_THEME=$(gsettings get org.gnome.desktop.interface gtk-theme | sed "s/'//g")
90
sudo cp -v --backup /usr/share{/themes/$GTK_THEME,}/gnome-shell/gnome-shell-theme.gresource
91
```
92
93
> **Note:** If you don't want to overwrite the backup on the second and subsequent runs, delete the `--backup` option.
94
95
3. Restart GNOME Shell. (If you are running _GNOME on Xorg_, press <kbd>Alt</kbd> + <kbd>F2</kbd> then type `r`.)
96
97
### Uninstallation
98
1. Restore to the original theme from the backup.
99
100
```sh
101
sudo mv -v /usr/share/gnome-shell/gnome-shell-theme.gresource{~,}
102
```
103
104
2. Restart GNOME Shell. (If you are running _GNOME on Xorg_, press <kbd>Alt</kbd> + <kbd>F2</kbd> then type `r`.)
105
106
Preview
107
-------
108
##### GNOME Shell
109

110
##### Budgie Desktop
111

112
##### GDM
113

114
<sub>**Preview Details:** Icons: [Paper](https://github.com/snwh/paper-icon-theme) | Font: [M+ 1C](https://mplus-fonts.osdn.jp) 9.75pt | Dock's icon size: 48px + fixed | [Wallpapers](http://imgur.com/a/v2Ovx)</sub>
115
116
Contributing
117
------------
118
If you find bugs or have suggestions, please report it to the [issue tracker](https://github.com/nana-4/Flat-Plat/issues).
119
Any contribution will be much appreciated.
120
121
Planned Features
122
----------------
123
- Supports of Xfce theme (waiting for the upstream to complete `gtk3` port)
124
- Supports of Firefox theme ([in progress](https://github.com/nana-4/Flat-Plat/issues/78), waiting for [the upstream to provide next-gen themes](https://blog.mozilla.org/addons/2017/02/24/improving-themes-in-firefox/))
125
- Supports of overlay scrollbars for Chrome/Chromium extension (low priority)
126
- GNOME Terminal color pallet (if possible, _help wanted_)
127
- Material Design like cursor theme (low priority)
128
129
License
130
-------
131
Flat-Plat is distributed under the terms of the GNU General Public License, version 2 or later. See the [`COPYING`](COPYING) file for details.
132
133
Credits
134
-------
135
- This theme is based on [Adwaita](HACKING.md#useful-links) by GNOME.
136
- The included symbolic icons are based on [Material Design icons](https://github.com/google/material-design-icons) by Google.
137
- Chrome/Chromium scrollbars extension was forked from [Adwaita-chrome-scrollbar](https://github.com/gnome-integration-team/chrome-gnome-scrollbar) by GNOME Integration Team.
138
- The original concept is Google's [Material Design](https://material.io).
139
- Yauhen Kirylau (@actionless) who is oomox author polished scripts and supported Flat-Plat with [oomox](https://github.com/actionless/oomox).
140
141
Also thank you for all contributors and upstream developers.
142