# Hyprland-rs
[](https://crates.io/crates/hyprland)
[](https://www.gnu.org/licenses/gpl-3.0.html)
[](https://docs.rs/hyprland)
[](https://github.com/hyprwm/Hyprland)
A unoffical rust wrapper for Hyprland's IPC
## Disclaimer
If something doesn't work, doesn't matter what,
make sure you are on the latest commit of Hyprland before making an issue!
## Getting started!
Lets get started with Hyprland-rs!
### Adding to your project
Add the code below to the dependencies section of your Cargo.toml file!
```toml
hyprland = "0.2.4"
```
### What this crate provides
This crate provides 3 modules (+1 for shared things)
- `data` for getting information on the compositor
- `event_listener` which provides the EventListener struct for listening for events
- `dispatch` for calling dispatchers and changing keywords
## Example Usage
here is an example of most of the provided features being utilized
```rust ,no_run
use hyprland::data::blocking::get_monitors;
use hyprland::dispatch::{dispatch_blocking, Corner, DispatchType};
use hyprland::event_listener::EventListener;
fn main() -> std::io::Result<()> {
// We can call dispatchers with the dispatch function!
// Here we are telling hyprland to open kitty!
dispatch_blocking(DispatchType::Exec("kitty".to_string()))?;
// Here we are moving the cursor to the top left corner!
dispatch_blocking(DispatchType::MoveCursorToCorner(Corner::TopLeft))?;
// Here we change a keyword, yes its a dispatcher don't complain
dispatch_blocking(DispatchType::Keyword(
"general:border_size".to_string(),
"30".to_string(),
))?;
// get all monitors
let monitors = get_monitors();
// and printing them all out!
println!("{monitors:#?}");
// Create a event listener
let mut event_listener = EventListener::new();
// add event, yes functions and closures both work!
event_listener.add_workspace_change_handler(|id| println!("workspace changed to {id:#?}"));
// and execute the function
// here we are using the blocking variant
// but there is a async version too
event_listener.start_listener_blocking()
}
```