Discord: Difference between revisions

(41 intermediate revisions by 24 users not shown)

Line 1:

~~{{unfree}}~~

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.

~~== Install ==~~

~~To install discord directly in your environment without changing any configuration:~~

== Installation ==

=== Official Clients ===

$ nix-~~env~~ -~~i discord~~ --~~arg~~ config '{ ~~allowUnfree~~ = true; }'

Nixpkgs provides all three of Discord's release channels, accessible as <code>pkgs.discord</code>, <code>pkgs.discord-ptb</code>, and <code>pkgs.discord-canary</code> respectively. Add any of the previous derivations to your package's configuration. For [[NixOS]] this will be in <code>environment.systemPackages</code> or <code>users.users.<name>.packages</code>.<syntaxhighlight lang="nixos">

# configuration.nix

{ config, lib, pkgs, ... }: {

# This will install Discord PTB for all users of the system

environment.systemPackages = with pkgs; [

discord-ptb

];

# This installs Discord PTB only for the user "alice"

users.users.alice.packages = with pkgs; [

discord-ptb

];

}

</syntaxhighlight>

=== Unofficial Clients ===

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.

{{Warning|The usage of such client's goes against Discord's [https://discord.com/terms TOS], and can result in your account being permanently suspended from the platform!}}

==== Legcord (formerly ArmCord)<ref>https://github.com/Legcord/Legcord</ref> ====

Lightweight, alternative desktop client with built-in modding extensibility. Nixpkgs provides this client via <code>pkgs.legcord</code>.<syntaxhighlight lang="nixos">

{ config, lib, pkgs, ... }: {

environment.systemPackages = with pkgs; [

legcord

];

}

</syntaxhighlight>

==== BetterDiscord<ref>https://betterdiscord.app/</ref> ====

Enhances Discord desktop app with new features. Nixpkgs provides the installer via <code>pkgs.betterdiscordctl</code>. This can be added to your configuration, though users may prefer to instead run it one-off via the [[Nix]] cli.<syntaxhighlight lang="bash">

$ 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

</syntaxhighlight>

==== OpenAsar<ref>https://github.com/GooseMod/OpenAsar</ref> ====

Open-source alternative to Discord's <code>app.asar</code>. Nixpkgs provides this via <code>pkgs.openasar</code>, though this doesn't provide a usable client. Users should instead prefer overriding the official discord package and add <code>withOpenASAR = true</code>.<syntaxhighlight lang="nixos">

{ config, lib, pkgs, ... }: {

environment.systemPackages = with pkgs; [

(discord.override {

withOpenASAR = true;

# withVencord = true; # can do this here too

})

];

}

</syntaxhighlight>

== ~~Usage~~ ==

==== Vencord<ref>https://vencord.dev/</ref> ====

~~Command Line~~:

The cutest Discord client mod. Nixpkgs provides their custom client [https://github.com/Vencord/Vesktop Vesktop] via<code>pkgs.vesktop</code>, or as an override for the official discord package via <code>withVencord = true</code>.<syntaxhighlight lang="nixos">

{ config, lib, pkgs, ... }: {

environment.systemPackages = with pkgs; [

# vesktop # If you prefer this

(discord.override {

# withOpenASAR = true; # can do this here too

withVencord = true;

})

];

}

</syntaxhighlight>

==== Webcord<ref>https://github.com/SpacingBat3/WebCord</ref> ====

~~$ Discord~~

Discord and [https://spacebar.chat/ Spacebar] client implemented without using the official Discord API. Nixpkgs provides this client via <code>pkgs.webcord</code>.<syntaxhighlight lang="nixos">

{ config, lib, pkgs, ... }: {

environment.systemPackages = with pkgs; [

webcord

];

}

</syntaxhighlight>

~~The nix expression also installs a desktop item as another option for starting the application.~~

== Troubleshooting ==

== ~~Links~~ ==

=== Screen sharing on Wayland ===

[https://github.com/NixOS/nixpkgs/~~blob~~/~~master~~/pkgs/~~applications~~/~~networking~~/~~instant~~-~~messengers~~/discord/default.nix ~~default~~.~~nix for~~ discord]

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 [[Discord#Unofficial Clients|unofficial client]] like ''Webcord'' or ''Vesktop'', both of which have fixed this issue in their own ways.

{{Note|Remember to configure an [https://wiki.archlinux.org/title/XDG_Desktop_Portal#List_of_backends_and_interfaces XDG Desktop Portal] with screen cast capabilities!}}

=== Notifications causing crashes ===

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.<syntaxhighlight lang="nixos">

{ config, lib, 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

];

}

</syntaxhighlight>

=== "Must be your lucky day" popup ===

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 <code>"SKIP_HOST_UPDATE": true</code> to <code>~/.config/discord/settings.json</code>.

{{File|~/.config/discord/settings.json|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 [https://discord.com/terms Terms of Service] and Krisp's [https://krisp.ai/terms-of-use/ 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 <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">{ 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

];

}

</syntaxhighlight>

{{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:

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

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; })

</syntaxhighlight>

[[Category:Applications]]

[[Category:Gaming]]

@@ Line 1: / Line 1: @@
-{{unfree}}
+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.
-== Install ==
-To install discord directly in your environment without changing any configuration:
+== Installation ==
+{{Unfree}}
-<syntaxhighlight lang="console">
+=== Official Clients ===
-$ nix-env -i discord --arg config '{ allowUnfree = true; }'
+Nixpkgs provides all three of Discord's release channels, accessible as <code>pkgs.discord</code>, <code>pkgs.discord-ptb</code>, and <code>pkgs.discord-canary</code> respectively. Add any of the previous derivations to your package's configuration. For [[NixOS]] this will be in <code>environment.systemPackages</code> or <code>users.users.<name>.packages</code>.<syntaxhighlight lang="nixos">
+# configuration.nix
+{ config, lib, pkgs, ... }: {
+  # This will install Discord PTB for all users of the system
+  environment.systemPackages = with pkgs; [
+    discord-ptb
+  ];
+  # This installs Discord PTB only for the user "alice"
+  users.users.alice.packages = with pkgs; [
+    discord-ptb
+  ];
+}
+</syntaxhighlight>
+=== Unofficial Clients ===
+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.
+{{Warning|The usage of such client's goes against Discord's [https://discord.com/terms TOS], and can result in your account being permanently suspended from the platform!}}
+==== Legcord (formerly ArmCord)<ref>https://github.com/Legcord/Legcord</ref> ====
+Lightweight, alternative desktop client with built-in modding extensibility. Nixpkgs provides this client via <code>pkgs.legcord</code>.<syntaxhighlight lang="nixos">
+{ config, lib, pkgs, ... }: {
+  environment.systemPackages = with pkgs; [
+    legcord
+  ];
+}
+</syntaxhighlight>
+==== BetterDiscord<ref>https://betterdiscord.app/</ref> ====
+Enhances Discord desktop app with new features. Nixpkgs provides the installer via <code>pkgs.betterdiscordctl</code>. This can be added to your configuration, though users may prefer to instead run it one-off via the [[Nix]] cli.<syntaxhighlight lang="bash">
+$ 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
+</syntaxhighlight>
+==== OpenAsar<ref>https://github.com/GooseMod/OpenAsar</ref> ====
+Open-source alternative to Discord's <code>app.asar</code>. Nixpkgs provides this via <code>pkgs.openasar</code>, though this doesn't provide a usable client. Users should instead prefer overriding the official discord package and add <code>withOpenASAR = true</code>.<syntaxhighlight lang="nixos">
+{ config, lib, pkgs, ... }: {
+  environment.systemPackages = with pkgs; [
+    (discord.override {
+      withOpenASAR = true;
+      # withVencord = true; # can do this here too
+    })
+  ];
+}
 </syntaxhighlight>
-== Usage ==
+==== Vencord<ref>https://vencord.dev/</ref> ====
-Command Line:
+The cutest Discord client mod. Nixpkgs provides their custom client [https://github.com/Vencord/Vesktop Vesktop] via<code>pkgs.vesktop</code>, or as an override for the official discord package via <code>withVencord = true</code>.<syntaxhighlight lang="nixos">
+{ config, lib, pkgs, ... }: {
+  environment.systemPackages = with pkgs; [
+    # vesktop # If you prefer this
+    (discord.override {
+      # withOpenASAR = true; # can do this here too
+      withVencord = true;
+    })
+  ];
+}
+</syntaxhighlight>
-<syntaxhighlight lang="console">
+==== Webcord<ref>https://github.com/SpacingBat3/WebCord</ref> ====
-$ Discord
+Discord and [https://spacebar.chat/ Spacebar] client implemented without using the official Discord API. Nixpkgs provides this client via <code>pkgs.webcord</code>.<syntaxhighlight lang="nixos">
+{ config, lib, pkgs, ... }: {
+  environment.systemPackages = with pkgs; [
+    webcord
+  ];
+}
 </syntaxhighlight>
-The nix expression also installs a desktop item as another option for starting the application.
+== Troubleshooting ==
-== Links ==
+=== Screen sharing on Wayland ===
-[https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/networking/instant-messengers/discord/default.nix default.nix for discord]
+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 [[Discord#Unofficial Clients|unofficial client]] like ''Webcord'' or ''Vesktop'', both of which have fixed this issue in their own ways.
+{{Note|Remember to configure an [https://wiki.archlinux.org/title/XDG_Desktop_Portal#List_of_backends_and_interfaces XDG Desktop Portal] with screen cast capabilities!}}
+=== Notifications causing crashes ===
+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.<syntaxhighlight lang="nixos">
+{ config, lib, 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
+  ];
+}
+</syntaxhighlight>
+=== "Must be your lucky day" popup ===
+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 <code>"SKIP_HOST_UPDATE": true</code> to <code>~/.config/discord/settings.json</code>.
+{{File|~/.config/discord/settings.json|json|
+{
+  "SKIP_HOST_UPDATE": true
+<nowiki>}</nowiki>
+}}
+=== 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 [https://discord.com/terms Terms of Service] and  Krisp's [https://krisp.ai/terms-of-use/ 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 <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">{ 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
+  ];
+}
+</syntaxhighlight>
+{{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:
+<pre>$ krisp-patcher ~/.config/discord/0.0.76/modules/discord_krisp/discord_krisp.node</pre>
+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:
+<syntaxhighlight lang="nix">
+(pkgs.discord.override { withTTS = true; })
+</syntaxhighlight>
+[[Category:Applications]]
+[[Category:Gaming]]