hyprland-elite-desktop

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

hyprland-elite-desktop

★ 22 Open GitHub ↗

🚀 Modern Hyprland desktop environment with productivity tools - Pomodoro timer, TOTP authenticator, smart wallpapers, and seamless Chinese input support

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Hyprland Elite Desktop

![Hyprland Elite Desktop hero screenshot](https://raw.githubusercontent.com/laofahai/hyprland-elite-desktop/main/screenshots/hero-desktop.jpg)

Opinionated Hyprland dotfiles for a daily-driver Linux desktop. The repository keeps the shared defaults versioned, while personal settings live in ignored local override files so updates can be pulled safely.

[中文说明](README.zh-CN.md)

## Quick Install

```bash
git clone https://github.com/laofahai/hyprland-elite-desktop ~/dotfiles && cd ~/dotfiles && cp -n .env.example .env.local && ${EDITOR:-nano} .env.local && ./dotfiles.sh setup
```

`setup` is interactive. It links user-level config, creates backups, prepares local override files, and asks before optional system-level steps such as desktop file patches, font installation, or SDDM setup.

## What Is Included

Core desktop:

- Hyprland window manager
- Waybar status bar
- Kitty terminal
- Mako notifications
- Ulauncher
- Fcitx5 / Rime input method
- swww wallpaper scripts
- GTK / Qt / cursor defaults
- Lightweight native zsh defaults without an Oh My Zsh dependency

Productivity modules kept as first-class features:

- TOTP codes in Waybar
- Pomodoro timer in Waybar
- Health reminders
- ntfy desktop-to-phone notification forwarding
- Obsidian quick capture
- System monitor notifications

Optional integrations:

- SDDM theme helpers
- Feishu / WeChat / YouTube Music wrappers
- Browser notification bridge
- Thunderbird notification helper

## Supported Systems

| System | Status | Notes |
| --- | --- | --- |
| Arch Linux / Manjaro | Primary | Best package coverage |
| Debian / Ubuntu | Partial | Hyprland packages may require extra sources |
| Fedora | Partial | Package names may differ |

## Configuration Model

Do not edit tracked default files for machine-specific changes.

Tracked defaults live in the repository:

- `config/hypr/hyprland.conf`
- `config/waybar/style.css`
- `config/mako/config`
- `config/fcitx5-rime/*`
- `shell/zshrc`
- `scripts/*`

Local overrides are ignored by git:

- `.env.local`
- `~/.zshrc.local`
- `config/hypr/local.conf`
- `config/swww/local.conf`
- `config/waybar/local.css`
- `~/.config/mako/config.local`
- `~/.config/totp/secrets.conf`

`./dotfiles.sh setup` creates empty/local starter files where appropriate. This keeps `git pull` clean: repository defaults update normally, and personal settings stay outside git.

## Common Commands

```bash
./dotfiles.sh help          # show all commands
./dotfiles.sh setup         # interactive setup
./dotfiles.sh status        # check symlink and git status
./dotfiles.sh backup        # backup current config
./dotfiles.sh restore NAME  # restore a backup
./dotfiles.sh cleanup       # remove old backups and cache files
./dotfiles.sh input-method  # choose fcitx5/rime mode
```

Input method:

```bash
./scripts/install-fcitx5-rime.sh full
./scripts/test-fcitx5-rime.sh
./scripts/setup-rime-wanxiang.sh deploy
```

Productivity:

```bash
periodic-reminders.sh start
periodic-reminders.sh status
periodic-reminders.sh stop
```

## Rime Notes

The Rime setup uses `~/.local/share/fcitx5/rime` for runtime schemas and dictionaries. The Wanxiang installer preserves upstream directory structure because Wanxiang dictionaries depend on nested directories such as `zh_dicts`, `zh_dicts_pro`, `lua`, and `lookup`.

Use `./scripts/test-fcitx5-rime.sh` after changing input method files. If you need personal Rime patches, keep them in the runtime Rime directory rather than editing tracked defaults.

## Mako Notes

Hyprland starts notifications through `start-mako.sh`.

- Default config: `config/mako/config`
- Full local replacement: `~/.config/mako/config.local`

If `config.local` exists, `start-mako.sh` uses it. Otherwise it uses the repository default.

## Project Layout

```text
.
├── dotfiles.sh              # main setup / maintenance script
├── config/                  # tracked default app configs
│   ├── hypr/
│   ├── waybar/
│   ├── mako/
│   ├── fcitx5/
│   ├── fcitx5-rime/
│   └── ulauncher/
├── scripts/                 # desktop and productivity helpers
├── shell/                   # shell defaults and examples
├── docs/                    # detailed/reference documentation
├── README.md                # English
└── README.zh-CN.md          # Chinese
```

## Architecture Notes

Current shape:

- `dotfiles.sh` is the main entry point and still contains both user-level and optional system-level setup.
- `config/` contains defaults that are symlinked into `~/.config`.
- Runtime/private state is kept in home directories, not in git.
- Mako, Rime, TOTP, health reminders, and Pomodoro are retained because they are part of the intended desktop workflow.
- Shell frameworks and prompts are local choices. Use `~/.zshrc.local` for Starship, Oh My Zsh, Antidote, Zinit, or other plugin managers.

Known debt:

- `dotfiles.sh` is large and should eventually be split into smaller modules.
- Some older docs under `docs/` are historical references and may not reflect the current recommended path.
- Mako uses a full-file local override because it does not have the same include model as Hyprland or Waybar.

## Safety

- Review `.env.local` before running setup.
- Do not commit secrets, TOTP keys, local paths, or machine-specific overrides.
- System-level commands using `sudo` are optional and should be reviewed before accepting them.

## License

MIT

hyprland-elite-desktop

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README