README.md
Unicode text, UTF-8 text
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.
Preview
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.4Cinnamon
>=3.xMATE
>=1.14Unity
>=7.4Xfce
>=4.13
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
Solus | materia-gtk-theme
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.sh allows 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) -h, --help Show 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.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 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
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
3
# Materia
4
5
Materia is a [Material Design](https://material.io) theme for GNOME/GTK based desktop environments.
6
7
It supports GTK 2, GTK 3, GNOME Shell, Budgie, Cinnamon, MATE, Unity, Xfce, LightDM, GDM, Chrome theme, etc.
8
9
## Preview
10
11

12
13
## Features
14
15
**Ripple effect** animations for GTK 3 are supported:
16
17

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