🦆 arrpc-flake

A nixos-flake for the arRPC project.

This flake exposes the arrpc package and a home-manager module with a systemd service for your convenience.

Note

arRPC has been in nixpkgs as a package, and home-manager as a module for a while now. As such, this repository has been archived. You may remove this flake input entirely, and use arRPC that is in nixpkgs.

Usage

1. Add this repository to your inputs

# ...
inputs = {
  arrpc = {
    url = "github:notashelf/arrpc-flake";
    inputs.nixpkgs.follows = "nixpkgs";
  };
};
# ...

2. Reference the exposed package from the input

This set is optional if you intend to use the home-manager module.

Add the arRPC package to your packages to make it available in PATH.

# with home-manager
home.packages = [
  inputs.arrpc.packages.${pkgs.system}.arrpc # arrpc and default both refer to the same derivation
  # ...
];

3.a Use the home-manager module

We provide a home-manager module that does the heavy lifting for you.

{
  pkgs,
  lib,
  inputs,
  ...
}:
with lib; {
  imports = [
    inputs.arrpc.homeManagerModules.default
  ];

  config =  {
    home.packages = [
      pkgs.webcord-vencord # webcord with vencord extension installed
    ];

    # enable arRPC service, adds arRPC to home-packages and starts the systemd service for you
    services.arrpc.enable = true;
  };
}

3.b Start arRPC manually with a systemd service

If you prefer a more hands-on approach, you can use a systemd service to start arRPC automatically.

This is essentially what is done by the home-manager module behinds the scenes.

{lib, ...}:
let
  arRPC = inputs.arrpc.packages.${pkgs.system}.arrpc;
in {
  systemd.user.services = {
    arRPC = mkService {
      Unit.PartOf = ["graphical-session.target"];
      Unit.After = ["graphical-session.target"];
      Install.WantedBy = ["graphical-session.target"];

      Unit.Description = "Discord Rich Presence for browsers, and some custom clients";
        Service = {
            ExecStart = "${lib.getExe arRPC}";
            Restart = "always";
        };
      };
    };
  };
}

3.c Start arRPC from your window manager/compositor's auto-start line

Alternatively, if you are not a big fan of systemd services, you can auto-start arRPC from your wm/compositor's autostart section

# For Hyprland - requires arRPC to be in your environment.systemPackages or home.packages
exec-once = arRPC