anny-dock

A modern, animated dock for Hyprland built with Rust and Bevy Engine. Currently exclusive to Hyprland, with plans to support other window managers in the future.

Note: This is my first Rust project! While I'm committed to writing clean and efficient code, I'm also learning along the way. Feedback and suggestions are greatly appreciated as I explore Rust's capabilities and best practices.

Features • Installation • Usage • Configuration • Contributing

Features

Smooth Animations

• 🎯 Intelligent hover effects with smooth transitions
• 🔄 Natural diagonal scrolling behavior (now with configurable inclination)
• ✨ Frame-rate independent animations
• 🎨 Subtle scale transformations

Smart Icon Management

• 📱 Dynamic icon loading and scaling
• 🔍 Automatic icon discovery from running applications
• 📌 Pinnable favorite applications
• 🎯 Precise icon positioning with smooth reordering

Hyprland Integration

• 🖥️ Seamless Hyprland window management
• 🚀 Native Hyprland client detection
• 🎨 Transparent background support
• 🔗 Direct window focusing and management

Modern Interface

• 🖼️ Transparent background support
• 🎨 High-quality SVG icon rendering
• 📐 Configurable dock size and position
• 🔲 Clean, minimal design

Performance

• ⚡ Hardware-accelerated rendering
• 🎮 Optimized animation system
• 🔄 Efficient state management
• 📊 Low resource usage

Requirements

• Hyprland
• Rust 1.75+

Installation

# Clone the repository
git clone https://github.com/horberlan/anny-dock.git

# Enter the directory
cd anny-dock

# Build the project
cargo build --release

# Run anny-dock
cargo run --release

Usage

Basic Controls

• Scroll: Navigate through icons
• Left Click: Launch/Focus application
• Right Click: Pin/Unpin application
• T: Toggle application titles
• Q/Esc: Close application
• 1..8: Launch/Focus visible applications
• Arrow Keys (←/→): Scroll the dock left and right
• Drag & Drop: Reorder icons

Configuration

anny-dock's configuration can be customized through a TOML file located at ~/.config/anny-dock/config.toml. The configuration system includes:

[config]
visible_items = 8        # Number of items visible in the list           
margin_x = 85.0          # Horizontal margin from screen edge
margin_y = 50.0          # Vertical margin from screen edge
spacing = 40.0           # Space between icons
z_spacing = 2.0          # Depth spacing for 3D effect
base_scale = 1.2         # Base icon scale
scale_factor = 0.9       # Scale factor for animations
scroll_speed = 15.0      # Scroll sensitivity
tilt_y = 0.25            # Inclination factor (0.0 = horizontal, 0.5 = strong diagonal)
icon_size = 56.0         # Base size of icons

Configuration File Location

• Default location: ~/.config/anny-dock/config.toml
• The file will be created automatically on first run if it doesn't exist
• All values are optional - missing values will use defaults
• Changes take effect immediately after saving

Configuration Organization

• All configuration options are now centralized in the Config struct
• Configuration values are loaded from a dedicated module
• Default values are more clearly defined and easier to modify
• Configuration is now more modular and easier to extend

Dock Inclination (tilt_y)

• The tilt_y field controls the inclination of the dock towards the center of the screen.
• Example: tilt_y: 0.25 makes the dock point to a spot 25% of the screen height above the center.
• Adjust this value to customize the dock's angle to your visual preference.

Architecture

anny-dock is built using a modern ECS architecture with Bevy:

Core Systems

• Animation System
• Hover System
• Scroll System (diagonal, inclination configurable)
• Icon Management
• Hyprland Integration
• Event Handling

Components

• HoverTarget: Manages hover states and animations
• ClientIcon: Handles icon rendering and scaling
• ScrollState: Controls scroll behavior
• DockConfig: Manages dock configuration

Roadmap

Current

• Hyprland support
• Basic animation system
• Icon management
• Favorite applications
• Scroll using keyboard arrows

Planned

• Configuration file
• Migrate to hyprland layer
• Custom themes
• Multi-monitor support
• Support for other window managers

Development

Prerequisites

• Rust 1.75+
• Bevy dependencies
• Hyprland

Building from Source

# Debug build
cargo build

# Release build
cargo build --release

# Run tests
cargo test

Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

As this is my first Rust project, I'm particularly open to:

• Code reviews and best practices suggestions
• Rust idioms and patterns recommendations
• Performance optimization tips
• Architecture improvement ideas

Development Process

1. Fork the repository
2. Create your feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Bevy Engine for the UI
• Hyprland for the window manager integration
• bevy_svg for SVG rendering
• xdg-utils for desktop integration