diff options
author | V <vendicated@riseup.net> | 2023-03-31 05:30:45 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-03-31 05:30:45 +0200 |
commit | c86a34a15d189c67ce8edd2f23aec37f2440d07c (patch) | |
tree | d225165218bfb213a6e9ce796686dfe8dd62c005 /docs/1_INSTALLING.md | |
parent | ff16513f217bd55920e0a26ca24c7c5cf7f4b270 (diff) | |
download | Vencord-c86a34a15d189c67ce8edd2f23aec37f2440d07c.tar.gz Vencord-c86a34a15d189c67ce8edd2f23aec37f2440d07c.tar.bz2 Vencord-c86a34a15d189c67ce8edd2f23aec37f2440d07c.zip |
Update 1_INSTALLING.md
Diffstat (limited to 'docs/1_INSTALLING.md')
-rw-r--r-- | docs/1_INSTALLING.md | 102 |
1 files changed, 1 insertions, 101 deletions
diff --git a/docs/1_INSTALLING.md b/docs/1_INSTALLING.md index 7fcd57a..e69dcc1 100644 --- a/docs/1_INSTALLING.md +++ b/docs/1_INSTALLING.md @@ -27,11 +27,9 @@ Welcome to Megu's Installation Guide! In this file, you will learn about how to ## Installing Vencord -> :exclamation: If this doesn't work, see [Manually Installing Vencord](#manually-installing-vencord) - Install `pnpm`: -> :exclamation: This next command may need to be run as admin/sudo depending on your system, and you may need to close and reopen your terminal for pnpm to be in your PATH. +> :exclamation: 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. ```shell npm i -g pnpm @@ -103,102 +101,4 @@ Simply run: pnpm uninject ``` -The above command may ask you to also run: - -```shell -pnpm install --frozen-lockfile -pnpm uninject -``` - -## Manually Installing Vencord - -- [Windows](#on-windows) -- [Linux](#on-linux) -- [MacOS](#on-macos) - -### On Windows - -Press Win+R and enter: `%LocalAppData%` and hit enter. In this page, find the page (Discord, DiscordPTB, DiscordCanary, etc) that you want to patch. - -Now follow the instructions at [Manual Patching](#manual-patching) - -### On Linux - -The Discord folder is usually in one of the following paths: - -- /usr/share -- /usr/lib64 -- /opt -- /home/$USER/.local/share - -If you use flatpak, it will usually be in one of the following paths: - -- /var/lib/flatpak/app/com.discordapp.Discord/current/active/files -- /home/$USER/.local/share/flatpak/app/com.discordapp.Discord/current/active/files - -You will need to give flatpak access to vencord with one of the following commands: - -> :exclamation: If not on stable, replace `com.discordapp.Discord` with your branch name, e.g., `com.discordapp.DiscordCanary` - -> :exclamation: Replace `/path/to/vencord/` with the path to your vencord folder (NOT the dist folder) - -If Discord flatpak install is in /home/: - -```shell -flatpak override --user com.discordapp.Discord --filesystem="/path/to/vencord/" -``` - -If Discord flatpak install not in /home/: - -```shell -sudo flatpak override com.discordapp.Discord --filesystem="/path/to/vencord" -``` - -Now follow the instructions at [Manual Patching](#manual-patching) - -### On MacOS - -Open finder and go to your Applications folder. Right-Click on the Discord application you want to patch, and view contents. - -Go to the `Contents/Resources` folder. - -Now follow the instructions at [Manual Patching](#manual-patching) - -### Manual Patching - -> :exclamation: If using Flatpak on linux, go to the folder that contains the `app.asar` file, and skip to where we create the `app` folder below. - -> :exclamation: On Linux/MacOS, there's a chance there won't be an `app-<number>` folder, but there probably is a `resources` folder, so keep reading :) - -Inside there, look for the `app-<number>` folders. If you have multiple, use the highest number. If that doesn't work, do it for the rest of the `app-<number>` folders. - -Inside there, go to the `resources` folder. There should be a file called `app.asar`. If there isn't, look at a different `app-<number>` folder instead. - -Make a new folder in `resources` called `app`. In here, we will make two files: - -`package.json` and `index.js` - -In `index.js`: - -> :exclamation: Replace the path in the first line with the path to `patcher.js` in your vencord dist folder. -> On Windows, you can get this by shift-rightclicking the patcher.js file and selecting "copy as path" - -```js -require("C:/Users/<your user>/path/to/vencord/dist/patcher.js"); -``` - -And in `package.json`: - -```json -{ "name": "discord", "main": "index.js" } -``` - -Finally, fully close & reopen your Discord client and check to see that `Vencord` appears in settings! - -### Manually Uninstalling Vencord - -> :exclamation: Do not delete `app.asar` - Only delete the `app` folder we created. - -Use the instructions above to find the `app` folder, and delete it. Then Close & Reopen Discord. - If you need more help, ask in the support channel in our [Discord Server](https://discord.gg/D9uwnFnqmd). |