Vencord/docs/1_INSTALLING.md
2023-03-31 05:30:45 +02:00

2.6 KiB

Warning

These instructions are only for advanced users. If you're not a Developer, you should use our graphical installer instead.

Installation Guide

Welcome to Megu's Installation Guide! In this file, you will learn about how to download, install, and uninstall Vencord!

Sections

Dependencies

Installing Vencord

Install pnpm:

This next command may need to be run as admin/root depending on your system, and you may need to close and reopen your terminal for pnpm to be in your PATH.

npm i -g pnpm

IMPORTANT Make sure you aren't using an admin/root terminal from here onwards. It will mess up your Discord/Vencord instance and you will most likely have to reinstall.

Clone Vencord:

git clone https://github.com/Vendicated/Vencord
cd Vencord

Install dependencies:

pnpm install --frozen-lockfile

Build Vencord:

pnpm build

Inject vencord into your client:

pnpm inject

Then fully close Discord from your taskbar or task manager, and restart it. Vencord should be injected - you can check this by looking for the Vencord section in Discord settings.

Updating Vencord

If you're using Discord already, go into the Updater tab in settings.

Sometimes it may be neccessary to manually update if the GUI updater fails.

To pull latest changes:

git pull

If this fails, you likely need to reset your local changes to vencord to resolve merge errors:

This command will remove any local changes you've made to vencord. Make sure you back up if you made any code changes you don't want to lose!

git reset --hard
git pull

and then to build the changes:

pnpm build

Then just refresh your client

Uninstalling Vencord

Simply run:

pnpm uninject

If you need more help, ask in the support channel in our Discord Server.