README.md
ASCII text
Materia
Materia (formerly named 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 Materia has compatibility with oomox theme designer.
Features
Ripple effect animations for GTK+ 3 are supported.
Three color variants and two size variants are available.
| Materia | - | compact |
|:-:|:-:|:-:|
| - |
|
|
| dark |
|
|
| light |
|
|
Various desktop environments are supported.
GNOME Shell
>=3.18Budgie
>=10.2.5MATE
>=1.14Unity
>=7.4... and more DEs are planned.
Installation
Packages
|| Install command |
|:-|:-|
| Arch Linux [1] | sudo yaourt -S flatplat-theme |
| Fedora / EPEL [2] | sudo dnf copr enable tcg/themes && sudo dnf install Flat-Plat-theme |
The AUR package is maintained by @cthbleachbit.
The Copr repository is maintained by @LaurentTreguier.
Manual Installation
Check the dependencies first.
GTK+
>=3.18gnome-themes-standardMurrine engine - The package name depends on the distro.
gtk-engine-murrineon Arch Linuxgtk-murrine-engineon Fedoragtk2-engine-murrineon openSUSEgtk2-engines-murrineon Debian, Ubuntu, etc.
glib-compile-resources- The package name depends on the distro.glib2on Arch Linuxglib2-develon Fedora, openSUSE, etc.libglib2.0-devon Debian, Ubuntu, etc.
Install the theme with the following commands.
cd /tmp && curl -sL https://github.com/nana-4/materia-theme/archive/v20170917.tar.gz | tar xz cd materia-theme-20170917 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 (such as 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
chromefolder on/usr/share/themes/Flat-Plat<-variant>.Drag and drop the
.crxfiles onto the Chrome/ChromiumExtensions page:chrome://extensions
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{~,}
Previews
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 would be much appreciated.
See also (if necessary): TODO.md and HACKING.md
License
Materia 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 Materia with oomox.
Also thank you to all contributors and upstream developers.
1
Materia
2
=======
3
Materia (formerly named 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 Materia has compatibility with [oomox theme designer](https://github.com/actionless/oomox).
7
8
Features
9
--------
10
**Ripple effect** animations for GTK+ 3 are supported.
11
12

13
14
**Three color variants** and **two size variants** are available.
15
16
| **Materia** | **-** | **compact** |
17
|:-:|:-:|:-:|
18
| **-** |  |  |
19
| **dark** |  |  |
20
| **light** |  |  |
21
22
Various **desktop environments** are supported.
23
24
- GNOME Shell `>=3.18`
25
- Budgie `>=10.2.5`
26
- MATE `>=1.14`
27
- Unity `>=7.4`
28
- ... and more DEs are [planned](TODO.md#supports).
29
30
Installation
31
------------
32
#### Packages
33
34
|| **Install command** |
35
|:-|:-|
36
| **Arch Linux** [1] | `sudo yaourt -S flatplat-theme` |
37
| **Fedora / EPEL** [2] | `sudo dnf copr enable tcg/themes && sudo dnf install Flat-Plat-theme` |
38
39
1. The [AUR package](https://aur.archlinux.org/packages/flatplat-theme/) is maintained by [@cthbleachbit](https://github.com/cthbleachbit).
40
2. The [Copr repository](https://copr.fedorainfracloud.org/coprs/tcg/themes/) is maintained by [@LaurentTreguier](https://github.com/LaurentTreguier).
41
42
#### Manual Installation
43
44
Check the dependencies first.
45
46
- GTK+ `>=3.18`
47
- `gnome-themes-standard`
48
- Murrine engine - The package name depends on the distro.
49
- `gtk-engine-murrine` on Arch Linux
50
- `gtk-murrine-engine` on Fedora
51
- `gtk2-engine-murrine` on openSUSE
52
- `gtk2-engines-murrine` on Debian, Ubuntu, etc.
53
- `glib-compile-resources` - The package name depends on the distro.
54
- `glib2` on Arch Linux
55
- `glib2-devel` on Fedora, openSUSE, etc.
56
- `libglib2.0-dev` on Debian, Ubuntu, etc.
57
58
Install the theme with the following commands.
59
60
```sh
61
cd /tmp && curl -sL https://github.com/nana-4/materia-theme/archive/v20170917.tar.gz | tar xz
62
cd materia-theme-20170917
63
sudo ./install.sh
64
```
65
66
#### Manual Uninstallation
67
68
Delete the installed directories.
69
70
```sh
71
sudo rm -rf /usr/share/themes/Flat-Plat{,-compact,-dark,-dark-compact,-light,-light-compact}
72
```
73
74
Recommendations
75
---------------
76
#### Font
77
- To properly display the theme, use a font family including `Medium` weight (such as [Roboto](https://github.com/google/roboto) or [M+](https://mplus-fonts.osdn.jp)).
78
- Set the font size to `9.75` (= 13px at 96dpi) or `10.5` (= 14px at 96dpi).
79
80
#### Chrome Theme
81
To use the Chrome theme,
82
1. Open the `chrome` folder on `/usr/share/themes/Flat-Plat<-variant>`.
83
2. Drag and drop the `.crx` files onto the Chrome/Chromium _Extensions_ page: `chrome://extensions`
84
85
GDM Theme
86
---------
87
You can change the GDM (lock/login screen) theme by replacing the default GNOME Shell theme.
88
However, if it fails, the desktop environment may not operate correctly. So please **be careful** if doing this.
89
90
#### :warning: Cautions:
91
- When applying this, other third-party GNOME Shell themes would look broken until you restore to the original theme.
92
- If GNOME Shell has been updated, it will be restored to the original theme, so you will need to install this again.
93
94
### Installation
95
1. Select a **GTK+** theme to decide which variant to install.
96
2. Run the following commands to back up and replace the default theme file.
97
98
```sh
99
GTK_THEME=$(gsettings get org.gnome.desktop.interface gtk-theme | sed "s/'//g")
100
sudo cp -v --backup /usr/share{/themes/$GTK_THEME,}/gnome-shell/gnome-shell-theme.gresource
101
```
102
103
> **Note:** If you don't want to overwrite the backup on the second and subsequent runs, delete the `--backup` option.
104
105
3. Restart GNOME Shell. (If you are running _GNOME on Xorg_, press <kbd>Alt</kbd> + <kbd>F2</kbd> then type `r`.)
106
107
### Uninstallation
108
1. Restore to the original theme from the backup.
109
110
```sh
111
sudo mv -v /usr/share/gnome-shell/gnome-shell-theme.gresource{~,}
112
```
113
114
2. Restart GNOME Shell. (If you are running _GNOME on Xorg_, press <kbd>Alt</kbd> + <kbd>F2</kbd> then type `r`.)
115
116
Previews
117
--------
118
##### GNOME Shell
119

120
##### Budgie Desktop
121

122
##### GDM
123

124
<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](https://imgur.com/a/v2Ovx)</sub>
125
126
Contributing
127
------------
128
If you find bugs or have suggestions, please report it to the [issue tracker](https://github.com/nana-4/materia-theme/issues). Any contribution would be much appreciated.
129
130
See also (if necessary): [`TODO.md`](TODO.md) and [`HACKING.md`](HACKING.md)
131
132
License
133
-------
134
Materia is distributed under the terms of the GNU General Public License, version 2 or later. See the [`COPYING`](COPYING) file for details.
135
136
Credits
137
-------
138
- This theme is based on [Adwaita](HACKING.md#upstream-theme-sources) by GNOME.
139
- The included symbolic icons are based on [Material Design icons](https://github.com/google/material-design-icons) by Google.
140
- Chrome/Chromium scrollbars extension was forked from [Adwaita-chrome-scrollbar](https://github.com/gnome-integration-team/chrome-gnome-scrollbar) by GNOME Integration Team.
141
- The original concept is Google's [Material Design](https://material.io).
142
- Yauhen Kirylau (@actionless) who is oomox author polished scripts and supported Materia with [oomox](https://github.com/actionless/oomox).
143
144
Also thank you to all contributors and upstream developers.
145