Installing Custom Plugins

Installing Custom Plugins

Equicord supports custom, community, and Vencord-adapted plugins. Note that Equicord does not officially support user-made plugins.

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

Building from source is required for user plugins. Complete the Building from Source guide first.

Folders under src/:

• src/equicordplugins/ — Official plugins.
• src/plugins/ — Vencord-sourced plugins.
• src/userplugins/ — Custom/private plugins (use this unless contributing officially).

Manual Installation

1. Create a userplugins folder inside src/ if it doesn't exist.
2. Place your plugin in its own subfolder inside src/userplugins/ with an entry file named index.ts or index.tsx.
3. Rebuild Equicord by running pnpm build (or pnpm build --dev for dev plugins).
4. Fully restart Discord.

Installation via UserPluginInstaller

You can install plugins directly from Discord desktop/Vesktop clients:

1. Build a dev version using pnpm build --dev.
2. Enable the UserPluginInstaller plugin in settings.
3. Click the Install Plugin button under chat messages containing a Git repository link. Security warning: Only install trusted plugins.

Updating & Maintenance

• Equicord/official plugins: Run git fetch && git pull && pnpm build.
• User plugins: Manually replace files in src/userplugins/ and run pnpm build.

Troubleshooting

Verify entry filenames (index.ts/index.tsx), run pnpm install for missing packages, and ensure Discord was fully restarted.