Hyprism handbook
Documentation
Install, configure, and understand the pieces of your Hyprism desktop.
Get started
Guides
ConfigurationEvery user.json field with its default, how changes are applied, and the environment variables Hyprism reads.Command lineUse hyprism-shell to manage widgets, themes, keyboard preferences, and desktop actions.KeybindingsReference the default Hyprland shortcuts provided by Hyprism.LocalizationSwitch the interface between English and Brazilian Portuguese.
Features
Desktop widgetsThe eleven desktop cards, where their data comes from, how to show or hide them, and how media players are selected.Lock screenHow Hyprism protects the Wayland session with a native session lock and PAM authentication.ThemingConfigure wallpaper-derived colors, appearance modes, presets, and light temperature.
Project
ArchitectureHow Hyprism is assembled from Hyprland, Quickshell, Python helpers, and one user configuration file, and where each part lives.DevelopmentSet up a checkout, run the checks, use the nested development session, and contribute.GalleryScreenshots and video tour of Hyprism shell surfaces, widgets, and appearance.Releases and packagingHow Hyprism versions are chosen, how a release reaches the AUR, and what CI checks on every push.Writing documentationAuthor pages in docs/, link between them, and draw Mermaid diagrams that the website renders.