profxadke
/
Vencord
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

This commit is contained in:
Ven 2022-10-03 16:43:11 +02:00 committed by GitHub
parent d102d5d976
commit e454ffbfed
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1,27 +1,45 @@
# Vencord
My own Discord Desktop mod :)
A Discord client mod that does things differently
## Features
- Works on Discord's latest swc update that breaks all other mods
- Works on Discord's latest update that breaks all other mods
- Custom Css and Themes: Manually edit `%appdata%/Vencord/settings/quickCss.css` / `~/.config/Vencord/settings/quickCss.css` with your favourite editor and the client will automatically apply your changes. To import BetterDiscord themes, just add `@import url(theUrl)` on the top of this file. (Make sure the url is a github raw URL or similar and only contains plain text, and NOT a nice looking website)
- Many Useful™ plugins - [List](https://github.com/Vendicated/Vencord/tree/main/src/plugins)
- Experiments
- Proper context isolation -> Works in newer Electron versions (Confirmed working on versions 13-21)
- Inline patches: Patch Discord's code with regex replacements! See [the experiments plugin](src/plugins/experiments.ts) for an example. While being more complex, this is more powerful than monkey patching since you can patch only small parts of functions instead of fully replacing them, access non exported/local variables and even replace constants (like in the aforementioned experiments patch!)
- Experiments
- Custom Css: Manually edit `%appdata%/Vencord/settings/quickCss.css` / `~/.config/Vencord/settings/quickCss.css` with your favourite editor and the client will automatically apply your changes
- Many Useful™ plugins - [List](https://github.com/Vendicated/Vencord/tree/main/src/plugins)
## Installing
Make sure you have NodeJs and git installed. I will be using pnpm, you can use npm instead
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).
> :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
npm i -g pnpm
git clone https://github.com/Vendicated/Vencord
cd Vencord
pnpm i
pnpm build
```
The builds are now in the dist/ folder (Vencord/dist).
Now install with either the powershell/bash script or use [X1nto's installer](https://github.com/X1nto/VencordInstaller/releases/latest)
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 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`.
Now fully close Discord. Start and confirm Vencord successfully installed by checking if you have a new Vencord section in Settings.
If you ever need to get back to the Vencord folder, just open a new terminal and type `cd Vencord`
All plugins are disabled by default, so your first step should be opening Settings and enabling the plugins you want.
## Contributing
[contribute]: CONTRIBUTING.md