Files
colorshell/README.md
T
2025-05-08 14:01:08 -03:00

130 lines
5.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# colorshell
<p>(previously retrozinndev/Hyprland-Dots)</p>
> [!note]
> This is a WIP Aylur's GTK Shell version of my dotfiles! Everything at the moment in<br>
> this shell is working flawlessly, you can try it out if you want to! <br> <br>
> Want the stable dotfiles? Go to the [`ryo`](https://github.com/retrozinndev/Hyprland-Dots/tree/ryo) branch! <br>
My Hyprland desktop shell that I keep improving almost everyday! 🤩 (i love doing this) <br>
This repository includes a desktop shell made with [GTK], using [Astal] and [AGS] + [TypeScript].
It really took me a lot of time to make this, so please star the repo if you like it! :star:
### ✔️ What's included in this shell
- Pretty Top-Bar
- Apps button(basically the "start menu", opens the full-screen app launcher)
- Workspace indicator(contains icon of last used application on each)
- Focused Client(Window) information(title, class and icon)
- Clock(with date)
- Media(shows only when media is being played)
- Tray(Applications running in the background)
- Status (volume information, bluetooth, network and notification status)
- Control Center
- Volume Controls (Microphone and Speaker)
- Volume Mixer(per-app volume)
- Pages(the thing that shows up when you click the arrow on a tile)
- Bluetooth devices
- Network devices
- Night Light controls
- Tiles
- Screen Recording
- Bluetooth
- Night Light
- Network(wifi needs work, i don't have wifi in my machine)
- Don't Disturb(disables notification popups)
- Center Window(clock, calendar + media management)
- Notifications with support for application actions + Notification History
- Localization(see [🌐 Internationalization](#-internationalization) for available languages)
- Application Runner with support for plugins ([anyrun](https://github.com/anyrun-org/anyrun)-like)
- Shell(`!`): Run shell commands with the user shell
- Media(`:`): Control playing media
- Search(`?`): Search something on the internet with your default browser
- Gnome-like application runner(the fullscreen one)
- Support for your multiple monitors
## 🔘 TODO
Almost everything is done!! I'm just doing some polishing:
- Stop using anyrun(make plugins for the **shell's runner**)
- Make a Clipboard plugin (ongoing)
## 🌄 Screenshots
![Kitty](repo/shots/desktop.png)
![Widgets](repo/shots/widgets.png)
![Runner](repo/shots/runner.png)
![Browser + Neovim](repo/shots/browser-neovim.png)
## 🎨 Colors
All the colors of the interface are dynamically generated from your wallpaper!
This is possible by using [pywal16] (fork of pywal), a cli tool to generate color schemes on the fly.
## 🖼️ Wallpapers
When you're at the [Installation](#Installation) process, you can choose whether to install the wallpapers.
Or if you haven't, you can just create a directory `~/wallpapers` in your home `~` and put images you want to use as wallpapers!
You can select any of the images inside `~/wallpapers` by pressing <kbd>SUPER</kbd> + <kbd>W</kbd> or by accessing the
Control Center and clicking in the image icon on top.
### ️ Source
All wallpapers inside this repo are not made by me! You can find all sources inside the [`WALLPAPERS.md`](https://github.com/retrozinndev/Hyprland-Dots/blob/ryo/WALLPAPERS.md) file.
## ⌨️ Binds
You can see pre-configured bindings in the [Wiki/Bindings] page!
## 🌐 Internationalization
This Shell supports i18n. Currently, it supports the following languages:
- English (United States), maintained by [@retrozinndev](https://github.com/retrozinndev)
- Português (Brasil), maintained by [@retrozinndev](https://github.com/retrozinndev)
Don't see your language here? You can contribute and make translations too! <br>
To do so, fork this repository, translate your fork, then open a pull request to this repository, simple as that!
## ⚙️ Installation
See the Installation Guide on [Wiki/Installation].
## 🎉 Tools
- Browser: [Zen Browser]
- Text Editor: [Neovim], my config is [here](https://github.com/retrozinndev/nvim-conf.lua)
- Terminal Emulator: [Kitty]
- Shell: [Nushell]
- See more on the [wiki]!
## ❗ Issues
Having issues? Please create a [new Issue] here, I'll be happy to help you out!
## 📜 License
This repo is licensed under the [MIT License], project is made and maintained by [retrozinndev](https://github.com/retrozinndev).
## 🌠 Stargazers
Thanks to everyone who starred my project! 💖
[![Stargazers over time](
https://starchart.cc/retrozinndev/Hyprland-Dots.svg?background=%2324292e&axis=%23fafbfc&line=%232dba4e
)](https://starchart.cc/retrozinndev/Hyprland-Dots)
<!-- References of other projects -->
[pywal16]: https://github.com/eylles/pywal16
[zen browser]: https://zen-browser.app
[neovim]: https://neovim.io
[nushell]: https://nushell.sh
[kitty]: https://sw.kovidgoyal.net/kitty
[ags]: https://aylur.github.io/ags
[astal]: https://aylur.github.io/astal
[typescript]: https://typescriptlang.org
[gtk]: https://www.gtk.org
<!-- Web refs -->
[mit license]: https://en.wikipedia.org/wiki/MIT_License
<!-- Tabs -->
[wiki]: https://github.com/retrozinndev/Hyprland-Dots/wiki
[issues]: https://github.com/retrozinndev/Hyprland-Dots/issues
<!-- Wiki Pages -->
[wiki/dependencies]: https://github.com/retrozinndev/Hyprland-Dots/wiki/Dependencies
[wiki/usage]: https://github.com/retrozinndev/Hyprland-Dots/wiki/Usage
[wiki/installation]: https://github.com/retrozinndev/Hyprland-Dots/wiki/Installation
[wiki/bindings]: https://github.com/retrozinndev/Hyprland-Dots/wiki/Bindings
<!-- Actions -->
[new issue]: https://github.com/retrozinndev/Hyprland-Dots/issues/new