Skip to content

installation.md

Latest commit

 

History

History
103 lines (74 loc) · 2.41 KB

installation.md

File metadata and controls

103 lines (74 loc) · 2.41 KB

hypricer: Installation & Usage Guide

hypricer is a next-generation theme engine for Hyprland. It compiles themes into native code for maximum performance and instant responsiveness.

1. Prerequisites

Before installing, ensure you have the following dependencies:

  • Hyprland: (Obviously)
  • Rust & Cargo: Required to compile the themes. 
    curl --proto '=https' --tlsv1.2 -sSf [https://sh.rustup.rs](https://sh.rustup.rs) | sh
  • Common Tools: Most themes will rely on these (though strictly optional for the core engine):
    • playerctl (For music status)
    • swww or hyprpaper (For wallpapers)
    • jq (For parsing JSON data)

2. Installation

Step 1: Clone the Repository

Clone hypricer into your Hyprland config directory.

mkdir -p ~/.config/hypr
git clone [https://github.com/YourRepo/hypricer.git](https://github.com/YourRepo/hypricer.git) ~/.config/hypr/hypricer
cd ~/.config/hypr/hypricer

Step 2: Build the CLI Tool

Build the main hypricer management tool.

cargo build --release
# Optional: Add to PATH or symlink
sudo ln -s ~/.config/hypr/hypricer/target/release/hypricer /usr/local/bin/hypricer

3. Configuration

Step 1: Hook into Hyprland

Open your main hyprland.conf (usually ~/.config/hypr/hyprland.conf) and add this line at the top:

# Load the active hypricer session
source = ~/.config/hypr/hypricer/live/active_session.conf

Note: If the file doesn't exist yet, don't worry. The first build will create it.

Step 2: Select a Profile

hypricer comes with default profiles. List them and pick one.

# List available profiles
hypricer list profiles

# Example output:
# - default
# - minimal_work
# - gaming_rgb

4. Usage

Building & Applying a Theme

To compile and apply a theme, use the build command with a profile.

hypricer build --profile default

What happens next?

  1. hypricer reads the profile and the associated theme.
  2. It compiles a custom Daemon specifically for that theme.
  3. It starts the Daemon in the background.
  4. Your Hyprland config updates instantly.

Troubleshooting

If something isn't working (e.g., wallpaper isn't changing), check the live logs:

tail -f ~/.config/hypr/hypricer/live/daemon.log

5. Updates

To update hypricer itself:

cd ~/.config/hypr/hypricer
git pull
cargo build --release