feat(installer): Implement cross-platform patcher. (#39)

* megu cute
This commit is contained in:
megumin 2022-10-04 21:07:34 +01:00 committed by GitHub
parent c5e0c7a6e7
commit 88542b9ede
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 481 additions and 255 deletions

View file

@ -15,11 +15,13 @@ A Discord client mod that does things differently
## Installing
If you can't follow the following instructions, please just use BetterDiscord. This was never meant to be a noob friendly mod.
If you can't follow the following instructions, please just use BetterDiscord.
This was never meant to be a noob friendly mod.
Install [Node.js](https://nodejs.org/en/download/) and [git](https://git-scm.com/downloads)
Open a Terminal and run the following commands. If any of them failed, you didn't properly install Node.js and git (see above).
Open a Terminal and run the following commands.
If any of them failed, you didn't properly install Node.js and git (see above).
> :warning: On Windows, DO NOT run the terminal as Administrator. If you open it and the path says system32, you opened it as Administrator.
```sh
@ -31,12 +33,11 @@ pnpm build
```
Don't close your terminal just yet!
The builds are now in the dist/ folder (Vencord/dist). Most importantly, you will need `dist/patcher.js`
Now to patch vencord into your Discord client, run the following command and follow the interactive prompt.
Now download [X1nto's installer](https://github.com/X1nto/VencordInstaller/releases/latest) for your platform. Download it to the Vencord folder.
Run it via terminal: `VencordInstaller.exe` on Windows or `chmod +x vencord_installer && ./vencord_installer` on Mac.
Follow along with the prompts. Once you are prompted for the patcher, enter `dist/patcher.js`.
```sh
pnpm patch
```
Now fully close Discord. Start and confirm Vencord successfully installed by checking if you have a new Vencord section in Settings.
@ -44,6 +45,8 @@ If you ever need to get back to the Vencord folder, just open a new terminal and
All plugins are disabled by default, so your first step should be opening Settings and enabling the plugins you want.
You can unpatch Vencord using `pnpm unpatch`
## Installing on Browser