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, Cinnamon, 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.5Cinnamon
>=3.xMATE
>=1.14Unity
>=7.4
Installation
Packages
| Distro | Maintainer | Install Command |
|:-|:-|:-|
| Arch Linux [[Official][Arch]] | @ArchangeGabriel | sudo pacman -S materia-gtk-theme |
| Debian 10 / sid [[Official][Debian]] Ubuntu 18.04+ | @isaagar | sudo apt install materia-gtk-theme |
| Ubuntu 16.04 / 17.10 [[PPA][PPA]] | @igor-dyatlov | sudo add-apt-repository ppa:dyatlov-igor/materia-theme sudo apt update sudo apt install materia-gtk-theme |
| Fedora [[Copr][Copr]] | @LaurentTreguier | sudo dnf copr enable tcg/themes sudo dnf install materia-theme |
[Arch]: https://www.archlinux.org/packages/community/any/materia-gtk-theme [Debian]: https://packages.debian.org/unstable/materia-gtk-theme [PPA]: https://launchpad.net/~dyatlov-igor/+archive/ubuntu/materia-theme [Copr]: https://copr.fedorainfracloud.org/coprs/tcg/themes
Flatpak
3 variants (Materia, Materia-dark, Materia-light) are available via Flathub:
flatpak remote-add --if-not-exists flathub https://dl.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-extra(orgnome-themes-standard)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.
bc— build dependency
Install It
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.
Manual 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
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.
@smurphos who made and provided the Cinnamon theme for Materia.
Also thank you to all contributors and upstream developers.
1
# Materia
2
3

