Install Recar

Recar can be installed via several methods depending on your Linux distribution and preference.

Prepackaged Binaries

Debian, Ubuntu and their derivatives (eg; Linux Mint)

Debian based distribution can install Recar from the provided .deb file.

TODO, ADD RPM TARBALL AND STUFF TOO LAZY RN, OH AND ALSO LINKS TO THE DOWNLOADS RIGHT

Using Nix

Nix

If you’re using the Nix package manager (not NixOS):

Install to your profile
Run without installing

bash nix profile install github:hamhimdev/recar/main

bash nix run github:hamhimdev/recar/main

NixOS

A flake is provided that you can use to install the program on NixOS systems. Optionally, you can also add the system package directly in your configuration.nix. To do so you will need to define the Recar input in the file parameters.

With flake.nix
With configuration.nix

{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
    recar.url = "github:hamhimdev/recar/main";
    # If you prefer, you can replace this with Codeberg by using git+https://codeberg.org/Loxodrome/recar/main, however if you don't have proper ipv6 you might have trouble using this.
  };

  outputs = { self, nixpkgs, recar }: {
    nixosConfigurations.yourhostname = nixpkgs.lib.nixosSystem {
      system = "x86_64-linux";
      modules = [
        ./configuration.nix
        {
          environment.systemPackages = [
            recar.packages.x86_64-linux.default
          ];
        }
      ];
    };
  };
}

On the top:

{
  config,
  pkgs,
  recar,
  ...
}:

And then recar to your packages:

{
  environment.systemPackages = [
    recar.packages.\${pkgs.system}.default
    # ...
  ];
}

Then expose the recar flake to your configuration.nix:

{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
    recar.url = "github:hamhimdev/recar/main";
  };

  outputs = { self, nixpkgs, recar }: {
    nixosConfigurations.yourhostname = nixpkgs.lib.nixosSystem {
      system = "x86_64-linux";
      specialArgs = { inherit recar; }; # !!!
      modules = [ ./configuration.nix ];
    };
  };
}

Building from Source

To build Recar from source, you’ll need nodejs, pnpm, and git.

Clone the repository

The --recursive flag is very important as roverpp (Recar Overlay), dpprpc (Recar’s RPC Server), Equicord and Vencord are included as Git submodules.
Terminal window
```
git clone --recursive https://codeberg.org/Loxodrome/recar.git
cd recar
```
Install dependencies
Terminal window
```
pnpm install
```
Build client mods
Terminal window
```
pnpm build:mods
```

If installing optional components, they require other native dependencies

apt: Debian and its derivates (Mint, Ubuntu, Devuan)

# Update package lists
sudo apt update

# Mandatory
sudo apt install build-essential

# roverpp dependencies
sudo apt install vulkan-tools libvulkan-dev vulkan-validationlayers-dev glslang-tools python3

# dpprpc dependencies
sudo apt install libwebsockets-dev rapidjson-dev

dnf: Red Hat and its derivates (Fedora, CentOS, RHEL)

# Mandatory
sudo dnf groupinstall "Development Tools"

# roverpp dependencies
sudo dnf install vulkan-loader-devel vulkan-headers glslang python3

# dpprpc optional dependencies
sudo dnf install libwebsockets-devel rapidjson-devel

xbps: Void Linux

# Mandatory
sudo xbps-install -S base-devel

# roverpp dependencies
sudo xbps-install -S vulkan-loader-devel vulkan-headers glslang python3

# dpprpc dependencies
sudo xbps-install -S libwebsockets-devel rapidjson

Build dpprpc and dpprpc
Terminal window
```
pnpm build:projects
```

Launch or build Recar

# Starts the Electron runtime directly
pnpm start

# Builds .deb, .rpm, .AppImage and a .tar.gz tarball
pnpm build