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 can be customized 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
Requirements
GTK+
>=3.20gnome-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
Installation
Distro Packages
Distro | Package Name / Link
- | -
Arch Linux | materia-gtk-theme
Debian testing / unstable Ubuntu 18.04+ | materia-gtk-theme
Ubuntu 16.04 / 17.10 | materia-gtk-theme from @igor-dyatlov's PPA
Fedora | materia-theme from @LaurentTreguier's Copr
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
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
Tip: ./install.sh allows the following options:
Option | Description
- | -
-d, --destDIR_ | Specify theme destination directory. (Default: /usr/share/themes)
-n, --nameNAME_ | Specify theme name. (Default: Materia)
-c, --color _VARIANT... | Specify theme color variant(s). (Default: All [standard\|dark\|light] variants)
-s, --size _VARIANT | Specify theme size variant. (Default: All [standard\|compact] variants)
-g, --gdm | Install and apply GDM theme.
-h, --help | Show help.
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 gnome-shell/README.md for details.
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 at TODO.md.
Related Projects
Materia KDE by @PapirusDevelopmentTeam
Materia VSCode Theme by @m-thorsen
Materia Kolorizer by @DarthWound
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 can be customized 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
## Requirements
40
41
- GTK+ `>=3.20`
42
- `gnome-themes-extra` (or `gnome-themes-standard`)
43
- Murrine engine — The package name depends on the distro.
44
- `gtk-engine-murrine` on Arch Linux
45
- `gtk-murrine-engine` on Fedora
46
- `gtk2-engine-murrine` on openSUSE
47
- `gtk2-engines-murrine` on Debian, Ubuntu, etc.
48
- `bc` — build dependency
49
50
## Installation
51
52
### Distro Packages
53
54
Distro | Package Name / Link
55
--- | ---
56
Arch Linux | [`materia-gtk-theme`](https://www.archlinux.org/packages/community/any/materia-gtk-theme)
57
Debian testing / unstable <br> Ubuntu 18.04+ | [`materia-gtk-theme`](https://packages.debian.org/unstable/materia-gtk-theme)
58
Ubuntu 16.04 / 17.10 | `materia-gtk-theme` from [@igor-dyatlov's PPA](https://launchpad.net/~dyatlov-igor/+archive/ubuntu/materia-theme)
59
Fedora | `materia-theme` from [@LaurentTreguier's Copr](https://copr.fedorainfracloud.org/coprs/tcg/themes)
60
61
### Flatpak
62
63
3 variants (Materia, Materia-dark, Materia-light) are available via Flathub:
64
65
```
66
flatpak remote-add --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo
67
flatpak install flathub org.gtk.Gtk3theme.Materia
68
flatpak install flathub org.gtk.Gtk3theme.Materia-dark
69
flatpak install flathub org.gtk.Gtk3theme.Materia-light
70
```
71
72
### Manual Installation
73
74
Run the following commands in the terminal:
75
76
```sh
77
cd /tmp && wget -qO - https://github.com/nana-4/materia-theme/archive/master.tar.gz | tar xz
78
cd materia-theme-master
79
sudo ./install.sh
80
```
81
82
Tip: `./install.sh` allows the following options:
83
84
Option | Description
85
--- | ---
86
`-d`, `--dest` _DIR_ | Specify theme destination directory. (Default: `/usr/share/themes`)
87
`-n`, `--name` _NAME_ | Specify theme name. (Default: `Materia`)
88
`-c`, `--color` _VARIANT..._ | Specify theme color variant(s). (Default: All [`standard`\|`dark`\|`light`] variants)
89
`-s`, `--size` _VARIANT_ | Specify theme size variant. (Default: All [`standard`\|`compact`] variants)
90
`-g`, `--gdm` | Install and apply GDM theme.
91
`-h`, `--help` | Show help.
92
93
### Manual Uninstallation
94
95
Delete the installed directories:
96
97
```sh
98
sudo rm -rf /usr/share/themes/Materia{,-compact,-dark,-dark-compact,-light,-light-compact}
99
```
100
101
## Recommendations
102
103
### Font
104
105
- 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)).
106
- Set the font size to `9.75` or `10.5` (i.e. 13px or 14px at 96dpi).
107
108
### Chrome Theme
109
110
To use the Chrome theme;
111
112
1. Open the `chrome` folder on `/usr/share/themes/Materia<-variant>`.
113
2. Drag and drop the `.crx` files into the Chrome/Chromium Extensions page (`chrome://extensions`).
114
115
### GDM Theme
116
117
You can change the GDM (lock/login screen) theme by replacing the default GNOME Shell theme.
118
See [`gnome-shell/README.md`](src/gnome-shell/README.md) for details.
119
120
## Customization
121
122
Materia allows you to change the color scheme relatively easily. See [`HACKING.md`](HACKING.md#how-to-change-the-color-scheme) for details.
123
124
## Contributing
125
126
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.
127
128
Todo list can be found at [`TODO.md`](TODO.md).
129
130
## Related Projects
131
132
- [**Materia KDE**](https://github.com/PapirusDevelopmentTeam/materia-kde) by @PapirusDevelopmentTeam
133
- [**Materia VSCode Theme**](https://marketplace.visualstudio.com/items?itemName=m-thorsen.vscode-material-mt) by @m-thorsen
134
- [**Materia Kolorizer**](https://github.com/DarthWound/materia-kolorizer) by @DarthWound
135
136
## License
137
138
Materia is distributed under the terms of the GNU General Public License, version 2 or later. See the [`COPYING`](COPYING) file for details.
139
140
## Credits
141
142
- Materia is based on [Adwaita](HACKING.md#upstream-theme-sources) by GNOME.
143
- Design and specifications are based on Google's [Material Design](https://material.io).
144
- The included symbolic icons are based on [Material Design icons](https://github.com/google/material-design-icons) by Google.
145
- Chrome/Chromium scrollbars extension was forked from [Adwaita-chrome-scrollbar](https://github.com/gnome-integration-team/chrome-gnome-scrollbar) by GNOME Integration Team.
146
- Yauhen Kirylau (@actionless) who is oomox author polished scripts and supported Materia with [oomox](https://github.com/themix-project/oomox).
147
- @n3oxmind who helped improve the installation script.
148
- @smurphos who made and provided the Cinnamon theme for Materia.
149
150
Also thank you to all contributors and upstream developers.
151