63 lines
2.4 KiB
Markdown
63 lines
2.4 KiB
Markdown
# Installation Guide
|
|
|
|
Modus is a hackable shell for Hyprland built with Fabric. There are two primary ways to install it on Arch Linux.
|
|
|
|
## Automated Installation (Recommended)
|
|
|
|
> [!IMPORTANT]
|
|
> You need a working installation of Hyprland and knowledge of how it works. Ensure you are running this as a regular user (not root).
|
|
|
|
1. **Clone the Repository:**
|
|
```bash
|
|
git clone https://github.com/S4NKALP/Modus ~/.config/Modus
|
|
cd ~/.config/Modus
|
|
```
|
|
|
|
2. **Run the Installer Script:**
|
|
```bash
|
|
./install.sh
|
|
```
|
|
The interactive installer will check requirements, install missing dependencies via `paru`/`yay`, build the necessary C-extensions (like `libappcapture.so` and `libmenu_button_shim.so`), and configure your Hyprland environment automatically.
|
|
|
|
## Manual Installation
|
|
|
|
If you prefer to install dependencies and compile the extensions manually:
|
|
|
|
1. **Install Dependencies:**
|
|
```bash
|
|
paru -S uv fabric-cli-git uwsm cliphist slurp grim swappy wl-clipboard wtype libnotify playerctl matugen-bin hypridle hyprsunset hyprpicker hyprshot gtk-session-lock awww apple-fonts webp-pixbuf-loader cinnamon-desktop libmediaart acpi brightnessctl power-profiles-daemon ddcutil at-spi2-core networkmanager network-manager-applet blueman pipewire libpulse gcc make pkgconf meson ninja wayland-protocols gobject-introspection gtk-layer-shell librsvg libqalculate appmenu-gtk-module libdbusmenu-gtk3 libdbusmenu-qt5 pciutils wf-recorder ffmpeg --needed
|
|
```
|
|
|
|
2. **Clone and Sync:**
|
|
```bash
|
|
git clone https://github.com/S4NKALP/Modus ~/.config/Modus
|
|
cd ~/.config/Modus
|
|
uv sync
|
|
```
|
|
|
|
3. **Compile the App Switcher C-Backend:**
|
|
```bash
|
|
cd src/window/switcher/app-capture
|
|
meson setup builddir
|
|
meson compile -C builddir
|
|
cd ../../../..
|
|
```
|
|
|
|
4. **Compile the Global Menu Shim:**
|
|
```bash
|
|
cd src/window/globalmenu
|
|
gcc -shared -fPIC -O2 -o libmenu_button_shim.so libmenu_button_shim.c $(pkg-config --cflags --libs gtk+-3.0) -ldl
|
|
cd ../../..
|
|
```
|
|
|
|
5. **Start Modus:**
|
|
```bash
|
|
uv run start
|
|
```
|
|
|
|
> [!TIP]
|
|
> ### Post-Installation Recommendations
|
|
> - Install the recommended icon theme: [MacTahoe-icon-theme](https://github.com/vinceliuice/MacTahoe-icon-theme)
|
|
> - Install the recommended GTK theme: [MacTahoe-gtk-theme](https://github.com/vinceliuice/MacTahoe-gtk-theme)
|
|
> - Edit your Hyprland configuration file to source `~/.config/Modus/config/hypr/modus.lua` for the best compatibility.
|