Equicord Documentation

๐Ÿ“š A finished and foolproof guide to installing and using Equicord

๐Ÿ‘‹ Welcome to the Equicord documentation!

This guide will help you get started with installing and using Equicord. Equicord is a Vencord fork that is actively maintained and updated by the Equicord team and Equicord Contributors.

You have the ways to install Equicord for the 3 main Operating Systems. (Linux, MacOS and Windows)

Windows: Equicord can be installed on Windows using the GUI installer or the CLI installer. The GUI installer is recommended for most users, while the CLI installer is more of a basic option. Equibop can be installed on Windows using the Installer's (X64/AMD64/ARM64/etc) or the Portable zip files.

MacOS: Equicord can be installed on MacOS using the GUI installer. As a Secondary option for Mac there is Equibop. Equibop can be installed be install via DMG file or ZIP. If you would like more information on Equibop please visit the Equibop Repository.

Linux: Equicord can be installed on Linux using the right installation for your desktop environment. There are several options available, including GUI for X11 and Wayland, CLI, and a shell script installation. You can also install Equicord from the Arch User Repository. It is recommended to use Equibop if on Linux as it is a stable version of Equicord for Linux using discord web.

๐Ÿ› ๏ธ Installing Equicord

This guide will walk you through the installation process for Equicord across various platforms. Choose the appropriate method for your operating system.

Windows

Equicord offers both GUI and CLI installation options for Windows users:

 MacOS

For MacOS users, we provide a GUI installer & Equibop.

Linux

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

๐Ÿ—๏ธ Building from source

โš ๏ธEquicord developer build is intended only for plugin development or when adding custom user plugins. We strongly recommend against using it unless you have sufficient technical knowledge.

Equicord:

If you need to build Equicord from source for development purposes, follow these steps:

๐Ÿงฉ Prerequisites

Before starting, ensure you have the following dependencies installed:

๐Ÿ› ๏ธ Install pnpm

Important: For subsequent steps, do NOT use an admin/root terminal. Doing so could damage your Discord/Equicord installation and require a complete reinstall.

Note: The following command may require administrator/root privileges. After installation, you may need to close and reopen your terminal for pnpm to be available in your PATH.

npm i -g pnpm

๐Ÿ› ๏ธ Clone the Repository

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

๐Ÿ› ๏ธ Install Dependencies

pnpm install --no-frozen-lockfile

๐Ÿ› ๏ธ Build Equicord

pnpm build

Note: To enable Developer only plugins inside of Equicord you must build using pnpm build --dev
It is Recommended that you don't use this as some plugins can be deemed danger to public user or used for Equicord Development

๐Ÿ’‰ Inject Equicord into Discord

pnpm inject

๐Ÿ› ๏ธ Start Equicord

Start up Discord and you now have Equicord! Well done you build Equicord from source!

Equibop:

Equicord developer build is intended only for plugin development or when adding custom user plugins. We strongly recommend against using it unless you have sufficient technical knowledge.

If you need to build Equibop from source for development purposes, follow these steps:

๐Ÿงฉ Prerequisites

Before starting, ensure you have the following dependencies installed:

๐Ÿ› ๏ธ Install pnpm

Important: For subsequent steps, do NOT use an admin/root terminal. Doing so could damage your Discord/Equicord installation and require a complete reinstall.

Note: The following command may require administrator/root privileges. After installation, you may need to close and reopen your terminal for pnpm to be available in your PATH.

npm i -g pnpm

๐Ÿ› ๏ธ Clone the Repository

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

๐Ÿ› ๏ธ Install Dependencies

pnpm i

๐Ÿ› ๏ธ Build Equibop

Equibop can be built in 4 ways. Such as:

Run it without packaging

pnpm start

Via Package Only

pnpm package

Only build the pacman target

pnpm package --linux pacman

Package to a directory only

pnpm package:dir

๐Ÿญ/๐Ÿ—๏ธ Plugin Development

๐Ÿญ/๐Ÿ—๏ธ Installing Userplugins

Equicord supports allows any plugin to be build into your Discord.(Includes 3rd-party plugins from Vencord). To install a user plugin, follow these steps:

1. โฌ Download the Plugin

โœ… Correct:

src/userplugins/MyMagicPlugin/MyMagicPlugin.ts
src/userplugins/MyMagicPlugin/index.tsx

โš ๏ธ Incorrect:

src/userplugins/MyMagicPlugin/MyMagicPlugin/MyMagicPlugin.tsx
src/userplugins/index.ts

2. ๐Ÿ“ฅ Place Plugin in Userplugins Folder

After downloading, place the plugin file in one of these locations:

  • Windows: Equicord\src\userplugins\
  • macOS: ~/Library/Application Support/Equicord/src/userplugins/
  • Linux: ~/.config/Equicord/src/userplugins/

3. ๐Ÿ”ƒ Restart Discord

Restart Discord completely for the plugin to take effect. You can then enable it in Equicord settings.

๐Ÿ—๏ธ๐Ÿญ Extras

This documentation currently unfinished. If you would like to contribute to Equicord open PR Here!

1. "My Plugin isn't working!"

Make sure the plugin is in the correct folder and has the correct file structure. If you're still having issues, check the Equicord build logs for more information.

2. Where do I get support about Plugin Development?

For plugin development suggetions/support, You can ask in Equicord Discord. You may not get a reply if the User or Person is not knowledgeable on the topic.

FAQ

IF YOU ARE GOING TO USE AI OR CHATGPT FOR SUPPORT YOU WILL BE SUPPORT BANNED. SUPPORT IS ONLY ON OUR DISCORD

1. "A JavaScript error orrcurred in the main process"

This could be many things to do with Installer or discord's JavaScript files. If your installer is out of date PLEASE UPDATE!

2. "Patching C:\Users\user\AppData\Local\Discord. ERROR Didn't find desktop.asar"

Your Discord install is likely messed up please follow this:
Press Windows+R
%AppData%
Delete Discord
Repeat for %LocalAppData%
Install discord

OR do a clean reinstall using the guide below (its completely different to a normal reinstall) from Here

IF you need a Simpified way then follow this:

Hold Windows Key and Press R, this box under should appear. Type %AppData% and click OK.

Then Delete the Discord Folder.

Repeat the same steps but with %LocalAppData% and delete the Discord Folder.

โ•Then Install Discord again. If you want to download discord quickly you can from these 3 buttons.

Main Branch (Discord)
PTB Branch (Discord PTB)
Canary Branch (Discord Canary)

3. Something went wrong. Please Check the logs above.

This could be Windows Defender blocking Equicord's CLI installer please disable or add an Exclusion! If it is a different issue goto our support channel on our discord. To Learn how to add an Exclusion go Here.

4. Discord Activies aren't working!

This could be because of OpenASAR, As we have had reports on this before. Simply uninject OpenASAR from Discord. This can be done by opening the Equicord installer.

CLI:

GUI:

5. I'm using Equibop and it's not dectecting my game(s) or programs!

This is because of how Equibop detects games and programs using ARRPC. If you would like to look into ARRPC you can Here!

6. I have a different issue!

For any other issues, please check the Equicord Discord server for support. You can find the link in the Resources section of this documentation.