exported SGML document, Unicode text, UTF-8 text
![](img src="../images/materia-logo.svg" alt="materia-logo" align="right" /){kind=link}
Materia
Materia is a Material Design theme for GNOME/GTK based desktop environments.
It supports GTK 2, GTK 3, GNOME Shell, Budgie, Cinnamon, MATE, Unity, Xfce, LightDM, GDM, Chrome theme, etc.
Previews
Features
Supports ripple animations for GTK 3:
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
Supported Desktop Environments
Budgie
>=10.4Cinnamon
>=3.xGNOME Shell
>=3.26MATE
>=1.14Unity
>=7.4Xfce
>=4.13
Unsupported
Downstream customized GNOME sessions
e.g. "Ubuntu" session, "Pop" session. To properly use Materia on GNOME Shell, please install
gnome-sessionand then switch to "GNOME" or "GNOME on Xorg" session from your display manager.elementary apps
Because they are based on their own stylesheet that conflicts with GTK standards.
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.
sassc— build-time dependency
Package Installation
Distro Packages
NOTE: Some of these distro packages could be outdated and incompatible with your desktop environment. You can check the latest version here.
Distro | Package Name | Annotation
- | - | ---
Arch Linux | materia-gtk-theme | Link
Debian 10 or later | materia-gtk-theme | Link
Fedora | materia-gtk-theme | Link
Solus | materia-gtk-theme | Link
Ubuntu 18.04 or later | materia-gtk-theme | Link
WARNING: Ubuntu disco (19.04) & eoan (19.10) packages are very outdated and incompatible with GNOME 3.32 or later! If you're using GNOME on Ubuntu 19.04 or 19.10, I highly recommend manual installation below.
Flatpak
All 6 variants 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{,-dark,-light}{,-compact}
Manual Installation
Clone the repository and move into the project directory in the terminal:
git clone --depth 1 https://github.com/nana-4/materia-theme cd materia-theme
Build and install it using Meson:
meson "build" sudo ninja -C "build" install
Alternatively, you can use ./install.sh script without using Meson:
sudo ./install.sh
Build Options for Meson
Option | Default Value | Description
- | - | ---
prefix | /usr | Installation prefix
colors | default,light,dark | Choose color variant(s)
sizes | default,compact | Choose size variant(s)
gnome_shell_version | n/a (auto) | Manually set gnome-shell version
Example of usage:
meson "build" -Dprefix="$HOME/.local" -Dcolors=default,dark -Dsizes=compact
Build Options for ./install.sh
Run ./install.sh --help for details.
Manual Uninstallation
Delete the installed directories:
sudo rm -rf /usr/share/themes/Materia{,-dark,-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.75(= 13px at 96dpi) or10.5(= 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 can be customized with GUI application, oomox theme designer.
Materia also allows you to change the color scheme relatively easily in other ways. 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
oomox theme designer by @themix-project
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.
Meson code/implementation in Materia was heavily influenced by @monday15's lounge-gtk-theme.
Also thank you to all contributors and upstream developers.
1
<img src="../images/materia-logo.svg" alt="materia-logo" align="right" />
2
# Materia
4
Materia is a [Material Design](https://material.io) theme for GNOME/GTK based desktop environments.
6
It supports GTK 2, GTK 3, GNOME Shell, Budgie, Cinnamon, MATE, Unity, Xfce, LightDM, GDM, Chrome theme, etc.
8
## Previews
10
12
13
## Features
15
Supports **ripple animations** for GTK 3:
17
19
**3 color variants** and **2 size variants** are available:
21
**Materia** | **standard** | **compact**
23
:-: | :-: | :-:
24
**standard** | ![Materia][1] | ![Materia-compact][2]
25
**dark** | ![Materia-dark][3] | ![Materia-dark-compact][4]
26
**light** | ![Materia-light][5] | ![Materia-light-compact][6]
27
[1]: ../images/Materia.png?raw=true
29
[2]: ../images/Materia-compact.png?raw=true
30
[3]: ../images/Materia-dark.png?raw=true
31
[4]: ../images/Materia-dark-compact.png?raw=true
32
[5]: ../images/Materia-light.png?raw=true
33
[6]: ../images/Materia-light-compact.png?raw=true
34
## Supported Desktop Environments
36
- Budgie `>=10.4`
38
- Cinnamon `>=3.x`
39
- GNOME Shell `>=3.26`
40
- MATE `>=1.14`
41
- Unity `>=7.4`
42
- Xfce `>=4.13`
43
## Unsupported
45
- Downstream customized GNOME sessions
47
> e.g. "Ubuntu" session, "Pop" session. To properly use Materia on GNOME Shell, please install `gnome-session` and then switch to "GNOME" or "GNOME on Xorg" session from your display manager.
48
- elementary apps
49
> Because they are based on [their own stylesheet](https://github.com/elementary/stylesheet) that conflicts with GTK standards.
50
## Requirements
52
- GTK `>=3.20`
54
- `gnome-themes-extra` (or `gnome-themes-standard`)
55
- Murrine engine — The package name depends on the distro.
56
- `gtk-engine-murrine` on Arch Linux
57
- `gtk-murrine-engine` on Fedora
58
- `gtk2-engine-murrine` on openSUSE
59
- `gtk2-engines-murrine` on Debian, Ubuntu, etc.
60
- `sassc` — build-time dependency
61
## Package Installation
63
### Distro Packages
65
> NOTE: Some of these distro packages could be outdated and incompatible with your desktop environment. You can check the latest version [here](https://github.com/nana-4/materia-theme/releases).
67
<!-- For contributors, please add your package alphabetically. -->
69
Distro | Package Name | Annotation
71
--- | --- | ---
72
Arch Linux | `materia-gtk-theme` | [Link](https://www.archlinux.org/packages/community/any/materia-gtk-theme/)
73
Debian 10 or later | `materia-gtk-theme` | [Link](https://packages.debian.org/materia-gtk-theme)
74
Fedora | `materia-gtk-theme` | [Link](https://src.fedoraproject.org/rpms/materia-gtk-theme)
75
Solus | `materia-gtk-theme` | [Link](https://dev.getsol.us/source/materia-gtk-theme/)
76
Ubuntu 18.04 or later | `materia-gtk-theme` | [Link](https://packages.ubuntu.com/materia-gtk-theme)
77
**WARNING:** Ubuntu **disco (19.04)** & **eoan (19.10)** packages are very outdated and incompatible with GNOME 3.32 or later! If you're using GNOME on Ubuntu 19.04 or 19.10, I highly recommend [manual installation](#manual-installation) below.
79
### Flatpak
81
All 6 variants are available via Flathub:
83
```
85
flatpak remote-add --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo
86
flatpak install flathub org.gtk.Gtk3theme.Materia{,-dark,-light}{,-compact}
87
```
88
## Manual Installation
90
1. Clone the repository and move into the project directory in the terminal:
92
```sh
94
git clone --depth 1 https://github.com/nana-4/materia-theme
95
cd materia-theme
96
```
97
2. Build and install it using Meson:
99
```sh
101
meson "build"
102
sudo ninja -C "build" install
103
```
104
Alternatively, you can use `./install.sh` script without using Meson:
106
```sh
108
sudo ./install.sh
109
```
110
#### Build Options for Meson
112
Option | Default Value | Description
114
--- | --- | ---
115
`prefix` | `/usr` | Installation prefix
116
`colors` | `default,light,dark` | Choose color variant(s)
117
`sizes` | `default,compact` | Choose size variant(s)
118
`gnome_shell_version` | n/a (auto) | Manually set gnome-shell version
119
Example of usage:
121
```sh
123
meson "build" -Dprefix="$HOME/.local" -Dcolors=default,dark -Dsizes=compact
124
```
125
#### Build Options for `./install.sh`
127
Run `./install.sh --help` for details.
129
## Manual Uninstallation
131
Delete the installed directories:
133
```sh
135
sudo rm -rf /usr/share/themes/Materia{,-dark,-light}{,-compact}
136
```
137
## Recommendations
139
### Font
141
- 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)).
143
- Set the font size to `9.75` (= 13px at 96dpi) or `10.5` (= 14px at 96dpi).
144
### Chrome Theme
146
To use the Chrome theme;
148
1. Open the `chrome` folder on `/usr/share/themes/Materia<-variant>`.
150
2. Drag and drop the `.crx` files into the Chrome/Chromium Extensions page (`chrome://extensions`).
151
### GDM Theme
153
You can change the GDM (lock/login screen) theme by replacing the default GNOME Shell theme.
155
See [`gnome-shell/README.md`](src/gnome-shell/README.md) for details.
156
## Customization
158
Materia can be customized with GUI application, [**oomox theme designer**](https://github.com/themix-project/oomox).
160
Materia also allows you to change the color scheme relatively easily in other ways. See [`HACKING.md`](HACKING.md#how-to-change-the-color-scheme) for details.
162
## Contributing
164
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.
166
Todo list can be found at [`TODO.md`](TODO.md).
168
## Related Projects
170
- [**Materia KDE**](https://github.com/PapirusDevelopmentTeam/materia-kde) by @PapirusDevelopmentTeam
172
- [**Materia VSCode Theme**](https://marketplace.visualstudio.com/items?itemName=m-thorsen.vscode-materia) by @m-thorsen
173
- [**Materia Kolorizer**](https://github.com/DarthWound/materia-kolorizer) by @DarthWound
174
- [**oomox theme designer**](https://github.com/themix-project/oomox) by @themix-project
175
## License
177
Materia is distributed under the terms of the GNU General Public License, version 2 or later. See the [`COPYING`](COPYING) file for details.
179
## Credits
181
- Materia is based on [Adwaita](HACKING.md#upstream-theme-sources) by GNOME.
183
- Design and specifications are based on Google's [Material Design](https://material.io).
184
- The included symbolic icons are based on [Material Design icons](https://github.com/google/material-design-icons) by Google.
185
- Chrome/Chromium scrollbars extension was forked from [Adwaita-chrome-scrollbar](https://github.com/gnome-integration-team/chrome-gnome-scrollbar) by GNOME Integration Team.
186
- Yauhen Kirylau (@actionless) who is oomox author polished scripts and supported Materia with [oomox](https://github.com/themix-project/oomox).
187
- @n3oxmind who helped improve the installation script.
188
- @smurphos who made and provided the Cinnamon theme for Materia.
189
- Meson code/implementation in Materia was heavily influenced by @monday15's [lounge-gtk-theme](https://github.com/monday15/lounge-gtk-theme).
190
Also thank you to all contributors and upstream developers.
192