Nwg-shellのソースを表示

[[Category:Wayland compositors]]
The {{ic|nwg-shell}} project [https://nwg-piotr.github.io/nwg-shell/] aims to create a consistent, GTK based user interface for the [[Sway]] Wayland Compositor.

It also supports [[Hyprland]] since version 0.5.0 [https://github.com/nwg-piotr/nwg-shell/releases/tag/v0.5.0].

{{Note|Hyprland support is an addition to the shell, not a standalone feature.}}

== Installation ==

The {{ic|nwg-shell}} components can be [[install]]ed with the {{Pkg|nwg-shell}} (meta) package.

{{Note|Support for Hyprland requires a few additional packages. Check the list of optional dependencies for the {{Pkg|nwg-shell}} package.}}
{{Note|Most components of the {{ic|nwg-shell}} can also be installed and used standalone. See the [[#Shell components|shell components chapter]] for a full list of components.}}

The {{ic|nwg-shell-installer}} script (see the [[#Configuration|configuration chapter]]) also expects a [[List_of_applications/Internet#Web_browsers|web browser]], a [[List_of_applications/Utilities#File_managers|file manager]] and a [[List_of_applications/Documents#Text_editors|text editor]] to be installed '''before''' being run in order to setup keybindings properly. The suggested ones are {{pkg|firefox}}, {{pkg|thunar}} and {{pkg|mousepad}} but other ones can be installed instead.

== Configuration ==

The {{pkg|nwg-shell}} package provides the {{ic|nwg-shell-installer}} script which can be run to interactively generate a default configuration for every {{ic|nwg-shell}} components as well as a custom configuration for {{ic|Sway/Hyprland}} like so:

{{ic|nwg-shell-installer -w}} (for Sway)

{{ic|nwg-shell-installer -w -hypr}} (for Hyprland)

{{Note|The {{ic|nwg-shell-installer}} script expects a [[List_of_applications/Internet#Web_browsers|web browser]], a [[List_of_applications/Utilities#File_managers|file manager]] and a [[List_of_applications/Documents#Text_editors|text editor]] to be installed '''before''' being run in order to setup keybindings properly. The suggested ones are {{pkg|firefox}}, {{pkg|thunar}} and {{pkg|mousepad}} but other ones can be installed instead.}}

{{Warning|The {{ic|nwg-shell-installer}} script is made to be run on fresh installations as it will restore/overwrite configurations and style sheets of each {{ic|nwg-shell}} components as well as overwrite the {{ic|Sway}} (or {{ic|Hyprland}}) main configuration (a backup of the main {{ic|Sway/Hyprland}} configuration file is created by the script beforehand).}}

Alternatively, one can modify each {{ic|nwg-shell}}components' configurations and style sheets graphically or by modifying the related files under {{ic|~/.config/''component_name''}}.

Finally, one can [[enable]] the {{ic|greetd.service}} (so [[greetd]] will be started at boot) and [[Greetd#nwg-hello|set up the {{ic|nwg-hello}} greeter]].

== Shell components ==

The {{pkg|nwg-shell}} package provides the following {{ic|nwg-shell}} components:

{{Note|Most of these components can be installed and used standalone.}}

* {{App|azote|Wallpaper manager for wlroots-based compositors and some other WMs.|https://github.com/nwg-piotr/azote|{{Pkg|azote}}}}
* {{App|gopsuinfo|A gopsutil-based command to display system usage info as text in panels like Waybar or icon/text in tint2 and nwg-panel executors.|https://github.com/nwg-piotr/gopsuinfo|{{Pkg|gopsuinfo}}}}
* {{App|nwg-bar|GTK3-based button bar for wlroots-based compositors.|https://github.com/nwg-piotr/nwg-bar|{{Pkg|nwg-bar}}}}
* {{App|nwg-clipman|a GTK3-based GUI for cliphist.|https://github.com/nwg-piotr/nwg-clipman|{{Pkg|nwg-clipman}}}}
* {{App|nwg-displays|Output management utility for sway and Hyprland.|https://github.com/nwg-piotr/nwg-displays|{{Pkg|nwg-displays}}}}
* {{App|nwg-dock|GTK3-based dock for Sway.|https://github.com/nwg-piotr/nwg-dock|{{Pkg|nwg-dock}}}}
* {{App|nwg-dock-hyprland|GTK3-based dock for Hyprland.|https://github.com/nwg-piotr/nwg-dock-hyprland|{{Pkg|nwg-dock-hyprland}}}}
* {{App|nwg-drawer|Application drawer for wlroots-based Wayland compositors.|https://github.com/nwg-piotr/nwg-drawer|{{Pkg|nwg-drawer}}}}
* {{App|nwg-hello|GTK3-based greeter for greetd written in python.|https://github.com/nwg-piotr/nwg-hello|{{Pkg|nwg-hello}}}}
* {{App|nwg-icon-picker|GTK icon chooser with a text search option.|https://github.com/nwg-piotr/nwg-icon-picker|{{Pkg|nwg-icon-picker}}}}
* {{App|nwg-look|GTK3 settings editor adapted to work in the wlroots environment.|https://github.com/nwg-piotr/nwg-look|{{Pkg|nwg-look}}}}
* {{App|nwg-menu|MenuStart plugin to nwg-panel, also capable of working standalone.|https://github.com/nwg-piotr/nwg-menu|{{Pkg|nwg-menu}}}}
* {{App|nwg-panel|GTK3-based panel for sway and Hyprland Wayland compositors.|https://github.com/nwg-piotr/nwg-panel|{{Pkg|nwg-panel}}}}
* {{App|nwg-readme-browser|WebKitGTK-based README file browser.|https://github.com/nwg-piotr/nwg-readme-browser|{{Pkg|nwg-readme-browser}}}}
* {{App|nwg-shell|Installer & meta-package for the nwg-shell project: a GTK3-based shell for Sway and Hyprland Wayland compositors.|https://github.com/nwg-piotr/nwg-shell|{{Pkg|nwg-shell}}}}
* {{App|nwg-shell-config|nwg-shell configuration utility.|https://github.com/nwg-piotr/nwg-shell-config|{{Pkg|nwg-shell-config}}}}
* {{App|nwg-shell-wallpapers|Selection of wallpapers contributed to the nwg-shell project.|https://github.com/nwg-piotr/nwg-shell-wallpapers|{{Pkg|nwg-shell-wallpapers}}}}