## File: README.md

# Vencord


[](https://codeberg.org/Vee/cord)

The cutest Discord client mod



## Features

-   Easy to install
-   [100+ built in plugins](https://vencord.dev/plugins)
-   Fairly lightweight despite the many inbuilt plugins
-   Excellent Browser Support: Run Vencord in your Browser via extension or UserScript
-   Works on any Discord branch: Stable, Canary or PTB all work
-   Custom CSS and Themes: Inbuilt css editor with support to import any css files (including BetterDiscord themes)
-   Privacy friendly: blocks Discord analytics & crash reporting out of the box and has no telemetry
-   Maintained very actively, broken plugins are usually fixed within 12 hours
-   Settings sync: Keep your plugins and their settings synchronised between devices / apps (optional)


## Installing / Uninstalling

Visit https://vencord.dev/download

## Join our Support/Community Server

https://discord.gg/D9uwnFnqmd

## Sponsors

|     **Thanks a lot to all Vencord [sponsors](https://github.com/sponsors/Vendicated)!!**     |
| :------------------------------------------------------------------------------------------: |
|   [](https://github.com/sponsors/Vendicated)    |
| *generated using [github-sponsor-graph](https://github.com/Vendicated/github-sponsor-graph)* |


## Star History

<a href="https://star-history.com/#Vendicated/Vencord&Timeline">
  
    
    
    
  
</a>

## Disclaimer

Discord is trademark of Discord Inc. and solely mentioned for the sake of descriptivity.
Mention of it does not imply any affiliation with or endorsement by Discord Inc.


Using Vencord violates Discord's terms of service

Client modifications are against Discord’s Terms of Service.

However, Discord is pretty indifferent about them and there are no known cases of users getting banned for using client mods! So you should generally be fine as long as you don’t use any plugins that implement abusive behaviour. But no worries, all inbuilt plugins are safe to use!

Regardless, if your account is very important to you and it getting disabled would be a disaster for you, you should probably not use any client mods (not exclusive to Vencord), just to be safe

Additionally, make sure not to post screenshots with Vencord in a server where you might get banned for it

---

## File: packages/vencord-types/README.md

# Vencord Types

Typings for Vencord's api, published to npm

```sh
npm i @vencord/types

yarn add @vencord/types

pnpm add @vencord/types
```

---

## File: packages/discord-types/README.md

# Discord Types

This package provides TypeScript types for the Webpack modules of Discord's web app.

While it was primarily created for Vencord, other client mods could also benefit from this, so it is published as a standalone package!

## Installation

```bash
npm install -D @vencord/discord-types
yarn add -D @vencord/discord-types
pnpm add -D @vencord/discord-types
```

## Example Usage

```ts
import type { UserStore } from "@vencord/discord-types";

const userStore: UserStore = findStore("UserStore"); // findStore is up to you to implement, this library only provides types and no runtime code
```

## Enums

This library also exports some const enums that you can use from Typescript code:
```ts
import { ApplicationCommandType } from "@vencord/discord-types/enums";

console.log(ApplicationCommandType.CHAT_INPUT); // 1
```

### License

This package is licensed under the [LGPL-3.0](./LICENSE) (or later) license.

A very short summary of the license is that you can use this package as a library in both open source and closed source projects,
similar to an MIT-licensed project.
However, if you modify the code of this package, you must release source code of your modified version under the same license.

### Credit

This package was inspired by Swishilicous' [discord-types](https://www.npmjs.com/package/discord-types) package.

---

## File: src/plugins/youtubeAdblock.desktop/README.md

# WatchTogetherAdblock

Block ads in YouTube embeds and the WatchTogether activity via AdGuard

Note that this only works for yourself, other users in the activity will still see ads.

Powered by a modified version of [Adguard's BlockYoutubeAdsShortcut](https://github.com/AdguardTeam/BlockYouTubeAdsShortcut)

---

## File: src/plugins/xsOverlay/README.md

# XSOverlay Notifier

Sends Discord messages to [XSOverlay](https://store.steampowered.com/app/1173510/XSOverlay/) for easier viewing while using VR.

## Preview





## Usage
- Enable this plugin
- Set port and plugin settings as desired (defaults should work fine)
- Open SteamVR and XSOverlay

---

## File: src/plugins/whoReacted/README.md

# WhoReacted

Next to each reaction, display each user's avatar. Each avatar can be clicked and will open the profile.

---

## File: src/plugins/volumeBooster/README.md

# Volume Booster

Allows you to boost the volume over 200% on desktop and over 100% on other clients.

Works on users, bots, and streams!

---

## File: src/plugins/validReply/README.md

# ValidReply

Fixes referenced (replied to) messages showing as "Message could not be loaded".

Hover the text to load the message!

---

## File: src/plugins/userVoiceShow/README.md

# User Voice Show

Shows an indicator when a user is in a Voice Channel

---

## File: src/plugins/userMessagesPronouns/README.md

User Messages Pronouns

Adds pronouns to chat user messages