# Materia Materia is a [Material Design](https://material.io) 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. ## Previews   ## Features Supports **ripple animations** for GTK 3:  **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 ## Supported Desktop Environments - Budgie `>=10.4` - Cinnamon `>=3.x` - GNOME Shell `>=3.26` - MATE `>=1.14` - Unity `>=7.4` - Xfce `>=4.13` ## Unsupported - Downstream customized GNOME sessions > e.g. "Ubuntu" session, "Pop" session. To properly use Materia on GNOME Shell, please install `gnome-session` and then switch to "GNOME" or "GNOME on Xorg" session from your display manager. - elementary apps > Because they are based on [their own stylesheet](https://github.com/elementary/stylesheet) that conflicts with GTK standards. ## Requirements - GTK `>=3.20` - `gnome-themes-extra` (or `gnome-themes-standard`) - Murrine engine — The package name depends on the distro. - `gtk-engine-murrine` on Arch Linux - `gtk-murrine-engine` on Fedora - `gtk2-engine-murrine` on openSUSE - `gtk2-engines-murrine` on Debian, Ubuntu, etc. - `sassc` — build-time dependency ## Package Installation ### Distro Packages > NOTE: Some of these distro packages could be outdated and incompatible with your desktop environment. You can check the latest version [here](https://github.com/nana-4/materia-theme/releases). Distro | Package Name | Annotation --- | --- | --- Arch Linux | `materia-gtk-theme` | [Link](https://www.archlinux.org/packages/community/any/materia-gtk-theme/) Debian 10 or later | `materia-gtk-theme` | [Link](https://packages.debian.org/materia-gtk-theme) Fedora | `materia-gtk-theme` | [Link](https://src.fedoraproject.org/rpms/materia-gtk-theme) Solus | `materia-gtk-theme` | [Link](https://dev.getsol.us/source/materia-gtk-theme/) Ubuntu 18.04 or later | `materia-gtk-theme` | [Link](https://packages.ubuntu.com/materia-gtk-theme) **WARNING:** Ubuntu **disco (19.04)** & **eoan (19.10)** packages are very outdated and incompatible with GNOME 3.32 or later! If you're using GNOME on Ubuntu 19.04 or 19.10, I highly recommend [manual installation](#manual-installation) below. ### 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 1. Clone the repository and move into the project directory in the terminal: ```sh git clone --depth 1 https://github.com/nana-4/materia-theme cd materia-theme ``` 2. Build and install it using Meson: ```sh meson "build" sudo ninja -C "build" install ``` Alternatively, you can use `./install.sh` script without using Meson: ```sh sudo ./install.sh ``` #### Build Options for Meson Option | Default Value | Description --- | --- | --- `prefix` | `/usr` | Installation prefix `colors` | `default,light,dark` | Choose color variant(s) `sizes` | `default,compact` | Choose size variant(s) `gnome_shell_version` | n/a (auto) | Manually set gnome-shell version Example of usage: ```sh meson "build" -Dprefix="$HOME/.local" -Dcolors=default,dark -Dsizes=compact ``` #### Build Options for `./install.sh` Run `./install.sh --help` for details. ## Manual Uninstallation Delete the installed directories: ```sh 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](https://github.com/google/roboto) or [M+](https://mplus-fonts.osdn.jp)). - Set the font size to `9.75` (= 13px at 96dpi) or `10.5` (= 14px at 96dpi). ### Chrome Theme To use the Chrome theme; 1. Open the `chrome` folder on `/usr/share/themes/Materia<-variant>`. 2. Drag and drop the `.crx` files 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`](src/gnome-shell/README.md) for details. ## Customization Materia can be customized with GUI application, [**oomox theme designer**](https://github.com/themix-project/oomox). 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. ## Contributing 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. Todo list can be found at [`TODO.md`](TODO.md). ## Related Projects - [**Materia KDE**](https://github.com/PapirusDevelopmentTeam/materia-kde) by @PapirusDevelopmentTeam - [**Materia VSCode Theme**](https://marketplace.visualstudio.com/items?itemName=m-thorsen.vscode-materia) by @m-thorsen - [**Materia Kolorizer**](https://github.com/DarthWound/materia-kolorizer) by @DarthWound - [**oomox theme designer**](https://github.com/themix-project/oomox) by @themix-project ## License Materia is distributed under the terms of the GNU General Public License, version 2 or later. See the [`COPYING`](COPYING) file for details. ## Credits - Materia is based on [Adwaita](HACKING.md#upstream-theme-sources) by GNOME. - Design and specifications are based on Google's [Material Design](https://material.io). - The included symbolic icons are based on [Material Design icons](https://github.com/google/material-design-icons) by Google. - Chrome/Chromium scrollbars extension was forked from [Adwaita-chrome-scrollbar](https://github.com/gnome-integration-team/chrome-gnome-scrollbar) by GNOME Integration Team. - Yauhen Kirylau (@actionless) who is oomox author polished scripts and supported Materia with [oomox](https://github.com/themix-project/oomox). - @n3oxmind who helped improve the installation script. - @smurphos who made and provided the Cinnamon theme for Materia. - Meson code/implementation in Materia was heavily influenced by @monday15's [lounge-gtk-theme](https://github.com/monday15/lounge-gtk-theme). Also thank you to all contributors and upstream developers.