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, GNOME Shell, Budgie, MATE, Unity, 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 and light titlebar variants.
Supports compact variant for low resolution.
Requirements
GTK+
>=3.18gnome-themes-standardmurrine engine
Supported desktop environments
GNOME Shell
>=3.18Budgie
>=10.2.5MATE
>=1.14Unity
>=7.4
Build dependency
glib2on Arch Linuxglib2-develon Fedora, openSUSE, etclibglib2.0-devon Debian, Ubuntu, etc
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/v20170916.tar.gz | tar xz cd Flat-Plat-20170916 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
To properly display the theme, use a font family including
Mediumweight (like Roboto or M+).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 (lock/login screen) theme 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
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)
Contributing
If you find bugs or have suggestions, please report it to the issue tracker. Any contribution will be much appreciated.
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, GNOME Shell, Budgie, MATE, Unity, 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 and light titlebar variants.
15
- Supports compact variant for low resolution.
16
17
Requirements
18
------------
19
- GTK+ `>=3.18`
20
- `gnome-themes-standard`
21
- murrine engine
22
23
#### Supported desktop environments
24
- GNOME Shell `>=3.18`
25
- Budgie `>=10.2.5`
26
- MATE `>=1.14`
27
- Unity `>=7.4`
28
29
#### Build dependency
30
- `glib2` on Arch Linux
31
- `glib2-devel` on Fedora, openSUSE, etc
32
- `libglib2.0-dev` on Debian, Ubuntu, etc
33
34
Installation
35
------------
36
For **Arch Linux**, the [AUR package](https://aur.archlinux.org/packages/flatplat-theme) maintained by @cthbleachbit is available.
37
38
```sh
39
sudo yaourt -S flatplat-theme
40
```
41
42
For **Fedora** or **EPEL**, the [Copr repository](https://copr.fedorainfracloud.org/coprs/tcg/themes/) maintained by @LaurentTreguier is available.
43
44
```sh
45
sudo dnf copr enable tcg/themes
46
sudo dnf install Flat-Plat-theme
47
```
48
49
#### Manual Installation
50
Run the following commands in the terminal.
51
52
```sh
53
cd /tmp && curl -sL https://github.com/nana-4/Flat-Plat/archive/v20170916.tar.gz | tar xz
54
cd Flat-Plat-20170916
55
sudo ./install.sh
56
```
57
58
#### Manual Uninstallation
59
Delete the installed directories.
60
61
```sh
62
sudo rm -rf /usr/share/themes/Flat-Plat{,-compact,-dark,-dark-compact,-light,-light-compact}
63
```
64
65
Recommendations
66
---------------
67
#### Font
68
- To properly display the theme, use a font family including `Medium` weight (like [Roboto](https://github.com/google/roboto) or [M+](https://mplus-fonts.osdn.jp)).
69
- Set the font size to `9.75` (= 13px at 96dpi) or `10.5` (= 14px at 96dpi).
70
71
#### Chrome Theme
72
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.
73
74
GDM Theme
75
---------
76
You can change the GDM (lock/login screen) theme by replacing the default GNOME Shell theme.
77
However, if it fails, the desktop environment may not operate correctly. So please **be careful** if doing this.
78
79
#### :warning: Cautions:
80
- When applying this, other third-party GNOME Shell themes would look broken until you restore to the original theme.
81
- If GNOME Shell has been updated, it will be restored to the original theme, so you will need to install this again.
82
83
### Installation
84
1. Select a **GTK+** theme to decide which variant to install.
85
2. Run the following commands to back up and replace the default theme file.
86
87
```sh
88
GTK_THEME=$(gsettings get org.gnome.desktop.interface gtk-theme | sed "s/'//g")
89
sudo cp -v --backup /usr/share{/themes/$GTK_THEME,}/gnome-shell/gnome-shell-theme.gresource
90
```
91
92
> **Note:** If you don't want to overwrite the backup on the second and subsequent runs, delete the `--backup` option.
93
94
3. Restart GNOME Shell. (If you are running _GNOME on Xorg_, press <kbd>Alt</kbd> + <kbd>F2</kbd> then type `r`.)
95
96
### Uninstallation
97
1. Restore to the original theme from the backup.
98
99
```sh
100
sudo mv -v /usr/share/gnome-shell/gnome-shell-theme.gresource{~,}
101
```
102
103
2. Restart GNOME Shell. (If you are running _GNOME on Xorg_, press <kbd>Alt</kbd> + <kbd>F2</kbd> then type `r`.)
104
105
Preview
106
-------
107
##### GNOME Shell
108

109
##### Budgie Desktop
110

111
##### GDM
112

113
<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>
114
115
Planned Features
116
----------------
117
- Supports of Xfce theme (waiting for the upstream to complete `gtk3` port)
118
- 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/))
119
- Supports of overlay scrollbars for Chrome/Chromium extension (low priority)
120
- GNOME Terminal color pallet (if possible, _help wanted_)
121
- Material Design like cursor theme (low priority)
122
123
Contributing
124
------------
125
If you find bugs or have suggestions, please report it to the [issue tracker](https://github.com/nana-4/Flat-Plat/issues).
126
Any contribution will be much appreciated.
127
128
License
129
-------
130
Flat-Plat is distributed under the terms of the GNU General Public License, version 2 or later. See the [`COPYING`](COPYING) file for details.
131
132
Credits
133
-------
134
- This theme is based on [Adwaita](HACKING.md#useful-links) by GNOME.
135
- The included symbolic icons are based on [Material Design icons](https://github.com/google/material-design-icons) by Google.
136
- Chrome/Chromium scrollbars extension was forked from [Adwaita-chrome-scrollbar](https://github.com/gnome-integration-team/chrome-gnome-scrollbar) by GNOME Integration Team.
137
- The original concept is Google's [Material Design](https://material.io).
138
- Yauhen Kirylau (@actionless) who is oomox author polished scripts and supported Flat-Plat with [oomox](https://github.com/actionless/oomox).
139
140
Also thank you for all contributors and upstream developers.
141