Building from Source

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:

• Git
• Node.js LTS

Install pnpm

WARNING

Windows users: Do not run the following commands in an administrator terminal. This can break your Discord installation.

npm i -g pnpm

Clone the Repository

WARNING

Do not clone in your system folder. Clone in a folder you will remember, like your Documents folder.

Windows:

cd "%USERPROFILE%/Documents"

Linux or MacOS:

cd "$HOME/Documents"

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

Install Dependencies

pnpm install --no-frozen-lockfile

Build Equicord

pnpm build

TIP

To enable Developer-only plugins and access debugging tools like PatchHelper, you should build Equicord in Development Mode using the --dev flag:

pnpm build --dev

TIP

If you are actively making changes to the source code, use Watch Mode. This automatically triggers a rebuild every time you save a file, saving you from running the build command manually:

pnpm build --watch
# Or for dev mode with watch:
pnpm build --dev --watch

Inject Equicord into Discord

pnpm inject

Start Discord

Equibop

Instructions for building Equibop from source have moved to the Equibop Docs.

NOTE

Unless you're a developer, there's no reason to build from source. To use user plugins or dev builds, simply clone Equicord instead. More details here.