Installing Equicord

Windows

Equicord offers both graphical and command-line installation options for Windows users:

x64

GUI Installer

CLI Installer

ARM64

GUI Installer

CLI Installer

EquibopAlternative desktop client, pre-patched with Equicord.

Caution

While a Windows build of Equibop technically exists, it isn’t officially supported. Equibop is primarily recommended for Linux and Mac users.

MacOS

For macOS users, we provide graphical and command-line installers, as well as Equibop:

Universal

GUI Installer

CLI Installer

x64

GUI Installer

CLI Installer

ARM64

GUI Installer

CLI Installer

The CLI builds are plain binaries, so run chmod +x <file> after downloading.

EquibopRecommended — alternative desktop client, pre-patched with Equicord.

Linux

Linux users have several installation options depending on their desktop environment and preferences:

x64

Combined GUI

X11 GUI

Wayland GUI

CLI

ARM64

Combined GUI

X11 GUI

Wayland GUI

CLI

Arch User RepositoryEquicord installer on the AUR

EquibopGitHub Releases

EquibopAvailable on the AUR

EquibopAvailable on Flathub

Install Equicord via shell script:

sh -c "$(curl -sS https://raw.githubusercontent.com/Equicord/Equicord/refs/heads/main/misc/install.sh)"

Equibop on NixOS

This package is currently outdated, waiting for a PR merge.

nix-shell -p equibop

Building from Source

If you want to develop plugins or run the bleeding-edge version of Equicord, you can build it yourself instead of using one of the prebuilt installers above.

Prerequisites

Equicord is powered by Node.js, git and pnpm, so you will have to install all of those before you can get started:

• Download git
• Download Node.js
• Download pnpm

Make sure that all of them are added to your PATH, you will need it.

To verify correct installation, run the following commands. All 3 should print the version of the respective software without errors:

git --version
node --version
pnpm --version

Cloning the Equicord Repository

Next, you should check out the Equicord source code!

Pick a convenient folder that you can remember, for example your Documents folder. Open a terminal and point it to the desired folder:

cd Documents

Then, clone the Equicord repository:

git clone https://github.com/Equicord/Equicord

and finally point your terminal to the newly created Equicord folder:

cd Equicord

Tip

Whenever you open a new terminal, you will have to navigate to the Equicord folder again. If you stuck to the example above, the command to do this would be:

cd Documents/Equicord

Installing Dependencies

The next step is installing Equicord’s dependencies. We use the pnpm package manager. Please do not use npm or yarn!

Issue the following command:

pnpm install --frozen-lockfile

Equicord might add, remove or update dependencies at any time. Thus, you might receive errors like Cannot find package "foobar" imported from ... after updating.

If this happens, you should run the same command once again to update the installed dependencies.

Building Equicord

The last step is compiling the Equicord code.

The steps for this will differ depending on which platform you want to build for.

Discord Desktop

pnpm build

Equibop

pnpm build

Web Browser

pnpm buildWeb

Tip

You can build a Development Build of Equicord by appending --dev to the build command, for example pnpm build --dev. This gives you access to development tools like PatchHelper.

Caution

Whenever you make changes to the source code, you will have to rebuild Equicord to apply your changes. To do so, simply run the same build command again.

Since this becomes tedious quickly, we also provide a command that watches for changes and rebuilds automatically whenever you make changes. Simply add the --watch flag, for example pnpm buildWeb --watch!

Installing Your Custom Build

You’re done! Now you can install your custom build of Equicord.

The installation process differs depending on the platform you want to install on.

Discord Desktop

Run

pnpm inject

This will launch the Equilotl installer. Just patch the desired Discord install and you’re done!

Equibop

1. Open Equibop
2. Go to the Equibop Settings category
3. Scroll down all the way to the Open Developer Settings button, and click it.
4. Under Equicord Location, press Change and select the dist folder in your Equicord directory. For example, if you stuck to the example above, you would select Documents/Equicord/dist
5. Fully close and restart Equibop and you’re done!

Caution

If you are using the Equibop flatpak on Linux, the path might turn into /run/1000/.... This is a temporary path granted by the flatpak runtime and might break after a restart.

You should grant the Equibop flatpak access to the Equicord directory to solve this issue, for example via

flatpak override io.github.equicord.equibop --filesystem="$HOME/Documents/Equicord"

Web Browser

You will find three builds in the dist folder:

• extension-chrome.zip — For Chrome and Chromium-based browsers. Go to chrome://extensions, enable Developer Mode, and drag the zip file into the window.
• extension-firefox.zip — For Firefox. Go to about:addons, click the gear icon, and select Install Add-on From File....
• Equicord.user.js — Userscript for Tampermonkey, Greasemonkey, or any other userscript manager. Open the file in your browser and your userscript manager will prompt you to install it.