Skip to main content

Installing Plexcord

Prerequisites​

Plexcord is powered by Node.js, git and pnpm, so you will have to install all of those before you can get started:

Make sure that all of them are added to your PATH, you will need it.

To verify correct installation, run the following commands. All 3 should print the version of the respective software without errors:

git --version
node --version
pnpm --version

Cloning the Plexcord Repository​

Next, you should check out the Plexcord source code!

Pick a convenient folder that you can remember, for example your Documents folder. Open a terminal and point it to the desired folder:

cd Documents

Then, clone the Plexcord repository:

git clone https://github.com/MutanPlex/Plexcord

and finally point your terminal to the newly created Plexcord folder:

cd Plexcord
tip

Whenever you open a new terminal, you will have to navigate to the Plexcord folder again. If you stuck to the example above, the command to do this would be:

cd Documents/Plexcord

Installing Dependencies​

The next step is installing Plexcord's dependencies. We use the pnpm package manager. Please do not use npm or yarn!

Issue the following command:

pnpm install --frozen-lockfile
warning

Plexcord might add, remove or update dependencies at any time. Thus, you might receive errors like Cannot find package "foobar" imported from ... after updating.

If this happens, you should run the same command once again to update the installed dependencies.

Building Plexcord​

Now you're almost done! The last step is compiling the Plexcord code.

The steps for this will differ depending on which platform you want to build for.

pnpm build
tip

You can build a Development Build of Plexcord by appending --dev to the build command, for example pnpm build --dev. This gives you access to development tools like PatchHelper.

caution

Whenever you make changes to the source code, you will have to rebuild Plexcord to apply your changes. To do so, simply run the same build command again.

Since this becomes tedious quickly, we also provide a command that watches for changes and rebuilds automatically whenever you make changes. Simply add the --watch flag, for example pnpm buildWeb --watch!

Installing your custom build​

You're done! Now you can install your custom build of Plexcord.

The installation process differs depending on the platform you want to install on.

Run

pnpm inject

This will launch the Plexcord Installer. Just patch the desired Plexcord install and you're done!