2022-08-29 20:05:22 +00:00
# Vencord
2022-10-03 14:43:11 +00:00
A Discord client mod that does things differently
2022-08-29 20:05:22 +00:00
## Features
2022-10-07 23:44:12 +00:00
- Works on Discord's latest update that breaks all other mods
- Browser Support (experimental): Run Vencord in your Browser instead of the desktop app
- 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)
2022-10-25 10:19:56 +00:00
- Many Useful™ plugins - [See a full List ](https://gist.github.com/Vendicated/8696cde7b92548064a3ae92ead84d033 )
2022-10-07 23:44:12 +00:00
- Experiments
2022-10-21 23:17:06 +00:00
- Proper context isolation -> Works in newer Electron versions (Confirmed working on versions 13-22)
2022-10-07 23:44:12 +00:00
- 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!)
2022-10-03 14:43:11 +00:00
2022-10-07 23:44:12 +00:00
## Installing / Uninstalling
2022-08-29 20:08:44 +00:00
2022-10-25 19:40:23 +00:00
If you're just a normal user, use [our simple gui installer! ](https://github.com/Vendicated/VencordInstaller#usage )
If you wanna make plugins or contribute or just want to build from source and install manually, read [Megu's Installation Guide! ](docs/1_INSTALLING.md )
2022-10-03 22:57:49 +00:00
## Installing on Browser
2022-10-25 19:40:23 +00:00
Install [the browser extension ](https://github.com/Vendicated/Vencord/releases/latest/download/extension.zip ) or [UserScript ](https://github.com/Vendicated/Vencord/releases/download/devbuild/Vencord.user.js ). Please note that they aren't automatically updated for now, so you will regularely have to reinstall it.
You may also build them from source, to do that do the same steps as in the manual regular install method,
except run `pnpm buildWeb` instead of `pnpm build` , and your outputs will be in the dist folder
2022-10-07 23:44:12 +00:00
2022-10-03 22:57:49 +00:00
```sh
pnpm buildWeb
```
2022-10-07 23:44:12 +00:00
2022-10-03 22:57:49 +00:00
You will find the built extension at dist/extension.zip. Now just install this extension in your Browser
2022-10-17 21:46:52 +00:00
## Installing Plugins
2022-10-25 19:40:23 +00:00
> **Note**
> You can only use 3rd party plugins in the manual Vencord install for now.
2022-10-17 21:46:52 +00:00
Vencord comes with a bunch of plugins out of the box!
2022-10-25 19:40:23 +00:00
2022-10-20 16:15:35 +00:00
However, if you want to install your own ones, create a `userplugins` folder in the `src` directory and create or clone your plugins in there.
2022-10-17 21:46:52 +00:00
Don't forget to rebuild!
Want to learn how to create your own plugin, and maybe PR it into Vencord? See the [Contributing ](#contributing ) section below!
2022-10-01 02:04:34 +00:00
## Contributing
2022-10-07 23:44:12 +00:00
See [CONTRIBUTING.md ](CONTRIBUTING.md ) and [Megu's Plugin Guide! ](docs/2_PLUGINS.md )
2022-10-01 02:04:34 +00:00
[contribute]: CONTRIBUTING.md
2022-10-04 20:36:46 +00:00
[contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute] [contribute]
2022-10-01 02:04:34 +00:00
2022-09-02 00:50:20 +00:00
## Join
2022-10-07 23:44:12 +00:00
2022-09-02 02:11:52 +00:00
[join]: https://discord.gg/D9uwnFnqmd
[join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join] [join]
