diff options
| author | Ven <vendicated@riseup.net> | 2023-01-16 05:19:04 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-16 05:19:04 +0100 |
| commit | ebdcbcaf0cd7d49106672d622213951bd5dfc0ae (patch) | |
| tree | 8f00408e621777bf49a34dfb901c2d16a8ac62b8 | |
| parent | 1d287357ca33f8bdd9933a27dc5ea63a8f29e2f8 (diff) | |
| download | Vencord-ebdcbcaf0cd7d49106672d622213951bd5dfc0ae.tar.gz Vencord-ebdcbcaf0cd7d49106672d622213951bd5dfc0ae.tar.bz2 Vencord-ebdcbcaf0cd7d49106672d622213951bd5dfc0ae.zip | |
Update README.md
| -rw-r--r-- | README.md | 35 |
1 files changed, 9 insertions, 26 deletions
@@ -1,19 +1,20 @@ # Vencord -A Discord client mod that does things differently +The cutest Discord client mod ## Features -- Super easy to install, no git or node or anything else required -- Many plugins built in: [See a list](https://gist.github.com/Vendicated/8696cde7b92548064a3ae92ead84d033) - - Some highlights: SpotifyControls, Experiments, NoTrack, MessageLogger, QuickReply, Free Emotes/Stickers, custom slash commands, ShowHiddenChannels -- Browser Support: Run Vencord in your Browser via extension or UserScript +- Super easy to install (one click installer) +- 90+ plugins built in: [See a list](https://gist.github.com/Vendicated/8696cde7b92548064a3ae92ead84d033) + - Some highlights: SpotifyControls, Experiments, NoTrack, MessageLogger, QuickReply, Free Emotes/Stickers, CustomCommands, ShowHiddenChannels, PronounDB +- Excellent Browser Support: Run Vencord in your Browser via extension or UserScript - Custom CSS and Themes: Inbuilt css editor with support to import any css files (including BetterDiscord themes) - Works in all Electron versions (Confirmed working on versions 13-23) +- Maintained very actively, broken plugins are usually fixed within 12 hours ## Installing / Uninstalling -If you're just a normal user, use [our simple gui installer!](https://github.com/Vencord/Installer#usage) +[](https://github.com/Vencord/Installer#usage) ## Installing on Browser @@ -23,27 +24,9 @@ Or install the browser extension for - [](https://github.com/Vendicated/Vencord/releases/latest/download/Vencord-for-Chrome-and-Edge.zip) - [UserScript](https://raw.githubusercontent.com/Vencord/builds/main/Vencord.user.js) - Please note that QuickCSS, shiki and other plugins making use of external resources will not work with the UserScript. +## Building from Source -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 - -```sh -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](#contributing) section below! +See the docs folder ## Contributing |