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.
bc— build dependency
Installation
Distro Packages
Distro | Package Name | Annotation
- | - | ---
Arch Linux | materia-gtk-theme | Link
Debian 10 or later | materia-gtk-theme | Link
Fedora | materia-gtk-theme | Available from @LaurentTreguier's Copr
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 are using GNOME on Ubuntu, you shouldmanually install the theme.
Note: Some distro packages (especially Ubuntu ones) may be outdated and incompatible with your desktop environment. You can check the latest version here.
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
Run the following commands in the terminal:
git clone --depth 1 https://github.com/nana-4/materia-theme cd materia-theme sudo ./install.sh
Tip:
./install.shallows the following options:
-d, --dest DIR Specify destination directory (Default: /usr/share/themes)
-n, --name NAME Specify theme name (Default: Materia)
-c, --color VARIANT... Specify color variant(s) [standard|dark|light] (Default: All variants)
-s, --size VARIANT Specify size variant [standard|compact] (Default: All variants)
-g, --gdm Install and apply GDM theme (for advanced users)
See also: src/gnome-shell/README.md
-h, --help Show help
For more information, run:
./install.sh --help
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.
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
- `bc` — build dependency
61
## Installation
63
### Distro Packages
65
Distro | Package Name | Annotation
67
--- | --- | ---
68
Arch Linux | `materia-gtk-theme` | [Link](https://www.archlinux.org/packages/community/any/materia-gtk-theme/)
69
Debian 10 or later | `materia-gtk-theme` | [Link](https://packages.debian.org/materia-gtk-theme)
70
Fedora | `materia-gtk-theme` | Available from [@LaurentTreguier's Copr](https://copr.fedorainfracloud.org/coprs/tcg/themes)
71
Solus | `materia-gtk-theme` | [Link](https://dev.getsol.us/source/materia-gtk-theme/)
72
Ubuntu 18.04 or later | `materia-gtk-theme` | [Link](https://packages.ubuntu.com/materia-gtk-theme)
73
<!-- For contributors, please add your package alphabetically! -->
75
**Warning:** **Ubuntu disco (19.04) & eoan (19.10)** packages are very outdated and incompatible with GNOME 3.32 or later! If you are using GNOME on Ubuntu, you should _manually_ install the theme.
77
> Note: Some distro packages (especially Ubuntu ones) may be outdated and incompatible with your desktop environment. You can check the latest version [here](https://github.com/nana-4/materia-theme/releases).
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
Run the following commands in the terminal:
92
```sh
94
git clone --depth 1 https://github.com/nana-4/materia-theme
95
cd materia-theme
96
sudo ./install.sh
97
```
98
> Tip: `./install.sh` allows the following options:
100
```
102
-d, --dest DIR Specify destination directory (Default: /usr/share/themes)
103
-n, --name NAME Specify theme name (Default: Materia)
104
-c, --color VARIANT... Specify color variant(s) [standard|dark|light] (Default: All variants)
105
-s, --size VARIANT Specify size variant [standard|compact] (Default: All variants)
106
-g, --gdm Install and apply GDM theme (for advanced users)
107
See also: src/gnome-shell/README.md
108
-h, --help Show help
109
```
110
> For more information, run: `./install.sh --help`
112
### Manual Uninstallation
114
Delete the installed directories:
116
```sh
118
sudo rm -rf /usr/share/themes/Materia{,-dark,-light}{,-compact}
119
```
120
## Recommendations
122
### Font
124
- 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)).
126
- Set the font size to `9.75` (= 13px at 96dpi) or `10.5` (= 14px at 96dpi).
127
### Chrome Theme
129
To use the Chrome theme;
131
1. Open the `chrome` folder on `/usr/share/themes/Materia<-variant>`.
133
2. Drag and drop the `.crx` files into the Chrome/Chromium Extensions page (`chrome://extensions`).
134
### GDM Theme
136
You can change the GDM (lock/login screen) theme by replacing the default GNOME Shell theme.
138
See [`gnome-shell/README.md`](src/gnome-shell/README.md) for details.
139
## Customization
141
Materia can be customized with GUI application, [**oomox theme designer**](https://github.com/themix-project/oomox).
143
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.
145
## Contributing
147
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.
149
Todo list can be found at [`TODO.md`](TODO.md).
151
## Related Projects
153
- [**Materia KDE**](https://github.com/PapirusDevelopmentTeam/materia-kde) by @PapirusDevelopmentTeam
155
- [**Materia VSCode Theme**](https://marketplace.visualstudio.com/items?itemName=m-thorsen.vscode-materia) by @m-thorsen
156
- [**Materia Kolorizer**](https://github.com/DarthWound/materia-kolorizer) by @DarthWound
157
- [**oomox theme designer**](https://github.com/themix-project/oomox) by @themix-project
158
## License
160
Materia is distributed under the terms of the GNU General Public License, version 2 or later. See the [`COPYING`](COPYING) file for details.
162
## Credits
164
- Materia is based on [Adwaita](HACKING.md#upstream-theme-sources) by GNOME.
166
- Design and specifications are based on Google's [Material Design](https://material.io).
167
- The included symbolic icons are based on [Material Design icons](https://github.com/google/material-design-icons) by Google.
168
- Chrome/Chromium scrollbars extension was forked from [Adwaita-chrome-scrollbar](https://github.com/gnome-integration-team/chrome-gnome-scrollbar) by GNOME Integration Team.
169
- Yauhen Kirylau (@actionless) who is oomox author polished scripts and supported Materia with [oomox](https://github.com/themix-project/oomox).
170
- @n3oxmind who helped improve the installation script.
171
- @smurphos who made and provided the Cinnamon theme for Materia.
172
Also thank you to all contributors and upstream developers.
174