README.md
Unicode text, UTF-8 text
Materia
Materia (formerly Flat-Plat) is a Material Design 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:
3 color variants and 2 size variants are available:
| Materia | standard | compact | |:-:|:-:|:-:| | standard | ![Materia][1] | ![Materia-compact][2] | | dark | ![Materia-dark][3] | ![Materia-dark-compact][4] | | light | ![Materia-light][5] | ![Materia-light-compact][6] |
[1]: ../images/Materia.png?raw=true [2]: ../images/Materia-compact.png?raw=true [3]: ../images/Materia-dark.png?raw=true [4]: ../images/Materia-dark-compact.png?raw=true [5]: ../images/Materia-light.png?raw=true [6]: ../images/Materia-light-compact.png?raw=true
Various desktop environments are supported:
GNOME Shell
>=3.18Budgie
>=10.2.5MATE
>=1.14Unity
>=7.4... and more DEs are planned.
Installation
Arch Linux
Package is available via AUR (maintained by @cthbleachbit):
yaourt -S materia-theme
Fedora / EPEL
Package is available via Copr (maintained by @LaurentTreguier):
sudo dnf copr enable tcg/themes sudo dnf install materia-theme
Ubuntu
Package is available via PPA (maintained by @igor-dyatlov):
sudo add-apt-repository ppa:dyatlov-igor/materia-theme sudo apt update sudo apt install materia-theme
Debian sid
Official package (maintained by @isaagar) is available:
sudo apt install materia-gtk-theme
Flatpak
3 variants (Materia, Materia-dark, Materia-light) are available via Flathub:
flatpak remote-add flathub https://flathub.org/repo/flathub.flatpakrepo flatpak install flathub org.gtk.Gtk3theme.Materia flatpak install flathub org.gtk.Gtk3theme.Materia-dark flatpak install flathub org.gtk.Gtk3theme.Materia-light
Manual Installation
Requirements
You need to have the following dependencies:
GTK+
>=3.18gnome-themes-standardorgnome-themes-extra— The package name depends on the distro.Murrine 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.
For Ubuntu, you also need the libxml2-utils package.
Installation
Run the following commands in the terminal:
cd /tmp && wget -qO - https://github.com/nana-4/materia-theme/archive/master.tar.gz | tar xz cd materia-theme-master sudo ./install.sh
Note: ./install.sh allows the following options:
-d, --dest DIR Specify destination directory -n, --name NAME Specify theme name -c, --color VARIANTS... Specify color variant(s) [standard|dark|light] -s, --size VARIANT Specify size variant [standard|compact]
Without any options, Materia will be installed with all variants into /usr/share/themes.
Try ./install.sh --help for more information.
Uninstallation
Delete the installed directories:
sudo rm -rf /usr/share/themes/Materia{,-compact,-dark,-dark-compact,-light,-light-compact}
Recommendations
Font
To properly display the theme, use a font family including Medium weight (e.g. Roboto or M+).
Set the font size to
9.75or10.5(i.e. 13px or 14px at 96dpi).
Chrome Theme
To use the Chrome theme;
Open the
chromefolder on/usr/share/themes/Materia<-variant>.Drag and drop the
.crxfiles into the Chrome/Chromium Extensions page (chrome://extensions).
GDM Theme
You can change the GDM (lock/login screen) theme by replacing the default GNOME Shell theme. See the wiki for details: https://github.com/nana-4/materia-theme/wiki/GDM-Theme
Previews
GNOME Shell
Budgie Desktop
GDM
Previews Info: Icon Theme: Paper | Font: M+ 1C 9.75pt | Dock's icon size: 48px + fixed | Wallpapers
Customization
Materia allows you to change the color scheme relatively easily. See HACKING.md for details.
Contributing
If you find bugs or have suggestions, please report it to the issue tracker. Any contribution would be much appreciated.
ToDo list can be found here: TODO.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
Materia is based on Adwaita by GNOME.
Design and specifications are based on Google's Material Design.
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.
Yauhen Kirylau (@actionless) who is oomox author polished scripts and supported Materia with oomox.
@n3oxmind who helped improve the installation script.
Also thank you to all contributors and upstream developers.
1
# Materia
2
3
Materia (formerly Flat-Plat) is a [Material Design](https://material.io) 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
**3 color variants** and **2 size variants** are available:
15
16
| **Materia** | **standard** | **compact** |
17
|:-:|:-:|:-:|
18
| **standard** | ![Materia][1] | ![Materia-compact][2] |
19
| **dark** | ![Materia-dark][3] | ![Materia-dark-compact][4] |
20
| **light** | ![Materia-light][5] | ![Materia-light-compact][6] |
21
22
[1]: ../images/Materia.png?raw=true
23
[2]: ../images/Materia-compact.png?raw=true
24
[3]: ../images/Materia-dark.png?raw=true
25
[4]: ../images/Materia-dark-compact.png?raw=true
26
[5]: ../images/Materia-light.png?raw=true
27
[6]: ../images/Materia-light-compact.png?raw=true
28
29
Various **desktop environments** are supported:
30
31
- GNOME Shell `>=3.18`
32
- Budgie `>=10.2.5`
33
- MATE `>=1.14`
34
- Unity `>=7.4`
35
- ... and more DEs are [planned](TODO.md#supports).
36
37
## Installation
38
39
#### Arch Linux
40
41
Package is available via [AUR](https://aur.archlinux.org/packages/materia-theme/) (maintained by @cthbleachbit):
42
43
```
44
yaourt -S materia-theme
45
```
46
47
#### Fedora / EPEL
48
49
Package is available via [Copr](https://copr.fedorainfracloud.org/coprs/tcg/themes/) (maintained by @LaurentTreguier):
50
51
```
52
sudo dnf copr enable tcg/themes
53
sudo dnf install materia-theme
54
```
55
56
#### Ubuntu
57
58
Package is available via [PPA](https://launchpad.net/~dyatlov-igor/+archive/ubuntu/materia-theme) (maintained by @igor-dyatlov):
59
60
```
61
sudo add-apt-repository ppa:dyatlov-igor/materia-theme
62
sudo apt update
63
sudo apt install materia-theme
64
```
65
66
#### Debian sid
67
68
[Official package](https://packages.debian.org/unstable/materia-gtk-theme) (maintained by @isaagar) is available:
69
70
```
71
sudo apt install materia-gtk-theme
72
```
73
74
#### Flatpak
75
76
3 variants (Materia, Materia-dark, Materia-light) are available via Flathub:
77
78
```
79
flatpak remote-add flathub https://flathub.org/repo/flathub.flatpakrepo
80
flatpak install flathub org.gtk.Gtk3theme.Materia
81
flatpak install flathub org.gtk.Gtk3theme.Materia-dark
82
flatpak install flathub org.gtk.Gtk3theme.Materia-light
83
```
84
85
### Manual Installation
86
87
#### Requirements
88
89
You need to have the following dependencies:
90
91
- GTK+ `>=3.18`
92
- `gnome-themes-standard` or `gnome-themes-extra` — The package name depends on the distro.
93
- Murrine engine — The package name depends on the distro.
94
- `gtk-engine-murrine` on Arch Linux
95
- `gtk-murrine-engine` on Fedora
96
- `gtk2-engine-murrine` on openSUSE
97
- `gtk2-engines-murrine` on Debian, Ubuntu, etc.
98
- `glib-compile-resources` — The package name depends on the distro.
99
- `glib2` on Arch Linux
100
- `glib2-devel` on Fedora, openSUSE, etc.
101
- `libglib2.0-dev` on Debian, Ubuntu, etc.
102
103
For Ubuntu, you also need the `libxml2-utils` package.
104
105
#### Installation
106
107
Run the following commands in the terminal:
108
109
```sh
110
cd /tmp && wget -qO - https://github.com/nana-4/materia-theme/archive/master.tar.gz | tar xz
111
cd materia-theme-master
112
sudo ./install.sh
113
```
114
115
**Note:** `./install.sh` allows the following options:
116
117
```
118
-d, --dest DIR Specify destination directory
119
-n, --name NAME Specify theme name
120
-c, --color VARIANTS... Specify color variant(s) [standard|dark|light]
121
-s, --size VARIANT Specify size variant [standard|compact]
122
```
123
124
Without any options, **Materia** will be installed with **all variants** into `/usr/share/themes`.
125
Try `./install.sh --help` for more information.
126
127
#### Uninstallation
128
129
Delete the installed directories:
130
131
```sh
132
sudo rm -rf /usr/share/themes/Materia{,-compact,-dark,-dark-compact,-light,-light-compact}
133
```
134
135
## Recommendations
136
137
#### Font
138
139
- To properly display the theme, use a font family including **Medium** weight (e.g. [Roboto](https://github.com/google/roboto) or [M+](https://mplus-fonts.osdn.jp)).
140
- Set the font size to `9.75` or `10.5` (i.e. 13px or 14px at 96dpi).
141
142
#### Chrome Theme
143
144
To use the Chrome theme;
145
146
1. Open the `chrome` folder on `/usr/share/themes/Materia<-variant>`.
147
2. Drag and drop the `.crx` files into the Chrome/Chromium Extensions page (`chrome://extensions`).
148
149
#### GDM Theme
150
151
You can change the GDM (lock/login screen) theme by replacing the default GNOME Shell theme.
152
See the wiki for details: https://github.com/nana-4/materia-theme/wiki/GDM-Theme
153
154
## Previews
155
156
##### GNOME Shell
157

158
159
##### Budgie Desktop
160

161
162
##### GDM
163

164
165
<sub>**Previews Info:** Icon Theme: [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>
166
167
## Customization
168
169
Materia allows you to change the color scheme relatively easily. See [`HACKING.md`](HACKING.md#changing-the-color-scheme-with-script) for details.
170
171
## Contributing
172
173
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.
174
175
ToDo list can be found here: [`TODO.md`](TODO.md)
176
177
## License
178
179
Materia is distributed under the terms of the GNU General Public License, version 2 or later. See the [`COPYING`](COPYING) file for details.
180
181
## Credits
182
183
- Materia is based on [Adwaita](HACKING.md#upstream-theme-sources) by GNOME.
184
- Design and specifications are based on Google's [Material Design](https://material.io).
185
- The included symbolic icons are based on [Material Design icons](https://github.com/google/material-design-icons) by Google.
186
- Chrome/Chromium scrollbars extension was forked from [Adwaita-chrome-scrollbar](https://github.com/gnome-integration-team/chrome-gnome-scrollbar) by GNOME Integration Team.
187
- Yauhen Kirylau (@actionless) who is oomox author polished scripts and supported Materia with [oomox](https://github.com/actionless/oomox).
188
- @n3oxmind who helped improve the installation script.
189
190
Also thank you to all contributors and upstream developers.
191