dots-hyprland/README.md

165 lines
7.2 KiB
Markdown

<div align="center">
<h1>【 end_4's Hyprland dotfiles 】</h1>
<h3></h3>
</div>
<div align="center">
![](https://img.shields.io/github/last-commit/end-4/dots-hyprland?&style=for-the-badge&color=8ad7eb&logo=git&logoColor=D9E0EE&labelColor=1E202B)
![](https://img.shields.io/github/stars/end-4/dots-hyprland?style=for-the-badge&logo=andela&color=86dbd7&logoColor=D9E0EE&labelColor=1E202B)
![](https://img.shields.io/github/repo-size/end-4/dots-hyprland?color=86dbce&label=SIZE&logo=protondrive&style=for-the-badge&logoColor=D9E0EE&labelColor=1E202B)
<a href="https://discord.gg/GtdRBXgMwq"> <img alt="Dynamic JSON Badge" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fdiscordapp.com%2Fapi%2Finvites%2FGtdRBXgMwq%3Fwith_counts%3Dtrue&query=approximate_member_count&style=for-the-badge&logo=discord&logoColor=D9E0EE&label=discord&labelColor=%231E202B&color=86dbc0&link=https%3A%2F%2Fdiscord.gg%2FGtdRBXgMwq"> </a>
</div>
<div align="center">
<h2>• overview •</h2>
<h3></h3>
</div>
<details>
<summary>Notable features</summary>
- **Overview**: Shows open apps with live previews. Type to search/calculate/run
- **AI**: Gemini API and Ollama models
- **Autogenerated colors**: Accessible and beautiful Material colors based on wallpaper
- **Transparent installation**: Every command is shown before it's run
</details>
<details>
<summary>Installation (illogical-impulse Quickshell)</summary>
- See the [Wiki](https://end-4.github.io/dots-hyprland-wiki/en/ii-qs/01setup/) <sub>(both install script and manual installation available)</sub>
- **Default keybinds**: Should be somewhat familiar to Windows or GNOME users. Important ones:
- `Super`+`/` = keybind list
- `Super`+`Enter` = terminal
- If for whatever reason the keybind list widget does not work, here's an image:
<img width="1412" height="828" alt="image" src="https://github.com/user-attachments/assets/8f7bd216-9e03-47e3-8709-0008772a4133" />
</details>
<details>
<summary>Software overview</summary>
| Software | Purpose |
| ------------- | ------------- |
| [Hyprland](https://github.com/hyprwm/hyprland) | The compositor (manages and renders windows) |
| [Quickshell](https://quickshell.outfoxxed.me/) | A QtQuick-based widget system, used for the status bar, sidebars, etc. |
- THERE IS NO WAYBAR
- For the full list of dependencies, see the [arch-packages folder](https://github.com/end-4/dots-hyprland/tree/main/arch-packages)
</details>
<details>
<summary>Discord</summary>
<a href="https://discord.gg/GtdRBXgMwq"> Server link </a> | I hope this provides a friendlier environment for support without needing me to personally accept every friend request/DM. For real issues, prefer GitHub
</details>
<div align="center">
<h2>• screenshots •</h2>
<h3></h3>
</div>
<table style="border-collapse: collapse;">
<tr>
<td width="25%">
<img src=".github/assets/illogical-impulse.svg" alt="illogical-impulse logo" style="float:left; width:100%;">
</td>
<td width="75%">
<i>latest and only style that I actively use. Other past styles are still there for your viewing pleasure and not actual use, but code is still available, see below.</i>
</td>
</tr>
</table>
### illogical-impulse<sup>Quickshell</sup>
Widget system: Quickshell | Support: Yes
[Showcase video](https://www.youtube.com/watch?v=RPwovTInagE)
| AI, settings app | Some widgets |
|:---|:---------------|
| <img width="1920" height="1080" alt="image" src="https://github.com/user-attachments/assets/22aa335a-0a23-4789-8ce9-c601b9f95858" /> | <img width="1920" height="1080" alt="image" src="https://github.com/user-attachments/assets/50009d7f-e456-4200-bc41-49b29abbafe3" /> |
| Window management | Weeb power |
| <img width="1920" height="1080" alt="image" src="https://github.com/user-attachments/assets/e77a7c96-1905-4126-a2a0-434f818825a2" /> | <img width="1920" height="1080" alt="image" src="https://github.com/user-attachments/assets/c8544e99-8881-477f-b83a-d6e35c0184a1" /> |
### illogical-impulse<sup>AGS</sup> <sub>(Deprecated)</sub>
Widget system: AGS | Support: No
| AI | Common widgets |
|:---|:---------------|
| ![image](https://github.com/user-attachments/assets/9d7af13f-89ef-470d-ba78-d2288b79cf60) | ![image](https://github.com/end-4/dots-hyprland/assets/97237370/406b72b6-fa38-4f0d-a6c4-4d7d5d5ddcb7) |
| Window management | Weeb power |
| ![image](https://github.com/user-attachments/assets/02983b9b-79ba-4c25-8717-90bef2357ae5) | ![image](https://github.com/user-attachments/assets/bbb332ec-962a-4e88-a95b-486d0bd8ce76) |
### Very old stuff
- Not likely to work, but the source is still available in the [`archive`](https://github.com/end-4/dots-hyprland/tree/archive) branch. Extremely spaghetti.
- Click image for a presentation video
#### m3ww
Widget system: EWW | Support: No, dead
<a href="https://streamable.com/85ch8x">
<img src="https://github.com/end-4/dots-hyprland/assets/97237370/09533e64-b6d7-47eb-a840-ee90c6776adf" alt="Material Eww!">
</a>
#### NovelKnock
Widget system: EWW | Support: No, dead
<a href="https://streamable.com/7vo61k">
<img src="https://github.com/end-4/dots-hyprland/assets/97237370/42903d03-bf6f-49d4-be7f-dd77e6cb389d" alt="Desktop Preview">
</a>
#### Hybrid
Widget system: EWW | Support: No, dead
<a href="https://streamable.com/4oogot">
<img src="https://github.com/end-4/dots-hyprland/assets/97237370/190deb1e-f6f5-46ce-8cf0-9b39944c079d" alt="click the circles!">
</a>
#### Windoes
Widget system: EWW | Support: No, dead
<a href="https://streamable.com/5qx614">
<img src="https://github.com/end-4/dots-hyprland/assets/97237370/b15317b1-f295-49f5-b90c-fb6328b8d886" alt="Desktop Preview">
</a>
<div align="center">
<h2>• thank you •</h2>
<h3></h3>
</div>
- [@clsty](https://github.com/clsty) for making the dotfiles accessible by taking care of the install script and many other things
- [@midn8hustlr](https://github.com/midn8hustlr) for greatly improving the color generation system
- [@outfoxxed](https://github.com/outfoxxed/) for being extremely supportive in my Quickshell journey
- Quickshell: [Soramane](https://github.com/caelestia-dots/shell/), [FridayFaerie](https://github.com/FridayFaerie/quickshell), [nydragon](https://github.com/nydragon/nysh)
- AGS: [Aylur](https://github.com/Aylur/dotfiles/tree/ags-pre-ts), [kotontrion](https://github.com/kotontrion/dotfiles)
- EWW: [fufexan](https://github.com/fufexan/dotfiles)
<div align="center">
<h2>• stonks •</h2>
<h3></h3>
</div>
- If you would like to give me some milk😳 (i dont drink coffee): https://github.com/sponsors/end-4
- Virtual tentacle cat website points chart
[![Stargazers over time](https://starchart.cc/end-4/dots-hyprland.svg?variant=adaptive)](https://starchart.cc/end-4/dots-hyprland)
<div align="center">
<h2>• inspirations/copying •</h2>
<h3></h3>
</div>
- Inspiration: osu!lazer, Windows 11, Material Design 3, AvdanOS (concept)
- Copying: The license allows you to. Personally I have absolutely no problem with others redistributing/recreating my work. There's no "stealing" (unless you do weird stuff and violate the license). <sub>(this note is here because some people actually asked)</sub>