tpaau/shell

My custom desktop shell made with Quickshell for Niri.

Warning

This project is early development, and I do not provide an installation method yet. You can still try it though!

If you want to get updates on the state of the project, and to let me know that you do want to see this shell released, consider starring this repo!

Table of contents

• Screenshots
• Features
• Dependencies
• Try it
• Roadmap to alpha
• FAQ
  • Why isn't Hyprland supported?
  • What window managers are supported?
• Credit
  • Other software

Screenshots

That's what you're here for, right?

Frieren	Rain Worl
Application launcher	Lock screen

Features

• Material design
• Matugen color generation
• Shell modules
  • Status bar
  • Notification service with cross-session persistence
  • Quick settings
  • Application launcher
  • Session lock with multiple authentication methods
  • Session management
• Support for the Niri compositor

Dependencies

• Niri
• Quickshell
• swayidle (to be removed)
• swaylock (to be removed)
• matugen
• UPower daemon
  • Power profiles daemon

Try it

While I do not provide an installation method just yet, you can still try the shell!

1. Clone the repo

git clone https://github.com/tpaau/shell
cd shell

2. Install the required dependencies

• You will also need cargo and optionally just
• swaylock is not a required dependency if you're just testing things out

3. Run the shell

Warning

The shell will mess with Niri config files in ~/.config/niri, so please make sure to back them up.

Run just run-dev, or copy the list of commands from the justfile and run them manually.

Note

The shell will create its data, config, and cache directories:

• ~/.local/share/tpaau-shell/
• ~/.config/tpaau-shell/
• ~/.cache/tpaau-shell/

You can easily remove them with just rm-shell-dirs.

Roadmap to alpha (subject to change)

• Add support for Sway/SwayFX
• Add the settings app
• Implement the setup screen
• Create packages for Fedora and Arch
• Add a custom polkit agent
• Bluetooth and network settings
• Add dock

FAQ

Why isn't Hyprland supported?

Hyprland has really bad code quality, questionable security practices, and often crashes when ran under hardened_malloc.

What window managers are supported?

The only compositor currently supported is Niri, but Sway/SwayFX support will be added in the future.

Credit

My dots would be worthless without the amazing software they are made for! Give the devs of these projects a big thanks!

• Quickshell
• Niri

Other software

• Depth Anything - Image depth generator
• just - Just a command runner