sankalp
56ad44842e
- Updated README to use `uv run lock.py` for lock‑screen binding - Replaced pip install with `uv sync` and migrated to an uv‑managed Python virtual environment- Marked Installation Script and migration as completed in the TODO checklist
110 lines
4.3 KiB
Markdown
110 lines
4.3 KiB
Markdown
<p align="center">
|
||
<img src="assets/modus.png" height="200" alt="Logo">
|
||
</p>
|
||
|
||
<p align="center">
|
||
<sub><sup><img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Telegram-Animated-Emojis/main/Activity/Sparkles.webp" alt="Sparkles" width="25" height="25"/></sup></sub>
|
||
<a href="https://github.com/hyprwm/Hyprland">
|
||
<img src="https://img.shields.io/badge/A%20hackable%20shell%20for-Hyprland-0092CD?style=for-the-badge&logo=linux&color=0092CD&logoColor=D9E0EE&labelColor=000000" alt="A hackable shell for Hyprland">
|
||
</a>
|
||
<a href="https://github.com/Fabric-Development/fabric/">
|
||
<img src="https://img.shields.io/badge/Powered%20by-Fabric-FAFAFA?style=for-the-badge&logo=python&color=FAFAFA&logoColor=D9E0EE&labelColor=000000" alt="Powered by Fabric">
|
||
<sub><sup><img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Telegram-Animated-Emojis/main/Activity/Sparkles.webp" alt="Sparkles" width="25" height="25"/></sup></sub>
|
||
</a>
|
||
</p>
|
||
|
||
<div align="center">
|
||
|
||
[](https://github.com/S4NKALP/Modus/stargazers)
|
||
[](https://hyprland.org/)
|
||
[]()
|
||
[](https://discord.gg/tRFxkbQ3Zq)
|
||
|
||
</div>
|
||
|
||
<br>
|
||
|
||
<figure>
|
||
<h2>Home Screen:</h2>
|
||
<img src="assets/screenshots/home.png" alt="fabric">
|
||
<br/>
|
||
<h2>Lock Screen:</h2>
|
||
<img src="assets/screenshots/lock.png" alt="fabric">
|
||
</figure>
|
||
<br>
|
||
|
||
|
||
## Installation
|
||
|
||
> [!CAUTION]
|
||
> - You need a working installation of hyprland and knowledge of how it works
|
||
> - There may not be all packages in your system install them accordingly
|
||
|
||
```bash
|
||
git clone https://github.com/S4NKALP/Modus ~/.config/Modus
|
||
cd ~/.config/Modus
|
||
./install.sh
|
||
```
|
||
|
||
> [!TIP]
|
||
> ## Post Installation
|
||
> - Install recommended [Icon theme](https://github.com/vinceliuice/MacTahoe-icon-theme) , [GTK theme](https://github.com/vinceliuice/MacTahoe-gtk-theme) and [Cursor Theme](https://github.com/vinceliuice/MacTahoe-icon-theme/tree/main/cursors) <br>
|
||
> - Check `config/hypr/modus.conf` edit it according to your device and copy it to your hyprland config
|
||
> - For Lock Screen Bind keys to `uv run lock.py`
|
||
|
||
<h2><sub><img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel%20and%20places/Rocket.png" alt="Rocket" width="25" height="25" /></sub> Todo</h2>
|
||
|
||
## Manual Installation (WIP)
|
||
|
||
```bash
|
||
paru -S glace-git gtk-session-lock uv apple-fonts cinnamon-desktop --needed
|
||
git clone https://github.com/S4NKALP/Modus ~/.config/Modus
|
||
cd ~/.config/Modus
|
||
uv sync
|
||
uv run main.py
|
||
```
|
||
|
||
- [x] Launcher
|
||
- [x] Lock Screen
|
||
- [x] Dock
|
||
- [x] Notification
|
||
- [x] Control Center
|
||
- [x] Music Player
|
||
- [x] Desktop Widgets
|
||
- [x] New Launcher (like Spotlight)
|
||
- [ ] Settings
|
||
- [x] ~~Magnifier hover effect on Dock~~
|
||
- [x] ~~New Application Switcher~~
|
||
- [x] Panel Widget
|
||
- [x] MacOS like Widget
|
||
- [x] Expandable Notification Centre
|
||
- [x] Installation Script
|
||
- [x] Migrate to a `uv` managed Python virtual environment
|
||
- [ ] Proper Documentation
|
||
- [ ] Pomodoro Timer Widget
|
||
- [x] To-do List Widget
|
||
|
||
## Bug Fixes (the bug found till now)
|
||
|
||
- [x] WiFi
|
||
- [x] wifi off button looks bigger
|
||
- [x] Metadata Changes delay in Media Player
|
||
- [x] Active Window Title showing `Unknown` when no active window
|
||
- [x] Notification Escape Char Issue
|
||
|
||
## Team
|
||
|
||
- [SANKALP](https://github.com/S4NKALP/)
|
||
- [tr1x_em](https://github.com/tr1xem)
|
||
|
||
## Special Thanks
|
||
|
||
A big thank you to the following people for their incredible help with code and creative ideas. Your help made a real difference!
|
||
|
||
- [darsh](https://github.com/its-darsh): for creating Fabric, which made everything possible.
|
||
- [gummy bear album](https://github.com/muhchaudhary): for sharing fantastic code snippets that saved me time and effort.
|
||
- [axenide](https://github.com/Axenide): for the amazing config that not only inspired parts of mine but also provided some gems I couldn’t resist borrowing.
|
||
- [E3nviction](https://github.com/E3nviction/): for code snippets and ideas that were incredibly helpful.
|
||
|
||
I truly appreciate your support
|