Allow running multiple instances with different surface namespaces

README.md

@@ -118,8 +118,14 @@ $ wpaperctl toggle-pause
 ## Wallpaper Configuration
 
 The configuration file for *wpaperd* is located in `XDG_CONFIG_HOME/wpaperd/config.toml`
-(which defaults to `~/.config/wpaperd/config.toml`). Each section
-represents a different display and can contain the following keys:
+(which defaults to `~/.config/wpaperd/config.toml`).
+
+There are some top-level options for configuring general wpaperd behavior, and sections for configuring the wallpapers. The top-level options are:
+
+- `layer_namespace`, the prefix for the `wlr_layer_shell` layer surface's namespace. _Optional_, defaults to `wpaperd`
+- `socket_name`, the name used for the IPC socket. Can be specified in `wpaperctl` with the `-s` flag. _Optional_, defaults to `wpaperd`
+
+Each section represents a different display and can contain the following keys:
 
 - `path`, path to the image to use as wallpaper or to a directory to pick the wallpaper from
 - `duration`, how much time the image should be displayed until it is changed with a new one.

cli/src/main.rs

@@ -26,7 +26,7 @@ fn main() {
 
     let mut json_resp = false;
 
-    let mut conn = UnixStream::connect(socket_path().unwrap()).unwrap();
+    let mut conn = UnixStream::connect(socket_path(args.socket_name.as_deref()).unwrap()).unwrap();
     let msg = match args.subcmd {
         SubCmd::GetWallpaper { monitor } => IpcMessage::CurrentWallpaper {
             monitor: unquote(monitor),

cli/src/opts.rs

@@ -5,6 +5,8 @@ use clap::Parser;
 pub struct Opts {
     #[clap(subcommand)]
     pub subcmd: SubCmd,
+    #[clap(short, long)]
+    pub socket_name: Option<String>,
 }
 
 #[derive(clap::Subcommand)]

daemon/src/config.rs

@@ -283,6 +283,8 @@ impl SerializedWallpaperInfo {
 pub struct Config {
     #[serde(flatten)]
     data: HashMap<String, SerializedWallpaperInfo>,
+    pub layer_namespace: Option<String>,
+    pub socket_name: Option<String>,
     #[serde(skip)]
     default: SerializedWallpaperInfo,
     #[serde(skip)]

daemon/src/main.rs

@@ -159,6 +159,8 @@ fn run(opts: Opts, xdg_dirs: BaseDirectories) -> Result<()> {
         .wrap_err("Failed to insert the image loader listener into the event loop")?;
     let image_loader = Rc::new(RefCell::new(ImageLoader::new(image_loader_ping)));
 
+    let socket_name = config.socket_name.clone();
+
     let mut wpaperd = Wpaperd::new(
         &qh,
         &globals,
@@ -171,8 +173,10 @@ fn run(opts: Opts, xdg_dirs: BaseDirectories) -> Result<()> {
     .wrap_err("Failed to initiliaze wpaperd status")?;
 
     // Start listening on the IPC socket
-    let socket = listen_on_ipc_socket(&socket_path().wrap_err("Failed to locate wpaperd socket")?)
-        .wrap_err("Failed to listen to IPC socket")?;
+    let socket = listen_on_ipc_socket(
+        &socket_path(socket_name.as_deref()).wrap_err("Failed to locate wpaperd socket")?,
+    )
+    .wrap_err("Failed to listen to IPC socket")?;
 
     // Add source to calloop loop.
     event_loop

daemon/src/wpaperd.rs

@@ -204,7 +204,14 @@ impl OutputHandler for Wpaperd {
             qh,
             surface.clone(),
             Layer::Background,
-            Some(format!("wpaperd-{name}")),
+            Some(format!(
+                "{}-{name}",
+                self.config
+                    .layer_namespace
+                    .as_ref()
+                    .and_then(|s| Some(s.as_str()))
+                    .unwrap_or("wpaperd")
+            )),
             Some(&output),
         );
         layer.set_anchor(Anchor::TOP | Anchor::LEFT | Anchor::RIGHT | Anchor::BOTTOM);

ipc/src/lib.rs

@@ -36,7 +36,10 @@ pub enum IpcError {
     DrawErrors(Vec<(String, String)>),
 }
 
-pub fn socket_path() -> Result<PathBuf, BaseDirectoriesError> {
-    let xdg_dirs = BaseDirectories::with_prefix("wpaperd")?;
-    Ok(xdg_dirs.get_runtime_directory()?.join("wpaperd.sock"))
+pub fn socket_path(name: Option<&str>) -> Result<PathBuf, BaseDirectoriesError> {
+    let name = name.unwrap_or("wpaperd");
+    let xdg_dirs = BaseDirectories::with_prefix(name)?;
+    Ok(xdg_dirs
+        .get_runtime_directory()?
+        .join(format!("{name}.sock")))
 }

man/wpaperd-output.5.scd

@@ -30,8 +30,17 @@ $ hyprctl monitors
 ```
 
 The configuration file for *wpaperd* is located in `XDG_CONFIG_HOME/wpaperd/config.toml`
-(which defaults to `~/.config/wpaperd/config.toml`). Each section
-represents a different display and can contain the following keys:
+(which defaults to `~/.config/wpaperd/config.toml`).
+
+There are some top-level options for configuring general wpaperd behavior, and sections for
+configuring the wallpapers. The top-level options are:
+
+- `layer_namespace`, the prefix for the `wlr_layer_shell` layer surface's namespace.
+  _Optional_, defaults to `wpaperd`
+- `socket_name`, the name used for the IPC socket. Can be specified in `wpaperctl` with the
+  `-s` flag. _Optional_, defaults to `wpaperd`
+
+Each section represents a different display and can contain the following keys:
 
 - `path`, path to the image to use as wallpaper or to a directory to pick the wallpaper from
 - `duration`, how much time the image should be displayed until it is changed with a new one.