dots-hyprland/README.md
2025-01-31 20:20:26 +01:00

159 lines
6.6 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=FFB1C8&logoColor=D9E0EE&labelColor=292324)
![](https://img.shields.io/github/stars/end-4/dots-hyprland?style=for-the-badge&logo=andela&color=FFB686&logoColor=D9E0EE&labelColor=292324)
[![](https://img.shields.io/github/repo-size/end-4/dots-hyprland?color=CAC992&label=SIZE&logo=googledrive&style=for-the-badge&logoColor=D9E0EE&labelColor=292324)](https://github.com/end-4/hyprland)
![](https://img.shields.io/badge/issues-skill-green?style=for-the-badge&color=CCE8E9&logoColor=D9E0EE&labelColor=292324)
</a>
</div>
<div align="center">
<h2>• overview •</h2>
<h3></h3>
</div>
<details>
<summary>Notable features</summary>
- **Overview widget**: shows open apps. Type to search/calculate/run
- **AI Assistant**: ChatGPT and Google Gemini
- **Autogenerated colors** based on your wallpaper using [Material colors](https://m3.material.io/styles/color/the-color-system/key-colors-tones)
- **Animations** that are natural and fluid
- **Transparent installation**: every command is shown before it's run
</details>
<details>
<summary>Instructions</summary>
- **Automatic**, but guided and transparent, installation for Arch(-based) Linux:
```bash
bash <(curl -s "https://end-4.github.io/dots-hyprland-wiki/setup.sh")
```
- **Manual** installation, other distros and more:
- See the [Wiki](https://end-4.github.io/dots-hyprland-wiki/en/i-i/01setup/)
- (_Available in: English, Vietnamese, and Simplified Chinese. Translations are welcome._)
- **Default keybinds**: Parts similar to Windows and GNOME. Hit Super+/ for a list.
<details>
<summary>Here's an image, just in case:</summary>
![image](https://github.com/end-4/dots-hyprland/assets/97237370/4c3d27b4-9ac5-4e55-9cae-c5c1f497890f)
</details>
</details>
<details>
<summary>Software overview</summary>
| Software | Purpose |
| ------------- | ------------- |
| [Hyprland](https://github.com/hyprwm/hyprland) | The compositor (for noobs, you can just call it a window manager) |
| [AGS](https://github.com/Aylur/ags) | A GTK widget system, responsible for the status bar, sidebars, etc. |
| [Fuzzel](https://mark.stosberg.com/fuzzel-a-great-dmenu-and-rofi-altenrative-for-wayland/) | For clipboard and emoji picker |
- For a more comprehensive list of dependencies, see [scriptdata/dependencies.conf](https://github.com/end-4/dots-hyprland/blob/main/scriptdata/dependencies.conf)
</details>
<details>
<summary>Help improve these dotfiles!</summary>
- Join the [discussions](https://github.com/end-4/dots-hyprland/discussions)
- If you'd like to suggest fixes or a new widget, feel free to [open an issue](https://github.com/end-4/dots-hyprland/issues/new/choose)
</details>
<div align="center">
<h2>• screenshots •</h2>
<h3></h3>
</div>
### Main branch (*illogical-impulse*)
**AI, on-screen indicators**
![image](https://github.com/end-4/dots-hyprland/assets/97237370/5e081770-0f1e-45c4-ad9c-3d19f488cd85)
**Fancy notifications, music controls, system, calendar**
![image](https://github.com/end-4/dots-hyprland/assets/97237370/406b72b6-fa38-4f0d-a6c4-4d7d5d5ddcb7)
<!-- ![image](https://github.com/end-4/dots-hyprland/assets/97237370/90c13b64-cde3-4363-9716-718d35845d95) -->
<!-- ![image](https://github.com/end-4/dots-hyprland/assets/97237370/9e7adedd-fae8-4cc8-9c81-d7ad489d7559) -->
**I suck at chemistry but it looks cool so...** <sub><sub><sub><sub><sub><sub>(the table was all ai generated anyway)</sub></sub></sub></sub></sub></sub>
![image](https://github.com/user-attachments/assets/aed031ec-b41a-4937-b9d3-b20542359a74)
**Weeb powers**
<!-- ![image](https://github.com/end-4/dots-hyprland/assets/97237370/98fe2c03-a128-45c0-8155-3a6080db3b84) -->
![image](https://github.com/end-4/dots-hyprland/assets/97237370/711f5475-93ca-4097-a960-8047acc85cc7)
**Easy window management**
<!--! ![image](https://github.com/end-4/dots-hyprland/assets/97237370/354431f6-8939-487f-9292-0bac71cf9ca8) -->
![image](https://github.com/end-4/dots-hyprland/assets/97237370/14e9725c-789f-4412-87b6-cce9504db109)
> [!WARNING]
> - Only the above is maintained
> - Stuff below:
> - Currently, they do NOT work (see [#99](https://github.com/end-4/dots-hyprland/issues/99))
> - The pics are here mainly for your viewing pleasure
> - The files are still available, feel free to grab them from the [`archive`](https://github.com/end-4/dots-hyprland/tree/archive) branch if you're willing to see some spaghetti and troubleshoot
- stuff below have showcase videos. click image to view.
### [m3ww](https://github.com/end-4/dots-hyprland/tree/archive)
<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](https://github.com/end-4/dots-hyprland/tree/archive)
<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](https://github.com/end-4/dots-hyprland/tree/archive)
<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](https://github.com/end-4/dots-hyprland/tree/archive)
<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 an actually good install script + many other stuff that I neglect
- [@midn8hustlr](https://github.com/midn8hustlr) for greatly improving the color generation system
- AGS: [Aylur's config](https://github.com/Aylur/dotfiles), [kotontrion's config](https://github.com/kotontrion/dotfiles)
- EWW: [fufexan's config](https://github.com/fufexan/dotfiles) (he thanks more people there btw)
- AI bots for providing useful examples
<div align="center">
<h2>• stonks •</h2>
<h3></h3>
</div>
- Funny useful number: https://github.com/sponsors/end-4
- Funny useless number:
[![Stargazers over time](https://starchart.cc/end-4/dots-hyprland.svg?variant=adaptive)](https://starchart.cc/end-4/dots-hyprland)
- *Jokes aside i do appreciate both*
<div align="center">
<h2>• inspirations •</h2>
<h3></h3>
</div>
- osu!lazer, Windows 11, Material Design 3, AvdanOS (concept)