README.md
ASCII 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:
Three color variants and two size variants are available:
| Materia | - | compact |
|:-:|:-:|:-:|
| - |
|
|
| dark |
|
|
| light |
|
|
Various desktop environments are supported:
GNOME Shell
>=3.18Budgie
>=10.2.5MATE
>=1.14Unity
>=7.4... and more DEs are planned.
Requirements
GTK+
>=3.18gnome-themes-standardMurrine engine - The package name depends on the distro.
gtk-engine-murrineon Arch Linuxgtk-murrine-engineon Fedoragtk2-engine-murrineon openSUSEgtk2-engines-murrineon Debian, Ubuntu, etc.
glib-compile-resources- The package name depends on the distro.glib2on Arch Linuxglib2-develon Fedora, openSUSE, etc.libglib2.0-devon Debian, Ubuntu, etc.
For Ubuntu, you'll also need the libxml2-utils package.
Installation
Packages
|| Install command |
|:-|:-|
| Arch Linux [1] | yaourt -S materia-theme |
| Fedora / EPEL [2] | sudo dnf copr enable tcg/themes && sudo dnf install materia-theme |
The AUR package is maintained by @cthbleachbit.
The Copr repository is maintained by @LaurentTreguier.
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
Custom Installation
./install.sh allows the following options:
-d, --dest DIR Specify theme destination directory (Default: /usr/share/themes) -n, --name NAME Specify theme name (Default: Materia) -c, --color VARIANTS... Specify theme color variant(s) [standard|dark|light] (Default: All variants) -s, --size VARIANT Specify theme size variant [standard|compact] (Default: All variants)
For example, to install only Materia-dark into ~/.themes, run:
./install.sh -c dark -s standard -d ~/.themes
For further details, run ./install.sh --help.
To change the color scheme of the theme, see the page.
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
Mediumweight (such as 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 onto 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
Previews
GNOME Shell
Budgie Desktop
GDM
Previews Info: Icon Theme: Paper | Font: M+ 1C 9.75pt | Dock's icon size: 48px + fixed | Wallpapers
Contributing
If you find bugs or have suggestions, please report it to the issue tracker. Any contribution would be much appreciated.
See also (if necessary): TODO.md and HACKING.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
This theme is based on Adwaita by GNOME.
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.
The original concept is Google's Material Design.
Yauhen Kirylau (@actionless) who is oomox author polished scripts and supported Materia with oomox.
@n3oxmind helped improve the installation script.
Also thank you to all contributors and upstream developers.
1
# Materia
2
3
Materia (formerly Flat-Plat) is a [Material Design](https://material.io) theme for GNOME/GTK+ based desktop environments.
4
It supports GTK+ 3, GTK+ 2, GNOME Shell, Budgie, MATE, Unity, LightDM, GDM, Chrome theme, etc.
5
6
Also Materia has compatibility with [oomox theme designer](https://github.com/actionless/oomox).
7
8
## Features
9
10
**Ripple effect** animations for GTK+ 3 are supported:
11
12

13
14
**Three color variants** and **two size variants** are available:
15
16
| **Materia** | **-** | **compact** |
17
|:-:|:-:|:-:|
18
| **-** |  |  |
19
| **dark** |  |  |
20
| **light** |  |  |
21
22
Various **desktop environments** are supported:
23
24
- GNOME Shell `>=3.18`
25
- Budgie `>=10.2.5`
26
- MATE `>=1.14`
27
- Unity `>=7.4`
28
- ... and more DEs are [planned](TODO.md#supports).
29
30
## Requirements
31
32
- GTK+ `>=3.18`
33
- `gnome-themes-standard`
34
- Murrine engine - The package name depends on the distro.
35
- `gtk-engine-murrine` on Arch Linux
36
- `gtk-murrine-engine` on Fedora
37
- `gtk2-engine-murrine` on openSUSE
38
- `gtk2-engines-murrine` on Debian, Ubuntu, etc.
39
- `glib-compile-resources` - The package name depends on the distro.
40
- `glib2` on Arch Linux
41
- `glib2-devel` on Fedora, openSUSE, etc.
42
- `libglib2.0-dev` on Debian, Ubuntu, etc.
43
44
For Ubuntu, you'll also need the `libxml2-utils` package.
45
46
## Installation
47
48
#### Packages
49
50
|| **Install command** |
51
|:-|:-|
52
| **Arch Linux** [1] | `yaourt -S materia-theme` |
53
| **Fedora / EPEL** [2] | `sudo dnf copr enable tcg/themes && sudo dnf install materia-theme` |
54
55
1. The [AUR package](https://aur.archlinux.org/packages/materia-theme/) is maintained by [@cthbleachbit](https://github.com/cthbleachbit).
56
2. The [Copr repository](https://copr.fedorainfracloud.org/coprs/tcg/themes/) is maintained by [@LaurentTreguier](https://github.com/LaurentTreguier).
57
58
#### Manual Installation
59
60
Run the following commands in the terminal:
61
62
```sh
63
cd /tmp && wget -qO - https://github.com/nana-4/materia-theme/archive/master.tar.gz | tar xz
64
cd materia-theme-master
65
sudo ./install.sh
66
```
67
68
#### Custom Installation
69
70
`./install.sh` allows the following options:
71
72
```
73
-d, --dest DIR Specify theme destination directory (Default: /usr/share/themes)
74
-n, --name NAME Specify theme name (Default: Materia)
75
-c, --color VARIANTS... Specify theme color variant(s) [standard|dark|light] (Default: All variants)
76
-s, --size VARIANT Specify theme size variant [standard|compact] (Default: All variants)
77
```
78
79
For example, to install only `Materia-dark` into `~/.themes`, run:
80
81
```sh
82
./install.sh -c dark -s standard -d ~/.themes
83
```
84
85
For further details, run `./install.sh --help`.
86
87
To change the color scheme of the theme, see [the page](HACKING.md#changing-the-color-scheme-with-script).
88
89
#### Manual Uninstallation
90
91
Delete the installed directories:
92
93
```sh
94
sudo rm -rf /usr/share/themes/Materia{,-compact,-dark,-dark-compact,-light,-light-compact}
95
```
96
97
## Recommendations
98
99
#### Font
100
101
- To properly display the theme, use a font family including `Medium` weight (such as [Roboto](https://github.com/google/roboto) or [M+](https://mplus-fonts.osdn.jp)).
102
- Set the font size to `9.75` (= 13px at 96dpi) or `10.5` (= 14px at 96dpi).
103
104
#### Chrome Theme
105
106
To use the Chrome theme;
107
108
1. Open the `chrome` folder on `/usr/share/themes/Materia<-variant>`.
109
2. Drag and drop the `.crx` files onto the Chrome/Chromium Extensions page: `chrome://extensions`
110
111
#### GDM Theme
112
113
You can change the GDM (lock/login screen) theme by replacing the default GNOME Shell theme.
114
See the wiki for details: https://github.com/nana-4/materia-theme/wiki/GDM-Theme
115
116
## Previews
117
118
##### GNOME Shell
119

120
121
##### Budgie Desktop
122

123
124
##### GDM
125

126
127
<sub>**Previews Info:** Icon Theme: [Paper](https://github.com/snwh/paper-icon-theme) | Font: [M+ 1C](https://mplus-fonts.osdn.jp) 9.75pt | Dock's icon size: 48px + fixed | [Wallpapers](https://imgur.com/a/v2Ovx)</sub>
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
See also (if necessary): [`TODO.md`](TODO.md) and [`HACKING.md`](HACKING.md)
134
135
## License
136
137
Materia is distributed under the terms of the GNU General Public License, version 2 or later. See the [`COPYING`](COPYING) file for details.
138
139
## Credits
140
141
- This theme is based on [Adwaita](HACKING.md#upstream-theme-sources) by GNOME.
142
- The included symbolic icons are based on [Material Design icons](https://github.com/google/material-design-icons) by Google.
143
- Chrome/Chromium scrollbars extension was forked from [Adwaita-chrome-scrollbar](https://github.com/gnome-integration-team/chrome-gnome-scrollbar) by GNOME Integration Team.
144
- The original concept is Google's [Material Design](https://material.io).
145
- Yauhen Kirylau (@actionless) who is oomox author polished scripts and supported Materia with [oomox](https://github.com/actionless/oomox).
146
- @n3oxmind helped improve the installation script.
147
148
Also thank you to all contributors and upstream developers.
149