Jump to content

Discord: Difference between revisions

From Official NixOS Wiki
Arborodin (talk | contribs)
No edit summary
Railwhale (talk | contribs)
m tidy syntax highlighting blocks
 
(One intermediate revision by the same user not shown)
Line 16: Line 16:
{{tip/unfree}}
{{tip/unfree}}


Nixpkgs provides all three of Discord's release channels: <code>pkgs.discord</code>, <code>pkgs.discord-ptb</code>, and <code>pkgs.discord-canary</code>. Add any of these packages in <code>environment.systemPackages</code> or <code>users.users.<name>.packages</code>.
Nixpkgs provides all three of Discord's release channels: {{nixos:package|discord}}, {{nixos:package|discord-ptb}}, and {{nixos:package|discord-canary}}. Add any of these packages in {{nixos:option|environment.systemPackages}} or <code>users.users.<name>.packages</code>
 
{{file|configuration.nix|nix|3=
{{file|configuration.nix|nix|3=
{ config, lib, pkgs, ... }: {
{ pkgs, ... }: {
  ...
   # This installs Discord only for the user "alice"
   # This installs Discord PTB only for the user "alice"
   users.users.alice.packages = with pkgs; [
   users.users.alice.packages = with pkgs; [
     discord-ptb
     discord
   ];
   ];
   # This will install Discord PTB for all users of the system
   # This will install Discord PTB for all users of the system
   environment.systemPackages = with pkgs; [
   environment.systemPackages = with pkgs; [
Line 36: Line 37:
Nixpkgs also provides a vast variety of community developed/modded Discord clients, which can usually serve as drop-in replacements for the official discord client with an extended set of features.
Nixpkgs also provides a vast variety of community developed/modded Discord clients, which can usually serve as drop-in replacements for the official discord client with an extended set of features.


'''Legcord<ref>https://github.com/Legcord/Legcord</ref>''' is a lightweight alternative desktop client featuring built-in modding extensibility via Vencord and Equicord. Provided via <code>pkgs.legcord</code>.
'''Legcord<ref>https://github.com/Legcord/Legcord</ref>''' is a lightweight alternative desktop client featuring built-in modding extensibility via Vencord and Equicord. Provided via {{nixos:package|legcord}}.


'''GoofCord<ref>https://github.com/Milkshiift/GoofCord</ref>''' is a security oriented fork of Legcord. Provided via <code>pkgs.goofcord</code>.
'''GoofCord<ref>https://github.com/Milkshiift/GoofCord</ref>''' is a security oriented fork of Legcord. Provided via {{nixos:package|goofcord}}.


'''BetterDiscord<ref>https://github.com/BetterDiscord/BetterDiscord</ref>''' enhances Discord desktop app with new features. Installer provided via <code>pkgs.betterdiscordctl</code>, but users may prefer to instead run it one-off via cli:
'''BetterDiscord<ref>https://github.com/BetterDiscord/BetterDiscord</ref>''' enhances Discord desktop app with new features. Installer provided via {{nixos:package|betterdiscordctl}}, but users may prefer to instead run it one-off via cli:
<syntaxhighlight lang=console>
 
<syntaxhighlight lang="console">
$ nix-shell -p betterdiscordctl --command 'betterdiscordctl install' # nix-legacy
$ nix-shell -p betterdiscordctl --command 'betterdiscordctl install' # nix-legacy
$ nix run nixpkgs#betterdiscordctl -- install # nix3
$ nix run nixpkgs#betterdiscordctl -- install # nix3
Line 49: Line 51:
</syntaxhighlight>
</syntaxhighlight>


'''OpenAsar<ref>https://github.com/GooseMod/OpenAsar</ref>''' is an open-source alternative to Discord's <code>app.asar</code>. Provided via <code>pkgs.openasar</code> without usable client. Users should instead prefer to override the official discord package and add <code>withOpenASAR = true</code>:
'''OpenAsar<ref>https://github.com/GooseMod/OpenAsar</ref>''' is an open-source alternative to Discord's <code>app.asar</code>. Provided via {{nixos:package|openasar}} without usable client. Users should instead prefer to override the official discord package and add <code>withOpenASAR = true</code>:
{{file|configuration.nix|nix|3=
 
{ config, lib, pkgs, ... }: {
<syntaxhighlight lang="nix">
   ...
(discord.override {
  environment.systemPackages = with pkgs; [
   withOpenASAR = true;
    (discord.override {
  #withVencord = true; # complementary
      withOpenASAR = true;
})
      # withVencord = true; # complementary
</syntaxhighlight>
    })
 
  ];
'''Vencord<ref>https://github.com/Vendicated/Vencord</ref>''', the cutest Discord client mod. Provided via {{nixos:package|vencord}}. Standalone can be installed by overriding the official Discord package via <code>withVencord = true</code>:
}
 
}}
<syntaxhighlight lang="nix">
(discord.override {
  #withOpenASAR = true; # complementary
  withVencord = true;
})
</syntaxhighlight>


'''Vencord<ref>https://github.com/Vendicated/Vencord</ref>''', the cutest Discord client mod. Provided via <code>pkgs.vencord</code>. Standalone can be installed by overriding the official Discord package via <code>withVencord = true</code>:
'''Vesktop<ref>https://github.com/Vencord/Vesktop</ref>''' is a customizable and privacy friendly desktop app by the developers of Discord's cutest client mod. Provided via {{nixos:package|vesktop}}. Can be configured in [[Home Manager]]:
{{file|configuration.nix|nix|3=
{ config, lib, pkgs, ... }: {
  ...
  environment.systemPackages = with pkgs; [
    (discord.override {
      # withOpenASAR = true; # complementary
      withVencord = true;
    })
  ];
}
}}


'''Vesktop<ref>https://github.com/Vencord/Vesktop</ref>''' is a customizable and privacy friendly desktop app by the developers of Discord's cutest client mod. Provided via <code>pkgs.vesktop</code>. Can be configured in [[Home Manager]]:
{{file|home.nix|nix|3=
{{file|home.nix|nix|3=
{ config, lib, pkgs, ... }: {
{ ... }: {
  ...
   programs.vesktop = {
   programs.vesktop = {
     enable = true;
     enable = true;
Line 96: Line 90:
}}
}}


'''Equicord<ref>https://github.com/equicord/equicord</ref>''', other cutest Discord client mod. Provided via <code>pkgs.equicord</code>.
'''Equicord<ref>https://github.com/equicord/equicord</ref>''', other cutest Discord client mod. Provided via {{nixos:package|equicord}}.


'''Equibop<ref>https://github.com/Equicord/equibop</ref>''', a Vesktop fork by Equicord developers. Provided via <code>pkgs.equibop</code>.
'''Equibop<ref>https://github.com/Equicord/equibop</ref>''', a Vesktop fork by Equicord developers. Provided via {{nixos:package|equibop}}.


'''Dissent<ref>https://github.com/diamondburned/dissent</ref>''' is a simple, practical Discord client prioritizing speed over feature completeness. Provided via <code>pkgs.dissent</code>.
'''Dissent<ref>https://github.com/diamondburned/dissent</ref>''' is a simple, practical Discord client prioritizing speed over feature completeness. Provided via {{nixos:package|dissent}}.


'''Discordo<ref>https://github.com/ayn2op/discordo</ref>''' is a TUI Discord client provided via <code>pkgs.discordo</code>. ''Development in progress, possible crashes and breaking changes.''
'''Discordo<ref>https://github.com/ayn2op/discordo</ref>''' is a TUI Discord client provided via {{nixos:package|discordo}}. ''Development in progress, possible crashes and breaking changes.''


'''Webcord<ref>https://github.com/SpacingBat3/WebCord</ref>''' is a Discord and [https://spacebar.chat/ Spacebar] client implemented without using official Discord API. Provided via <code>pkgs.webcord</code>.
'''Webcord<ref>https://github.com/SpacingBat3/WebCord</ref>''' is a Discord and [https://spacebar.chat/ Spacebar] client implemented without using official Discord API. Provided via {{nixos:package|webcord}}.


'''Ripcord<ref>https://cancel.fm/ripcord/</ref>''' is an unfree client for Discord and [https://slack.com/intl/ Slack] with a traditional compact interface for power users. Provided via <code>pkgs.ripcord</code>.
'''Ripcord<ref>https://cancel.fm/ripcord/</ref>''' is an unfree client for Discord and [https://slack.com/intl/ Slack] with a traditional compact interface for power users. Provided via {{nixos:package|ripcord}}.


== Troubleshooting ==
== Troubleshooting ==
Line 115: Line 109:


=== Notifications-related crash ===
=== Notifications-related crash ===
Discord will crash if there is no compatible notification daemon running. This issue is only prevalent in custom desktop environments, such as [[Sway]] or [[Hyprland]]. Comprehensive documentation usually exists for most window managers/compositors and can be found on their respective wikis. Nixpkgs provides a few standalone notification daemons such as <code>pkgs.dunst</code> and <code>pkgs.mako</code>. You may optionally use a notification daemon from a larger DE, such as <code>pkgs.lxqt.lxqt-notificationd</code>, however it is unclear how effective these will be outside of their normal environment.
Discord will crash if there is no compatible notification daemon running. This issue is only prevalent in custom desktop environments, such as [[Sway]] or [[Hyprland]]. Comprehensive documentation usually exists for most window managers/compositors and can be found on their respective wikis. Nixpkgs provides a few standalone notification daemons such as {{nixos:package|dunst}} and {{nixos:package|mako}}. You may optionally use a notification daemon from a larger DE, such as {{nixos:package|lxqt.lxqt-notificationd}}, however it is unclear how effective these will be outside of their normal environment.
 
{{file|configuration.nix|nix|3=
{{file|configuration.nix|nix|3=
{ config, lib, pkgs, ... }: {
{ pkgs, ... }: {
  ...
   # You will need to add a call for the daemon to actually function.
   # You will need to add a call for the daemon to actually function.
   # This is usually done within the configuration of your respective WM.
   # This is usually done within the configuration of your respective WM.
Line 146: Line 140:


One way to enable Krisp noise suppression is by patching the <code>discord_krisp.node</code> binary to bypass its DRM verification. Below is a Nix configuration that creates a Python script that patches the binary by modifying specific bytes to bypass the license check:
One way to enable Krisp noise suppression is by patching the <code>discord_krisp.node</code> binary to bypass its DRM verification. Below is a Nix configuration that creates a Python script that patches the binary by modifying specific bytes to bypass the license check:
<syntaxhighlight lang="nixos">
 
<syntaxhighlight lang="nix">
{ pkgs, ... }:
{ pkgs, ... }:
let
let
Line 181: Line 176:


After adding this to your Nix configuration and rebuilding, make sure Discord is completely closed, and then run:
After adding this to your Nix configuration and rebuilding, make sure Discord is completely closed, and then run:
<syntaxhighlight lang=console>
<syntaxhighlight lang="console">
$ krisp-patcher ~/.config/discord/0.0.76/modules/discord_krisp/discord_krisp.node
$ krisp-patcher ~/.config/discord/0.0.76/modules/discord_krisp/discord_krisp.node
</syntaxhighlight>
</syntaxhighlight>
Line 190: Line 185:
TTS is disabled by default; you may enable it via an override:
TTS is disabled by default; you may enable it via an override:
<syntaxhighlight lang="nix">
<syntaxhighlight lang="nix">
(pkgs.discord.override { withTTS = true; })
(pkgs.discord.override {
  withTTS = true;
})
</syntaxhighlight>
</syntaxhighlight>


=== Discord RPC not functioning ===
=== Discord RPC not functioning ===
Install '''arRPC'''<ref>https://github.com/OpenAsar/arrpc</ref>:
Install '''arRPC'''<ref>https://github.com/OpenAsar/arrpc</ref>:
{{file|configuration.nix|nix|3=
{{file|configuration.nix|nix|3=
{ pkgs, ... }: {
{ pkgs, ... }: {
  ...
   enviroment.systemPackages = with pkgs; [
   enviroment.systemPackages = with pkgs; [
     arrpc
     arrpc
Line 210: Line 207:
{{file|home.nix|nix|3=
{{file|home.nix|nix|3=
{ pkgs, ... }: {
{ pkgs, ... }: {
  ...
   services.arrpc = {
   services.arrpc = {
     enable = true;
     enable = true;
     package = pkgs.arrpc; # Default
     package = pkgs.arrpc; # Default
     systemdTarget = "graphical-session.target"; # default
     systemdTarget = "graphical-session.target"; # Default
   };
   };
}
}

Latest revision as of 20:51, 2 November 2026

Discord

instant messaging and VoIP social platform Application

100%
Developer(s)Discord Inc.
Platform(s)Cross-platform (Linux, macOS, Windows, Web)
External links
Websitehttps://discord.com/
GitHubdiscord

Discord is an instant messaging and VoIP application with lots of functionality. It provides a web interface, though most users would prefer to use a client for interoperability with their system.

Installation

Official Clients

🟆︎
Tip: This package is unfree, and will require extra steps to install. You can read more about allowing unfree software in the Nixpkgs Manual.

Nixpkgs provides all three of Discord's release channels: discord, discord-ptb, and discord-canary. Add any of these packages in environment.systemPackages or users.users.<name>.packages

❄︎ configuration.nix
{ pkgs, ... }: {
  # This installs Discord only for the user "alice"
  users.users.alice.packages = with pkgs; [
    discord
  ];

  # This will install Discord PTB for all users of the system
  environment.systemPackages = with pkgs; [
    discord-ptb
  ];
}

Unofficial Clients

⚠︎
Warning: Use of unofficial clients goes against Discord's TOS and possesses the risk of permanently suspending your account from the platform!

Nixpkgs also provides a vast variety of community developed/modded Discord clients, which can usually serve as drop-in replacements for the official discord client with an extended set of features.

Legcord[1] is a lightweight alternative desktop client featuring built-in modding extensibility via Vencord and Equicord. Provided via legcord.

GoofCord[2] is a security oriented fork of Legcord. Provided via goofcord.

BetterDiscord[3] enhances Discord desktop app with new features. Installer provided via betterdiscordctl, but users may prefer to instead run it one-off via cli:

$ nix-shell -p betterdiscordctl --command 'betterdiscordctl install' # nix-legacy
$ nix run nixpkgs#betterdiscordctl -- install # nix3

$ nix-shell -p betterdiscordctl --command 'betterdiscordctl self-upgrade' # nix-legacy
$ nix run nixpkgs#betterdiscordctl -- self-upgrade # nix3

OpenAsar[4] is an open-source alternative to Discord's app.asar. Provided via openasar without usable client. Users should instead prefer to override the official discord package and add withOpenASAR = true:

(discord.override {
  withOpenASAR = true;
  #withVencord = true; # complementary
})

Vencord[5], the cutest Discord client mod. Provided via vencord. Standalone can be installed by overriding the official Discord package via withVencord = true:

(discord.override {
  #withOpenASAR = true; # complementary
  withVencord = true;
})

Vesktop[6] is a customizable and privacy friendly desktop app by the developers of Discord's cutest client mod. Provided via vesktop. Can be configured in Home Manager:

❄︎ home.nix
{ ... }: {
  programs.vesktop = {
    enable = true;

    vencord.settings = {
      autoUpdate = true;
      autoUpdateNotification = true;
      notifyAboutUpdates = true;

      plugins = {
        ClearURLs.enabled = true;
        FixYoutubeEmbeds.enabled = true;
      };
    };
  };
}

Equicord[7], other cutest Discord client mod. Provided via equicord.

Equibop[8], a Vesktop fork by Equicord developers. Provided via equibop.

Dissent[9] is a simple, practical Discord client prioritizing speed over feature completeness. Provided via dissent.

Discordo[10] is a TUI Discord client provided via discordo. Development in progress, possible crashes and breaking changes.

Webcord[11] is a Discord and Spacebar client implemented without using official Discord API. Provided via webcord.

Ripcord[12] is an unfree client for Discord and Slack with a traditional compact interface for power users. Provided via ripcord.

Troubleshooting

Wayland screen sharing

Since December 2024, Discord Canary supports screen sharing on Wayland. Alternatively, you can use the web version on a browser that supports screen sharing on Wayland, or an unofficial client like Webcord or Vesktop, both of which have fixed this issue in their own ways.

Note: Remember to configure an XDG Desktop Portal with screen cast capabilities!

Discord will crash if there is no compatible notification daemon running. This issue is only prevalent in custom desktop environments, such as Sway or Hyprland. Comprehensive documentation usually exists for most window managers/compositors and can be found on their respective wikis. Nixpkgs provides a few standalone notification daemons such as dunst and mako. You may optionally use a notification daemon from a larger DE, such as lxqt.lxqt-notificationd, however it is unclear how effective these will be outside of their normal environment.

❄︎ configuration.nix
{ pkgs, ... }: {
  # You will need to add a call for the daemon to actually function.
  # This is usually done within the configuration of your respective WM.
  # See the official wiki/documentation for your WM for more info.
  environment.systemPackages = with pkgs; [
    mako
  ];
}

Start-up crash

Occasionally, Discord's code can become corrupted, causing it to crash on start-up. You can force it to re-download the latest version by deleting the ~/.config/discord/1.0.138directory, where 1.0.138 is replaced with Discord's current version number (the second line of output when running discord from a terminal).

"Must be your lucky day"

Although Nixpkgs is usually very fast with updates (if you use nixos-unstable), you may still run into this issue intermittently. You may override the discord package with a more up-to-date source, or you may disable this popup entirely by adding "SKIP_HOST_UPDATE": true to ~/.config/discord/settings.json:

≡︎ ~/.config/discord/settings.json
{
  "SKIP_HOST_UPDATE": true
}

Krisp noise suppression

The Krisp noise suppression option will not work on NixOS because the Discord binary is patched before installation, and there is a DRM-style integrity check in the Krisp binary which prevents Krisp from working if the Discord binary is modified. See https://github.com/NixOS/nixpkgs/issues/195512 for details.

Python script workaround

⚠︎
Warning: The usage of such modifications goes against Discord's Terms of Service and Krisp's Terms of Use and can result in your Discord account being terminated and/or being banned from using Krisp's services!

One way to enable Krisp noise suppression is by patching the discord_krisp.node binary to bypass its DRM verification. Below is a Nix configuration that creates a Python script that patches the binary by modifying specific bytes to bypass the license check:

{ pkgs, ... }:
let
  krisp-patcher =
    pkgs.writers.writePython3Bin "krisp-patcher"
      {
        libraries = with pkgs.python3Packages; [
          capstone
          pyelftools
        ];
        flakeIgnore = [
          "E501" # line too long (82 > 79 characters)
          "F403" # 'from module import *' used; unable to detect undefined names
          "F405" # name may be undefined, or defined from star imports: module
        ];
      }
      (
        builtins.readFile (
          pkgs.fetchurl {
            url = "https://pastebin.com/raw/8tQDsMVd";
            sha256 = "sha256-IdXv0MfRG1/1pAAwHLS2+1NESFEz2uXrbSdvU9OvdJ8=";
          }
        )
      );
in
{
  environment.systemPackages = [
    krisp-patcher
  ];
}
Note: As of version 0.0.76, the script works. But, future versions of Discord may break the script. Therefore, you should not rely on this script for long-term use. For the latest updates and more details, follow https://github.com/NixOS/nixpkgs/issues/195512.

After adding this to your Nix configuration and rebuilding, make sure Discord is completely closed, and then run:

$ krisp-patcher ~/.config/discord/0.0.76/modules/discord_krisp/discord_krisp.node

Once you restart Discord and join a VC, you should see a sound wave icon to the left of the hangup icon.

Text-to-Speech

TTS is disabled by default; you may enable it via an override:

(pkgs.discord.override {
  withTTS = true;
})

Discord RPC not functioning

Install arRPC[13]:

❄︎ configuration.nix
{ pkgs, ... }: {
  enviroment.systemPackages = with pkgs; [
    arrpc
  ];
  systemd.packages = with pkgs; [
    arrpc
  ];
}

Or add the following to your Home Manager configuration:

❄︎ home.nix
{ pkgs, ... }: {
  services.arrpc = {
    enable = true;
    package = pkgs.arrpc; # Default
    systemdTarget = "graphical-session.target"; # Default
  };
}