hyprland-docs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Hyprland

Hyprland

Hyprland is a dynamic tiling Wayland compositor that doesn't sacrifice on its looks. It provides the latest Wayland features, is highly customizable, has all the eyecandy, and comes with powerful plugins.
Hyprland是一款动态平铺Wayland合成器,在外观表现上毫不妥协。它提供最新的Wayland特性,具备高度可定制性,拥有丰富的视觉效果,并支持强大的插件系统。

Quick Start

快速开始

bash
undefined
bash
undefined

Config location

配置文件位置

~/.config/hypr/hyprland.conf
~/.config/hypr/hyprland.conf

Launch Hyprland from TTY

从TTY启动Hyprland

start-hyprland
start-hyprland

Basic keybinds (default config)

基础快捷键(默认配置)

SUPER + Q # Launch terminal (kitty) SUPER + C # Close window SUPER + M # Exit Hyprland SUPER + E # File manager SUPER + V # Toggle floating SUPER + R # App launcher SUPER + 1-9 # Switch workspace SUPER + SHIFT + 1-9 # Move window to workspace
SUPER + Q # 启动终端(kitty) SUPER + C # 关闭窗口 SUPER + M # 退出Hyprland SUPER + E # 打开文件管理器 SUPER + V # 切换浮动模式 SUPER + R # 启动应用启动器 SUPER + 1-9 # 切换工作区 SUPER + SHIFT + 1-9 # 将窗口移动到指定工作区

Control Hyprland via CLI

通过CLI控制Hyprland

hyprctl dispatch exec kitty hyprctl keyword general:border_size 3 hyprctl reload
undefined
hyprctl dispatch exec kitty hyprctl keyword general:border_size 3 hyprctl reload
undefined

Installation

安装

bash
undefined
bash
undefined

Arch Linux (recommended)

Arch Linux(推荐)

sudo pacman -S hyprland
sudo pacman -S hyprland

NixOS - add to configuration.nix

NixOS - 添加到configuration.nix

programs.hyprland.enable = true;
programs.hyprland.enable = true;

Install default terminal

安装默认终端

sudo pacman -S kitty
undefined
sudo pacman -S kitty
undefined

Documentation

文档

Complete documentation in
docs/
. Consult
docs/000-index.md
for navigation.
完整文档位于
docs/
目录。请查看
docs/000-index.md
进行导航。

By Topic

按主题分类

TopicFilesDescription
Getting Started001, 034-036Installation, tutorials, preconfigured setups
Configuration003-025Animations, binds, layouts, monitors, variables
Window Management005-006, 012, 022-023Dispatchers, dwindle/master layouts, rules
Input & Gestures010, 021 (input section)Touchpad, keyboard, gestures
Hypr Ecosystem037-058hypridle, hyprlock, hyprpaper, hyprcursor, etc.
Nix Integration062-069NixOS, Home Manager, Cachix, plugins
Plugins071-077Development, using plugins, event hooks
Utilities079-091Status bars, launchers, clipboard, wallpapers
Troubleshooting032-033, 070Crashes, bugs, FAQ, Nvidia
主题文件描述
入门指南001, 034-036安装、教程、预配置方案
配置003-025动画、快捷键、布局、显示器、变量
窗口管理005-006, 012, 022-023调度器、dwindle/master布局、规则
输入与手势010, 021(输入章节)触控板、键盘、手势
Hypr生态系统037-058hypridle、hyprlock、hyprpaper、hyprcursor等
Nix集成062-069NixOS、Home Manager、Cachix、插件
插件071-077开发、插件使用、事件钩子
实用工具079-091状态栏、应用启动器、剪贴板、壁纸
故障排除032-033, 070崩溃、BUG、常见问题、Nvidia适配

By Keyword

按关键词分类

