Vencord/README.md
2022-10-25 21:40:23 +02:00

6.4 KiB

Vencord

A Discord client mod that does things differently

Features

  • 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)
  • Many Useful™ plugins - See a full List
  • Experiments
  • Proper context isolation -> Works in newer Electron versions (Confirmed working on versions 13-22)
  • Inline patches: Patch Discord's code with regex replacements! See the experiments plugin 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!)

Installing / Uninstalling

If you're just a normal user, use our simple gui installer!

If you wanna make plugins or contribute or just want to build from source and install manually, read Megu's Installation Guide!

Installing on Browser

Install the browser extension or UserScript. 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

pnpm buildWeb

You will find the built extension at dist/extension.zip. Now just install this extension in your Browser

Installing Plugins

Note

You can only use 3rd party plugins in the manual Vencord install for now.

Vencord comes with a bunch of plugins out of the box!

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. Don't forget to rebuild!

Want to learn how to create your own plugin, and maybe PR it into Vencord? See the Contributing section below!

Contributing

See CONTRIBUTING.md and Megu's Plugin Guide!

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

Join

join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join join