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, Xfce, LightDM, GDM, Chrome theme, etc.
Also Materia can be customized with oomox theme designer.
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:
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{,-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 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
<img src="../images/materia-logo.svg?sanitize=true" alt="materia-logo" align="right" />
2
3
# Materia
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, Xfce, LightDM, GDM, Chrome theme, etc.
7
8
Also Materia can be customized with [oomox theme designer](https://github.com/themix-project/oomox).
9
10
## Preview
11
12

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

19
20
**3 color variants** and **2 size variants** are available:
21
22
**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
28
[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
35
Various **desktop environments** are supported:
36
37
- GNOME Shell `>=3.18`
38
- Budgie `>=10.4`
39
- Cinnamon `>=3.x`
40
- MATE `>=1.14`
41
- Unity `>=7.4`
42
- Xfce `>=4.13`
43
44
## Requirements
45
46
- GTK+ `>=3.20`
47
- `gnome-themes-extra` (or `gnome-themes-standard`)
48
- Murrine engine — The package name depends on the distro.
49
- `gtk-engine-murrine` on Arch Linux
50
- `gtk-murrine-engine` on Fedora
51
- `gtk2-engine-murrine` on openSUSE
52
- `gtk2-engines-murrine` on Debian, Ubuntu, etc.
53
- `bc` — build dependency
54
55
## Installation
56
57
### Distro Packages
58
59
Distro | Package Name / Link
60
--- | ---
61
Arch Linux | [`materia-gtk-theme`](https://www.archlinux.org/packages/community/any/materia-gtk-theme)
62
Debian testing / unstable <br> Ubuntu 18.04+ | [`materia-gtk-theme`](https://packages.debian.org/unstable/materia-gtk-theme)
63
Ubuntu 16.04 / 17.10 | `materia-gtk-theme` from [@igor-dyatlov's PPA](https://launchpad.net/~dyatlov-igor/+archive/ubuntu/materia-theme)
64
Fedora | `materia-theme` from [@LaurentTreguier's Copr](https://copr.fedorainfracloud.org/coprs/tcg/themes)
65
Solus | [`materia-gtk-theme`](https://dev.getsol.us/source/materia-gtk-theme/)
66
67
### Flatpak
68
69
All 6 variants are available via Flathub:
70
71
```
72
flatpak remote-add --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo
73
flatpak install flathub org.gtk.Gtk3theme.Materia{,-dark,-light}{,-compact}
74
```
75
76
### Manual Installation
77
78
Run the following commands in the terminal:
79
80
```sh
81
cd /tmp && wget -qO - https://github.com/nana-4/materia-theme/archive/master.tar.gz | tar xz
82
cd materia-theme-master
83
sudo ./install.sh
84
```
85
86
Tip: `./install.sh` allows the following options:
87
88
Option | Description
89
--- | ---
90
`-d`, `--dest` _DIR_ | Specify theme destination directory. (Default: `/usr/share/themes`)
91
`-n`, `--name` _NAME_ | Specify theme name. (Default: `Materia`)
92
`-c`, `--color` _VARIANT..._ | Specify theme color variant(s). (Default: All [`standard`\|`dark`\|`light`] variants)
93
`-s`, `--size` _VARIANT_ | Specify theme size variant. (Default: All [`standard`\|`compact`] variants)
94
`-g`, `--gdm` | Install and apply GDM theme.
95
`-h`, `--help` | Show help.
96
97
### Manual Uninstallation
98
99
Delete the installed directories:
100
101
```sh
102
sudo rm -rf /usr/share/themes/Materia{,-dark,-light}{,-compact}
103
```
104
105
## Recommendations
106
107
### Font
108
109
- 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)).
110
- Set the font size to `9.75` or `10.5` (i.e. 13px or 14px at 96dpi).
111
112
### Chrome Theme
113
114
To use the Chrome theme;
115
116
1. Open the `chrome` folder on `/usr/share/themes/Materia<-variant>`.
117
2. Drag and drop the `.crx` files into the Chrome/Chromium Extensions page (`chrome://extensions`).
118
119
### GDM Theme
120
121
You can change the GDM (lock/login screen) theme by replacing the default GNOME Shell theme.
122
See [`gnome-shell/README.md`](src/gnome-shell/README.md) for details.
123
124
## Customization
125
126
Materia allows you to change the color scheme relatively easily. See [`HACKING.md`](HACKING.md#how-to-change-the-color-scheme) for details.
127
128
## Contributing
129
130
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.
131
132
Todo list can be found at [`TODO.md`](TODO.md).
133
134
## Related Projects
135
136
- [**Materia KDE**](https://github.com/PapirusDevelopmentTeam/materia-kde) by @PapirusDevelopmentTeam
137
- [**Materia VSCode Theme**](https://marketplace.visualstudio.com/items?itemName=m-thorsen.vscode-material-mt) by @m-thorsen
138
- [**Materia Kolorizer**](https://github.com/DarthWound/materia-kolorizer) by @DarthWound
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