Skip to main content

Installing custom plugins

danger

These instructions are provided for advanced users.

If you don't understand these instructions, you should not attempt to install custom plugins.

We do not provide support with custom plugins / installs, and you are responsible for any issues that may arise from using them.

If you run into issues and can't figure them out yourself, please stick to the official Plexcord build.

Prerequisite​

To add custom plugins, you need to build Plexcord from source.

If you haven't already done so, first follow the Installing from Source guide.

The following instructions assume you have already done so.

Adding plugins​

Open your Plexcord folder. Inside it, you should find a folder called src. This folder houses all of Plexcord's source code.

If you don't have this folder, you have not read the previous instructions. Go back and first follow the Installing from Source guide.

Creating the userplugins folder​

All official plugins are stored in the src/plugins folder. However, unless you plan to submit your plugin to the official repository, you should not put your plugin there, as you will run into conflicts.

Instead, you will want to use the src/userplugins folder. This folder is reserved for custom / private plugins.

This folder won't exist yet, so you'll have to first create it. Navigate to the src folder and create a new folder called userplugins.

Adding your plugin​

Inside the userplugins folder, you can now add your plugin.

Your plugin should be either a simple myCoolPlugin.ts or myCoolPlugin.tsx file, or a folder containing an index.ts or index.tsx file.

Place it inside the previously created userplugins folder.

Good
  • src/userplugins/myCoolPlugin.ts
  • src/userplugins/myCoolPlugin/index.tsx
Bad
  • src/userplugins/myCoolPlugin/myCoolPlugin.ts
  • src/userplugins/coolPlugins/myCoolPlugin/index.tsx

Building Plexcord​

The last step is rebuilding Plexcord.

Restart Discord and your plugin should show up in the plugins tab!

caution

Be careful not to accidentally create an empty folder or an empty plugin file inside your userplugins folder.

If you get a TypeError: Cannot read properties of undefined (reading 'localeCompare') error, this is why.