4
5
Materia (formerly Flat-Plat) is a [Material Design](https://material.io) theme for GNOME/GTK+ based desktop environments.
6
It supports GTK+ 3, GTK+ 2, GNOME Shell, Budgie, Cinnamon, MATE, Unity, LightDM, GDM, Chrome theme, etc.
7
8
Also Materia has compatibility with [oomox theme designer](https://github.com/themix-project/oomox).
9
10
## Features
11
12
**Ripple effect** animations for GTK+ 3 are supported:
13
14

15
16
**3 color variants** and **2 size variants** are available:
17
18
| **Materia** | **standard** | **compact** |
19
|:-:|:-:|:-:|
20
| **standard** | ![Materia][1] | ![Materia-compact][2] |
21
| **dark** | ![Materia-dark][3] | ![Materia-dark-compact][4] |
22
| **light** | ![Materia-light][5] | ![Materia-light-compact][6] |
23
24
[1]: ../images/Materia.png?raw=true
25
[2]: ../images/Materia-compact.png?raw=true
26
[3]: ../images/Materia-dark.png?raw=true
27
[4]: ../images/Materia-dark-compact.png?raw=true
28
[5]: ../images/Materia-light.png?raw=true
29
[6]: ../images/Materia-light-compact.png?raw=true
30
31
Various **desktop environments** are supported:
32
33
- GNOME Shell `>=3.18`
34
- Budgie `>=10.2.5`
35
- Cinnamon `>=3.x`
36
- MATE `>=1.14`
37
- Unity `>=7.4`
38
39
## Installation
40
41
### Packages
42
43
| Distro | Maintainer | Install Command |
44
|:-|:-|:-|
45
| Arch Linux <sup>[[Official][Arch]]</sup> | @ArchangeGabriel | `sudo pacman -S materia-gtk-theme` |
46
| Debian 10 / sid <sup>[[Official][Debian]]</sup> <br> Ubuntu 18.04+ | @isaagar | `sudo apt install materia-gtk-theme` |
47
| Ubuntu 16.04 / 17.10 <sup>[[PPA][PPA]]</sup> | @igor-dyatlov | `sudo add-apt-repository ppa:dyatlov-igor/materia-theme` <br> `sudo apt update` <br> `sudo apt install materia-gtk-theme` |
48
| Fedora <sup>[[Copr][Copr]]</sup> | @LaurentTreguier | `sudo dnf copr enable tcg/themes` <br> `sudo dnf install materia-theme` |
49
50
[Arch]: https://www.archlinux.org/packages/community/any/materia-gtk-theme
51
[Debian]: https://packages.debian.org/unstable/materia-gtk-theme
52
[PPA]: https://launchpad.net/~dyatlov-igor/+archive/ubuntu/materia-theme
53
[Copr]: https://copr.fedorainfracloud.org/coprs/tcg/themes
54
55
#### Flatpak
56
57
3 variants (Materia, Materia-dark, Materia-light) are available via Flathub:
58
59
```
60
flatpak remote-add --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo
61
flatpak install flathub org.gtk.Gtk3theme.Materia
62
flatpak install flathub org.gtk.Gtk3theme.Materia-dark
63
flatpak install flathub org.gtk.Gtk3theme.Materia-light
64
```
65
66
### Manual Installation
67
68
#### Requirements
69
70
You need to have the following dependencies:
71
72
- GTK+ `>=3.18`
73
- `gnome-themes-extra` (or `gnome-themes-standard`)
74
- Murrine engine — The package name depends on the distro.
75
- `gtk-engine-murrine` on Arch Linux
76
- `gtk-murrine-engine` on Fedora
77
- `gtk2-engine-murrine` on openSUSE
78
- `gtk2-engines-murrine` on Debian, Ubuntu, etc.
79
- `bc` — build dependency
80
81
#### Install It
82
83
Run the following commands in the terminal:
84
85
```sh
86
cd /tmp && wget -qO - https://github.com/nana-4/materia-theme/archive/master.tar.gz | tar xz
87
cd materia-theme-master
88
sudo ./install.sh
89
```
90
91
Note: `./install.sh` allows the following options:
92
93
```
94
-d, --dest DIR Specify destination directory
95
-n, --name NAME Specify theme name
96
-c, --color VARIANTS... Specify color variant(s) [standard|dark|light]
97
-s, --size VARIANT Specify size variant [standard|compact]
98
```
99
100
Without any options, Materia will be installed with all variants into `/usr/share/themes`.
101
Try `./install.sh --help` for more information.
102
103
### Manual Uninstallation
104
105
Delete the installed directories:
106
107
```sh
108
sudo rm -rf /usr/share/themes/Materia{,-compact,-dark,-dark-compact,-light,-light-compact}
109
```
110
111
## Recommendations
112
113
#### Font
114
115
- 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)).
116
- Set the font size to `9.75` or `10.5` (i.e. 13px or 14px at 96dpi).
117
118
#### Chrome Theme
119
120
To use the Chrome theme;
121
122
1. Open the `chrome` folder on `/usr/share/themes/Materia<-variant>`.
123
2. Drag and drop the `.crx` files into the Chrome/Chromium Extensions page (`chrome://extensions`).
124
125
#### GDM Theme
126
127
You can change the GDM (lock/login screen) theme by replacing the default GNOME Shell theme.
128
See the wiki for details: https://github.com/nana-4/materia-theme/wiki/GDM-Theme
129
130
## Customization
131
132
Materia allows you to change the color scheme relatively easily. See [`HACKING.md`](HACKING.md#how-to-change-the-color-scheme) for details.
133
134
## Contributing
135
136
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.
137
138
ToDo list can be found here: [`TODO.md`](TODO.md)
139
140
## License
141
142
Materia is distributed under the terms of the GNU General Public License, version 2 or later. See the [`COPYING`](COPYING) file for details.
143
144
## Credits
145
146
- Materia is based on [Adwaita](HACKING.md#upstream-theme-sources) by GNOME.
147
- Design and specifications are based on Google's [Material Design](https://material.io).
148
- The included symbolic icons are based on [Material Design icons](https://github.com/google/material-design-icons) by Google.
149
- Chrome/Chromium scrollbars extension was forked from [Adwaita-chrome-scrollbar](https://github.com/gnome-integration-team/chrome-gnome-scrollbar) by GNOME Integration Team.
150
- Yauhen Kirylau (@actionless) who is oomox author polished scripts and supported Materia with [oomox](https://github.com/themix-project/oomox).
151
- @n3oxmind who helped improve the installation script.
152
- @smurphos who made and provided the Cinnamon theme for Materia.
153
154
Also thank you to all contributors and upstream developers.
155