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, MATE, Unity, LightDM, GDM, Chrome theme, etc.
Also Materia has compatibility 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.5MATE
>=1.14Unity
>=7.4
Installation
Packages
| Distro | Maintainer | Install Command |
|:-|:-|:-|
| Arch Linux [[Official][Arch]] | @ArchangeGabriel | sudo pacman -S materia-gtk-theme |
| Debian 10 / sid [[Official][Debian]] Ubuntu 18.04+ | @isaagar | sudo apt install materia-gtk-theme |
| Ubuntu 16.04 / 17.10 [[PPA][PPA]] | @igor-dyatlov | sudo add-apt-repository ppa:dyatlov-igor/materia-theme sudo apt update sudo apt install materia-gtk-theme |
| Fedora [[Copr][Copr]] | @LaurentTreguier | sudo dnf copr enable tcg/themes sudo dnf install materia-theme |
[Arch]: https://www.archlinux.org/packages/community/any/materia-gtk-theme [Debian]: https://packages.debian.org/unstable/materia-gtk-theme [PPA]: https://launchpad.net/~dyatlov-igor/+archive/ubuntu/materia-theme [Copr]: https://copr.fedorainfracloud.org/coprs/tcg/themes
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
Requirements
You need to have the following dependencies:
GTK+
>=3.18gnome-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
Install It
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
Note: ./install.sh allows the following options:
-d, --dest DIR Specify destination directory -n, --name NAME Specify theme name -c, --color VARIANTS... Specify color variant(s) [standard|dark|light] -s, --size VARIANT Specify size variant [standard|compact]
Without any options, Materia will be installed with all variants into /usr/share/themes.
Try ./install.sh --help for more information.
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 the wiki for details: https://github.com/nana-4/materia-theme/wiki/GDM-Theme
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 here: TODO.md
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.
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, MATE, Unity, LightDM, GDM, Chrome theme, etc.
7
8
Also Materia has compatibility with [oomox theme designer](https://github.com/actionless/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
- MATE `>=1.14`
36
- Unity `>=7.4`
37
38
## Installation
39
40
### Packages
41
42
| Distro | Maintainer | Install Command |
43
|:-|:-|:-|
44
| Arch Linux <sup>[[Official][Arch]]</sup> | @ArchangeGabriel | `sudo pacman -S materia-gtk-theme` |
45
| Debian 10 / sid <sup>[[Official][Debian]]</sup> <br> Ubuntu 18.04+ | @isaagar | `sudo apt install materia-gtk-theme` |
46
| Ubuntu 16.04 / 17.10 <sup>[[PPA][PPA]]</sup> | @igor-dyatlov | `sudo add-apt-repository ppa:dyatlov-igor/materia-theme` <br> `sudo apt update` <br> `sudo apt install materia-gtk-theme` |
47
| Fedora <sup>[[Copr][Copr]]</sup> | @LaurentTreguier | `sudo dnf copr enable tcg/themes` <br> `sudo dnf install materia-theme` |
48
49
[Arch]: https://www.archlinux.org/packages/community/any/materia-gtk-theme
50
[Debian]: https://packages.debian.org/unstable/materia-gtk-theme
51
[PPA]: https://launchpad.net/~dyatlov-igor/+archive/ubuntu/materia-theme
52
[Copr]: https://copr.fedorainfracloud.org/coprs/tcg/themes
53
54
#### Flatpak
55
56
3 variants (Materia, Materia-dark, Materia-light) are available via Flathub:
57
58
```
59
flatpak remote-add --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo
60
flatpak install flathub org.gtk.Gtk3theme.Materia
61
flatpak install flathub org.gtk.Gtk3theme.Materia-dark
62
flatpak install flathub org.gtk.Gtk3theme.Materia-light
63
```
64
65
### Manual Installation
66
67
#### Requirements
68
69
You need to have the following dependencies:
70
71
- GTK+ `>=3.18`
72
- `gnome-themes-extra` (or `gnome-themes-standard`)
73
- Murrine engine — The package name depends on the distro.
74
- `gtk-engine-murrine` on Arch Linux
75
- `gtk-murrine-engine` on Fedora
76
- `gtk2-engine-murrine` on openSUSE
77
- `gtk2-engines-murrine` on Debian, Ubuntu, etc.
78
- `bc` — build dependency
79
80
#### Install It
81
82
Run the following commands in the terminal:
83
84
```sh
85
cd /tmp && wget -qO - https://github.com/nana-4/materia-theme/archive/master.tar.gz | tar xz
86
cd materia-theme-master
87
sudo ./install.sh
88
```
89
90
Note: `./install.sh` allows the following options:
91
92
```
93
-d, --dest DIR Specify destination directory
94
-n, --name NAME Specify theme name
95
-c, --color VARIANTS... Specify color variant(s) [standard|dark|light]
96
-s, --size VARIANT Specify size variant [standard|compact]
97
```
98
99
Without any options, Materia will be installed with all variants into `/usr/share/themes`.
100
Try `./install.sh --help` for more information.
101
102
### Manual Uninstallation
103
104
Delete the installed directories:
105
106
```sh
107
sudo rm -rf /usr/share/themes/Materia{,-compact,-dark,-dark-compact,-light,-light-compact}
108
```
109
110
## Recommendations
111
112
#### Font
113
114
- 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)).
115
- Set the font size to `9.75` or `10.5` (i.e. 13px or 14px at 96dpi).
116
117
#### Chrome Theme
118
119
To use the Chrome theme;
120
121
1. Open the `chrome` folder on `/usr/share/themes/Materia<-variant>`.
122
2. Drag and drop the `.crx` files into the Chrome/Chromium Extensions page (`chrome://extensions`).
123
124
#### GDM Theme
125
126
You can change the GDM (lock/login screen) theme by replacing the default GNOME Shell theme.
127
See the wiki for details: https://github.com/nana-4/materia-theme/wiki/GDM-Theme
128
129
## Customization
130
131
Materia allows you to change the color scheme relatively easily. See [`HACKING.md`](HACKING.md#how-to-change-the-color-scheme) for details.
132
133
## Contributing
134
135
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.
136
137
ToDo list can be found here: [`TODO.md`](TODO.md)
138
139
## License
140
141
Materia is distributed under the terms of the GNU General Public License, version 2 or later. See the [`COPYING`](COPYING) file for details.
142
143
## Credits
144
145
- Materia is based on [Adwaita](HACKING.md#upstream-theme-sources) by GNOME.
146
- Design and specifications are based on Google's [Material Design](https://material.io).
147
- The included symbolic icons are based on [Material Design icons](https://github.com/google/material-design-icons) by Google.
148
- Chrome/Chromium scrollbars extension was forked from [Adwaita-chrome-scrollbar](https://github.com/gnome-integration-team/chrome-gnome-scrollbar) by GNOME Integration Team.
149
- Yauhen Kirylau (@actionless) who is oomox author polished scripts and supported Materia with [oomox](https://github.com/actionless/oomox).
150
- @n3oxmind who helped improve the installation script.
151
152
Also thank you to all contributors and upstream developers.
153