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:
3 color variants and 2 size variants are available:
| Materia | - | compact | |:-:|:-:|:-:| | - | ![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... and more DEs are planned.
Installation
Arch Linux
Package is available via AUR (maintained by @cthbleachbit):
yaourt -S materia-theme
Fedora / EPEL
Package is available via Copr (maintained by @LaurentTreguier):
sudo dnf copr enable tcg/themes sudo dnf install materia-theme
Ubuntu
Package is available via PPA (maintained by @igor-dyatlov):
sudo add-apt-repository ppa:dyatlov-igor/materia-theme sudo apt update sudo apt install materia-theme
From Source
Requirements
You need to have the following dependencies:
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 also need the libxml2-utils package.
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
Note: ./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)
Without any options, Materia will be installed with all variants into /usr/share/themes.
Try ./install.sh --help for more information.
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
Previews
GNOME Shell
Budgie Desktop
GDM
Previews Info: Icon Theme: Paper | Font: M+ 1C 9.75pt | Dock's icon size: 48px + fixed | Wallpapers
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
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
**3 color variants** and **2 size variants** are available:
15
16
| **Materia** | **-** | **compact** |
17
|:-:|:-:|:-:|
18
| **-** | ![Materia][1] | ![Materia-compact][2] |
19
| **dark** | ![Materia-dark][3] | ![Materia-dark-compact][4] |
20
| **light** | ![Materia-light][5] | ![Materia-light-compact][6] |
21
22
[1]: ../images/Materia.png?raw=true
23
[2]: ../images/Materia-compact.png?raw=true
24
[3]: ../images/Materia-dark.png?raw=true
25
[4]: ../images/Materia-dark-compact.png?raw=true
26
[5]: ../images/Materia-light.png?raw=true
27
[6]: ../images/Materia-light-compact.png?raw=true
28
29
Various **desktop environments** are supported:
30
31
- GNOME Shell `>=3.18`
32
- Budgie `>=10.2.5`
33
- MATE `>=1.14`
34
- Unity `>=7.4`
35
- ... and more DEs are [planned](TODO.md#supports).
36
37
## Installation
38
39
### Arch Linux
40
41
Package is available via [AUR](https://aur.archlinux.org/packages/materia-theme/) (maintained by @cthbleachbit):
42
43
```
44
yaourt -S materia-theme
45
```
46
47
### Fedora / EPEL
48
49
Package is available via [Copr](https://copr.fedorainfracloud.org/coprs/tcg/themes/) (maintained by @LaurentTreguier):
50
51
```
52
sudo dnf copr enable tcg/themes
53
sudo dnf install materia-theme
54
```
55
56
### Ubuntu
57
58
Package is available via [PPA](https://launchpad.net/~dyatlov-igor/+archive/ubuntu/materia-theme) (maintained by @igor-dyatlov):
59
60
```
61
sudo add-apt-repository ppa:dyatlov-igor/materia-theme
62
sudo apt update
63
sudo apt install materia-theme
64
```
65
66
### From Source
67
68
#### Requirements
69
70
You need to have the following dependencies:
71
72
- GTK+ `>=3.18`
73
- `gnome-themes-standard`
74
- Murrine engine - The package name depends on the distro.
75
- `gtk-engine-murrine` on Arch Linux
76
- `gtk-murrine-engine` on Fedora
77
- `gtk2-engine-murrine` on openSUSE
78
- `gtk2-engines-murrine` on Debian, Ubuntu, etc.
79
- `glib-compile-resources` - The package name depends on the distro.
80
- `glib2` on Arch Linux
81
- `glib2-devel` on Fedora, openSUSE, etc.
82
- `libglib2.0-dev` on Debian, Ubuntu, etc.
83
84
For Ubuntu, you also need the `libxml2-utils` package.
85
86
#### Installation
87
88
Run the following commands in the terminal:
89
90
```sh
91
cd /tmp && wget -qO - https://github.com/nana-4/materia-theme/archive/master.tar.gz | tar xz
92
cd materia-theme-master
93
sudo ./install.sh
94
```
95
96
**Note:** `./install.sh` allows the following options:
97
98
```
99
-d, --dest DIR Specify theme destination directory (Default: /usr/share/themes)
100
-n, --name NAME Specify theme name (Default: Materia)
101
-c, --color VARIANTS... Specify theme color variant(s) [standard|dark|light] (Default: All variants)
102
-s, --size VARIANT Specify theme size variant [standard|compact] (Default: All variants)
103
```
104
105
Without any options, **Materia** will be installed with **all variants** into `/usr/share/themes`.
106
Try `./install.sh --help` for more information.
107
108
#### Uninstallation
109
110
Delete the installed directories:
111
112
```sh
113
sudo rm -rf /usr/share/themes/Materia{,-compact,-dark,-dark-compact,-light,-light-compact}
114
```
115
116
## Recommendations
117
118
### Font
119
120
- 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)).
121
- Set the font size to `9.75` or `10.5` (i.e. 13px or 14px at 96dpi).
122
123
### Chrome Theme
124
125
To use the Chrome theme;
126
127
1. Open the `chrome` folder on `/usr/share/themes/Materia<-variant>`.
128
2. Drag and drop the `.crx` files into the Chrome/Chromium Extensions page (`chrome://extensions`).
129
130
### GDM Theme
131
132
You can change the GDM (lock/login screen) theme by replacing the default GNOME Shell theme.
133
See the wiki for details: https://github.com/nana-4/materia-theme/wiki/GDM-Theme
134
135
## Previews
136
137
##### GNOME Shell
138

139
140
##### Budgie Desktop
141

142
143
##### GDM
144

145
146
<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>
147
148
## Customization
149
150
Materia allows you to change the color scheme relatively easily. See [`HACKING.md`](HACKING.md#changing-the-color-scheme-with-script) for details.
151
152
## Contributing
153
154
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.
155
156
ToDo list can be found here: [`TODO.md`](TODO.md)
157
158
## License
159
160
Materia is distributed under the terms of the GNU General Public License, version 2 or later. See the [`COPYING`](COPYING) file for details.
161
162
## Credits
163
164
- Materia is based on [Adwaita](HACKING.md#upstream-theme-sources) by GNOME.
165
- Design and specifications are based on Google's [Material Design](https://material.io).
166
- The included symbolic icons are based on [Material Design icons](https://github.com/google/material-design-icons) by Google.
167
- Chrome/Chromium scrollbars extension was forked from [Adwaita-chrome-scrollbar](https://github.com/gnome-integration-team/chrome-gnome-scrollbar) by GNOME Integration Team.
168
- Yauhen Kirylau (@actionless) who is oomox author polished scripts and supported Materia with [oomox](https://github.com/actionless/oomox).
169
- @n3oxmind who helped improve the installation script.
170
171
Also thank you to all contributors and upstream developers.
172