Installing Custom Plugins

Equicord supports any plugin to be built into your Discord, whether they are plugins made by the community, adapted from Vencord or ones you wrote yourself.

Caution

Equicord does not provide support for user plugins or dev builds. If you run into issues you cannot resolve on your own, you may ask in developer channels (NOT SUPPORT), but a response is not guaranteed.

Before You Start

User plugins require building Equicord from source. If you have not done this yet, follow the Building from Source guide first.

You will also need to understand where plugins live in the project, since putting a plugin in the wrong folder is the most common cause of issues.

Where plugins live

Equicord separates plugins into three folders depending on their purpose:

• Directorysrc/

  • Directoryequicordplugins/ Official Equicord plugins.

    • …
  • Directoryplugins/ Plugins sourced from or based on Vencord.

    • …
  • Directoryuserplugins/ Your private plugins.

    • …

Unless you are contributing to Equicord or Vencord, always use src/userplugins/.

Installing a Plugin

Create the userplugins folder

This folder does not exist by default. Navigate to src/ inside your Equicord folder and create a new folder named userplugins.

src/userplugins/

Add the plugin

Place the plugin inside src/userplugins/. Each plugin must have its own folder, and the entry file must be named index.ts or index.tsx.

Valid structures

src/userplugins/myMagicPlugin/index.ts
src/userplugins/myMagicPlugin/index.tsx

Invalid structures

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

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

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

Rebuild Equicord

After adding the plugin, rebuild so it gets bundled into Discord:

pnpm build

If you want to also include developer-only plugins, use:

pnpm build --dev

Restart Discord

Once the build finishes, restart Discord. Your plugin should now appear in the plugins tab.

Installing Plugins via UserPluginInstaller

You can install user plugins straight from Discord with the UserPluginInstaller plugin, no manual cloning or rebuilding required.

Tip

UserPluginInstaller is only available on dev builds. Make sure you build Equicord with:

pnpm build --dev

Once enabled, any message containing a link to a plugin’s Git repository will show an Install Plugin button underneath it. Clicking it opens a popup with the plugin’s metadata and a few warnings. Review them, and the plugin will be installed.

Caution

• Do not install plugins from untrusted people until you have reviewed them yourself. Neither Equicord nor Vencord are responsible for anything that happens to your system as a result.
• UserPluginInstaller only works on platforms where native plugin helpers run, i.e. Discord Desktop or Vesktop.

Updating Equicord & official plugins

Run these three commands inside your Equicord folder:

git fetch
git pull
pnpm build

Note

git fetch and git pull only update Equicord itself and its official plugins. They do not update your user plugins automatically.

After building, you only need to run pnpm inject again if Discord is not already injected. If it was already running, a simple restart of Discord is enough.

Updating user plugins

Git does not manage your user plugins. To update a user plugin, you need to:

Tip

If you’re experienced enough, you can look it up or figure out how to make git manage it, but let’s focus on simplicity.

1. Download the new version of the plugin manually from its repository or source.
2. Replace the old file(s) inside src/userplugins/ with the new ones.
3. Rebuild Equicord:

pnpm build

Tip

If you are not familiar with Git yet, the GitHub Git guide and the Git for beginners are great places to start. They will teach you how Git works and how to use it, which will help you both here and in many other situations.

Troubleshooting

If your plugin isn’t showing up, check these first:

• Wrong folder (equicordplugins, plugins, or userplugins).
• The entry file is not named index.ts or index.tsx.
• Folder name is not camelCase.
• Equicord was not rebuilt after adding the plugin.

Missing dependencies

If pnpm build complains about missing packages, run:

pnpm install

Then try building again.

Discord not reflecting your build

If Discord still shows the old version after building, try rebuilding:

pnpm build

If the issue persists, make sure Discord was fully restarted after the build completed.

Something in your user plugin broke

Errors that persist after running pnpm install are almost always caused by the plugin itself. A syntax error, a missing file, a broken import or whatever. Read the error message carefully and check the plugin’s source manually.