KeywordFile
animation003, 021
keybinds / binds004
dispatchers005
dwindle-layout006
master-layout012
environment-variables007
monitors013
multi-gpu014
performance015
window-rules022
workspace-rules023
xwayland024
hyprctl020
hyprlang043
hypridle040
hyprlock045
hyprpaper046
hyprcursor038
nvidia070
plugins071-077
ipc / sockets009, 061
gestures010
tearing018
screensharing087
status-bars / waybar088
app-launchers080
clipboard081
uwsm / systemd089
关键词文件
animation003, 021
keybinds / binds004
dispatchers005
dwindle-layout006
master-layout012
environment-variables007
monitors013
multi-gpu014
performance015
window-rules022
workspace-rules023
xwayland024
hyprctl020
hyprlang043
hypridle040
hyprlock045
hyprpaper046
hyprcursor038
nvidia070
plugins071-077
ipc / sockets009, 061
gestures010
tearing018
screensharing087
status-bars / waybar088
app-launchers080
clipboard081
uwsm / systemd089

Learning Path

学习路径

  1. Foundation: Read 034 (Installation), 035 (Master Tutorial), 036 (Getting Started)
  2. Configuration Basics: 017 (Config Start), 021 (Variables), 004 (Binds)
  3. Window Management: 005 (Dispatchers), 006/012 (Layouts), 022 (Window Rules)
  4. Visual Customization: 003 (Animations), 013 (Monitors), 021 (Decorations section)
  5. Ecosystem Tools: 040 (hypridle), 045 (hyprlock), 046 (hyprpaper)
  6. Advanced: 071-077 (Plugins), 061 (IPC), 009 (Automation)
  1. 基础阶段:阅读034(安装)、035(主教程)、036(入门指南)
  2. 配置基础:017(配置入门)、021(变量)、004(快捷键)
  3. 窗口管理:005(调度器)、006/012(布局)、022(窗口规则)
  4. 视觉定制:003(动画)、013(显示器)、021(装饰章节)
  5. 生态工具:040(hypridle)、045(hyprlock)、046(hyprpaper)
  6. 进阶内容:071-077(插件)、061(IPC)、009(自动化)

Common Tasks

常见任务

Configure monitors

配置显示器

->
docs/013-Configuring-Monitors.md
(resolution, position, scaling, rotation, VRR, HDR)
->
docs/013-Configuring-Monitors.md
(分辨率、位置、缩放、旋转、VRR、HDR)

Set up keybinds

设置快捷键

->
docs/004-Configuring-Binds.md
(basic binds, mouse binds, submaps, global shortcuts)
->
docs/004-Configuring-Binds.md
(基础快捷键、鼠标快捷键、子映射、全局快捷方式)

Create window rules

创建窗口规则

->
docs/022-Configuring-Window-Rules.md
(match by class/title, float, opacity, workspace)
->
docs/022-Configuring-Window-Rules.md
(按类名/标题匹配、浮动、透明度、工作区)

Configure animations

配置动画

->
docs/003-Configuring-Animations.md
(animation tree, bezier curves, speed, style)
->
docs/003-Configuring-Animations.md
(动画树、贝塞尔曲线、速度、样式)

Set up idle/lock screen

设置空闲/锁屏

->
docs/040-Hypr-Ecosystem-hypridle.md
+
docs/045-Hypr-Ecosystem-hyprlock.md
->
docs/040-Hypr-Ecosystem-hypridle.md
+
docs/045-Hypr-Ecosystem-hyprlock.md

Configure Nvidia GPU

配置Nvidia GPU

->
docs/070-Nvidia.md
(drivers, environment variables, troubleshooting)
->
docs/070-Nvidia.md
(驱动、环境变量、故障排除)

Use hyprctl commands

使用hyprctl命令

->
docs/020-Configuring-Using-hyprctl.md
(dispatch, keyword, reload, clients)
->
docs/020-Configuring-Using-hyprctl.md
(调度、关键词、重载、客户端)

Debug crashes

调试崩溃问题

->
docs/032-Crashes-and-Bugs.md
(logs, crash reports, coredumps, bisect)
->
docs/032-Crashes-and-Bugs.md
(日志、崩溃报告、核心转储、二分排查)

Screen sharing setup

屏幕共享设置

->
docs/087-Useful-Utilities-Screen-Sharing.md
(PipeWire, xdg-desktop-portal)
->
docs/087-Useful-Utilities-Screen-Sharing.md
(PipeWire、xdg-desktop-portal)

Set up status bar

设置状态栏

->
docs/088-Useful-Utilities-Status-Bars.md
(Waybar, AGS, Eww configurations)
->
docs/088-Useful-Utilities-Status-Bars.md
(Waybar、AGS、Eww配置)