Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add a bunch of READMEs for plugins missing them, and a few (possibly ok) consistency related fixes #3061

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/plugins/accountPanelServerProfile/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AccountPanelServerProfile

Right click your account panel in the bottom left to view your profile in the current server
Right click your account panel in the bottom left to view your profile in the current server.

![](https://github.com/user-attachments/assets/3228497d-488f-479c-93d2-a32ccdb08f0f)

Expand Down
3 changes: 3 additions & 0 deletions src/plugins/alwaysAnimate/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# alwaysAnimate

Animates anything that can be animated.
2 changes: 1 addition & 1 deletion src/plugins/alwaysExpandRoles/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Always Expand Roles

Always expands the role list in profile popouts
Always expands the role list in profile popouts.
3 changes: 3 additions & 0 deletions src/plugins/alwaysTrust/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# alwaysTrust

Removes the annoying untrusted domain and suspicious file popup.
3 changes: 3 additions & 0 deletions src/plugins/anonymiseFileNames/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# anonymiseFileNames

Anonymise uploaded file names.
3 changes: 3 additions & 0 deletions src/plugins/arRPC.web/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# arRPC

Client plugin for arRPC to enable RPC on Discord Web (experimental).
3 changes: 3 additions & 0 deletions src/plugins/banger/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# banger

Replaces the GIF in the ban dialogue with a custom one.
3 changes: 3 additions & 0 deletions src/plugins/betterGifAltText/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# betterGifAltText

Change GIF alt text from simply being 'GIF' to containing the gif tags / filename.
3 changes: 3 additions & 0 deletions src/plugins/betterGifPicker/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# betterGifPicker

Makes the gif picker open the favourite category by default.
3 changes: 3 additions & 0 deletions src/plugins/betterNotes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# betterNotes

Hide notes or disable spellcheck. (Configure in settings!!)
3 changes: 3 additions & 0 deletions src/plugins/betterRoleDot/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# betterRoleDot

Copy role colour on RoleDot (accessibility setting) click. Also allows using both RoleDot and coloured names simultaneously.
3 changes: 3 additions & 0 deletions src/plugins/betterUploadButton/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# betterUploadButton

Upload with a single click, open menu with right click.
3 changes: 3 additions & 0 deletions src/plugins/biggerStreamPreview/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# biggerStreamPreview

This plugin allows you to enlarge stream previews.
3 changes: 3 additions & 0 deletions src/plugins/blurNsfw/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# blurNsfw

Blur attachments in NSFW channels until hovered.
3 changes: 3 additions & 0 deletions src/plugins/callTimer/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# callTimer

Adds a timer to vcs.
3 changes: 3 additions & 0 deletions src/plugins/clearURLs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# clearURLs

Removes tracking garbage from URLs.
3 changes: 3 additions & 0 deletions src/plugins/colorSighted/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# colorSighted

Removes the colorblind-friendly icons from statuses, just like 2015-2017 Discord.
3 changes: 3 additions & 0 deletions src/plugins/consoleShortcuts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# consoleShortcuts

Adds shorter Aliases for many things on the window. Run `shortcutList` for a list.
3 changes: 3 additions & 0 deletions src/plugins/copyUserURLs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# copyUserURLs

Adds a 'Copy User URL' option to the user context menu.
3 changes: 3 additions & 0 deletions src/plugins/crashHandler/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# crashHandler

Utility plugin for handling and possibly recovering from crashes without a restart.
3 changes: 3 additions & 0 deletions src/plugins/ctrlEnterSend/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# ctrlEnterSend

Use Ctrl+Enter to send messages (customizable).
3 changes: 3 additions & 0 deletions src/plugins/customRPC/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# customRPC

Allows you to set a custom rich presence.
3 changes: 3 additions & 0 deletions src/plugins/devCompanion.dev/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# devCompanion

Adds tools to help with development for Vencord.
3 changes: 3 additions & 0 deletions src/plugins/disableCallIdle/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# disableCallIdle

Disables automatically getting kicked from a DM voice call after 3 minutes and being moved to an AFK voice channel.
3 changes: 3 additions & 0 deletions src/plugins/dontRoundMyTimestamps/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# dontRoundMyTimestamps

Always rounds relative timestamps down, so 7.6y becomes 7y instead of 8y.
3 changes: 3 additions & 0 deletions src/plugins/emoteCloner/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# emoteCloner

Allows you to clone Emotes & Stickers to your own server (right click them).
9 changes: 9 additions & 0 deletions src/plugins/experiments/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Experiments

Enable Access to Experiments & other dev-only features in Discord!

## Warning

Experiments are unreleased Discord features. They might not work, or even break your client or get your account disabled.

Only use experiments if you know what you're doing. Vencord is not responsible for any damage caused by enabling experiments.
3 changes: 3 additions & 0 deletions src/plugins/f8break/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# F8Break

Pause the client when you press F8 with DevTools (+ breakpoints) open.
3 changes: 3 additions & 0 deletions src/plugins/fakeNitro/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# fakeNitro

Allows you to stream in nitro quality, send fake emojis/stickers, use client themes and custom Discord notifications.
3 changes: 3 additions & 0 deletions src/plugins/fakeProfileThemes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# fakeProfileThemes

Allows profile theming by hiding the colors in your bio thanks to invisible 3y3 encoding.
3 changes: 3 additions & 0 deletions src/plugins/fixCodeblockGap/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# fixCodeblockGap

Removes the gap between codeblocks and text below it.
3 changes: 3 additions & 0 deletions src/plugins/fixSpotifyEmbeds.desktop/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# fixSpotifyEmbeds

Fixes spotify embeds being incredibly loud by letting you customise the volume.
3 changes: 3 additions & 0 deletions src/plugins/forceOwnerCrown/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# forceOwnerCrown

Force the owner crown next to usernames even if the server is large.
3 changes: 3 additions & 0 deletions src/plugins/friendInvites/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# friendInvites

Create and manage friend invite links via slash commands (/create friend invite, /view friend invites, /revoke friend invites).
3 changes: 3 additions & 0 deletions src/plugins/gameActivityToggle/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# gameActivityToggle

Adds a button next to the mic and deafen button to toggle game activity.
3 changes: 3 additions & 0 deletions src/plugins/gifPaste/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# gifPaste

Makes picking a gif in the gif picker insert a link into the chatbox instead of instantly sending it.
3 changes: 3 additions & 0 deletions src/plugins/greetStickerPicker/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# greetStickerPicker

Allows you to use any greet sticker instead of only the random one by right-clicking the 'Wave to say hi!' button.
3 changes: 3 additions & 0 deletions src/plugins/hideAttachments/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# hideAttachments

Hide attachments and Embeds for individual messages via hover button.
3 changes: 3 additions & 0 deletions src/plugins/iLoveSpam/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# iLoveSpam

Do not hide messages from 'likely spammers'.
3 changes: 3 additions & 0 deletions src/plugins/invisibleChat.desktop/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# invisibleChat

Encrypt your Messages in a non-suspicious way!
3 changes: 3 additions & 0 deletions src/plugins/keepCurrentChannel/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# keepCurrentChannel

Attempt to navigate to the channel you were in before switching accounts or loading Discord.
3 changes: 3 additions & 0 deletions src/plugins/lastfm/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# LastFMRichPresence

Little plugin for Last.fm rich presence
3 changes: 3 additions & 0 deletions src/plugins/loadingQuotes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# loadingQuotes

Replace Discords loading quotes.
3 changes: 3 additions & 0 deletions src/plugins/memberCount/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# memberCount

Shows the amount of online & total members in the server member list and tooltip
3 changes: 3 additions & 0 deletions src/plugins/messageLinkEmbeds/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# messageLinkEmbeds

Adds a preview to messages that link another message.
2 changes: 2 additions & 0 deletions src/plugins/messageLogger/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# messageLogger
Temporarily logs deleted and edited messages.
3 changes: 3 additions & 0 deletions src/plugins/messageTags/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# messageTags

Allows you to save messages and to use them with a simple command.
3 changes: 3 additions & 0 deletions src/plugins/moreCommands/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# moreCommands

Adds three new commands: /echo, /lenny, /mock.
2 changes: 1 addition & 1 deletion src/plugins/moreCommands/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ function mock(input: string): string {

export default definePlugin({
name: "MoreCommands",
description: "echo, lenny, mock",
description: "Adds three new commands: /echo, /lenny, /mock.",
authors: [Devs.Arjix, Devs.echo, Devs.Samu],
commands: [
{
Expand Down
3 changes: 3 additions & 0 deletions src/plugins/moreKaomoji/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# moreKaomoji

Adds more Kaomoji to discord. ヽ(´▽`)/
3 changes: 3 additions & 0 deletions src/plugins/moreUserTags/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# moreUserTags

Adds tags for webhooks and moderative roles (owner, admin, etc).
3 changes: 3 additions & 0 deletions src/plugins/moyai/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Moyai

🗿🗿🗿🗿🗿🗿🗿🗿
3 changes: 3 additions & 0 deletions src/plugins/mutualGroupDMs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# mutualGroupDMs

Shows mutual group dms in profiles.
3 changes: 3 additions & 0 deletions src/plugins/newGuildSettings/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# newGuildSettings

Automatically mute new servers and change various other settings upon joining.
3 changes: 3 additions & 0 deletions src/plugins/noBlockedMessages/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# noBlockedMessages

Hides all blocked messages from chat completely.
3 changes: 3 additions & 0 deletions src/plugins/noDevtoolsWarning/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# noDevtoolsWarning

Disables the 'HOLD UP' banner in the console. As a side effect, also prevents Discord from hiding your token, which prevents random logouts.
3 changes: 3 additions & 0 deletions src/plugins/noF1/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# noF1

Disables F1 help bind.
3 changes: 3 additions & 0 deletions src/plugins/noMosaic/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# noMosaic

Removes Discord image mosaic.
3 changes: 3 additions & 0 deletions src/plugins/noOnboardingDelay/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# noOnboardingDelay

Skips the slow and annoying onboarding delay.
3 changes: 3 additions & 0 deletions src/plugins/noPendingCount/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# noPendingCount

Removes the ping count of incoming friend requests, message requests, and nitro offers.
3 changes: 3 additions & 0 deletions src/plugins/noProfileThemes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# noProfileThemes

Completely removes Nitro profile themes from everyone but yourself.
3 changes: 3 additions & 0 deletions src/plugins/noRPC.discordDesktop/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# noRPC

Disables Discord's RPC server.
3 changes: 3 additions & 0 deletions src/plugins/noReplyMention/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# noReplyMention

Disables reply pings by default.
3 changes: 3 additions & 0 deletions src/plugins/noScreensharePreview/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# noScreensharePreview

Disables screenshare previews from being sent.
3 changes: 3 additions & 0 deletions src/plugins/noServerEmojis/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# noServerEmojis

Do not show server emojis in the autocomplete menu.
3 changes: 3 additions & 0 deletions src/plugins/noSystemBadge.discordDesktop/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# noSystemBadge

Disables the taskbar and system tray unread count badge.
3 changes: 3 additions & 0 deletions src/plugins/noTypingAnimation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# noTypingAnimation

Disables the CPU-intensive typing dots animation.
3 changes: 3 additions & 0 deletions src/plugins/noUnblockToJump/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# noUnblockToJump

Allows you to jump to messages of blocked users without unblocking them.
3 changes: 3 additions & 0 deletions src/plugins/normalizeMessageLinks/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# normalizeMessageLinks

Strip canary/ptb from message links.
3 changes: 3 additions & 0 deletions src/plugins/nsfwGateBypass/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# nsfwGateBypass

Allows you to access NSFW channels without setting/verifying your age.
3 changes: 3 additions & 0 deletions src/plugins/oneko/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Oneko

A cat that follows your mouse, Powered by [oneko.js](https://github.com/adryd325/oneko.js/).
3 changes: 3 additions & 0 deletions src/plugins/overrideForumDefaults/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# overrideForumDefaults

Allows you to override default forum layout/sort order. you can still change it on a per-channel basis.
3 changes: 3 additions & 0 deletions src/plugins/partyMode/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# partyMode

Allows you to use party mode cause the party never ends ✨
3 changes: 3 additions & 0 deletions src/plugins/permissionsViewer/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# permissionsViewer

View the permissions a user or channel has, and the roles of a server.
3 changes: 3 additions & 0 deletions src/plugins/petpet/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# petpet

Adds a /petpet slash command to create headpet gifs from any image.
3 changes: 3 additions & 0 deletions src/plugins/pictureInPicture/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# pictureInPicture

Adds picture in picture to videos (next to the Download button).
3 changes: 3 additions & 0 deletions src/plugins/pinDms/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# pinDms

Allows you to pin private channels to the top of your DM list.
3 changes: 3 additions & 0 deletions src/plugins/plainFolderIcon/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# plainFolderIcon

Doesn't show the small guild icons in folders.
3 changes: 3 additions & 0 deletions src/plugins/platformIndicators/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# platformIndicators

Adds platform indicators (Desktop, Mobile, Web...) to users.
3 changes: 3 additions & 0 deletions src/plugins/reactErrorDecoder/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# reactErrorDecoder

Minifies React errors.
3 changes: 3 additions & 0 deletions src/plugins/readAllNotificationsButton/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# readAllNotificationsButton

Read all server notifications with a single button click!
3 changes: 3 additions & 0 deletions src/plugins/relationshipNotifier/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# relationshipNotifier

Notifies you when a friend, group chat, or server removes you.
3 changes: 3 additions & 0 deletions src/plugins/revealAllSpoilers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# revealAllSpoilers

Reveal all spoilers in a message by Ctrl-clicking a spoiler, or in the chat with Ctrl+Shift-click.
3 changes: 3 additions & 0 deletions src/plugins/reverseImageSearch/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# reverseImageSearch

Adds ImageSearch to image context menus.
3 changes: 3 additions & 0 deletions src/plugins/reviewDB/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# ReviewDB

Review other users (Adds new settings to profiles).
3 changes: 3 additions & 0 deletions src/plugins/roleColorEverywhere/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# roleColorEverywhere

Adds the top role color anywhere possible.
3 changes: 3 additions & 0 deletions src/plugins/secretRingTone/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# secretRingTone

Always play the secret version of the discord ringtone (except during special ringtone events).
3 changes: 3 additions & 0 deletions src/plugins/sendTimestamps/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# sendTimestamps

Send timestamps easily via chat box button & text shortcuts.
2 changes: 1 addition & 1 deletion src/plugins/serverInfo/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ServerInfo

Allows you to view info about servers and see friends and blocked users
Allows you to view info about servers and see friends and blocked users.

![](https://github.com/Vendicated/Vencord/assets/45497981/a49783b5-e8fc-41d8-968f-58600e9f6580)
![](https://github.com/Vendicated/Vencord/assets/45497981/5efc158a-e671-4196-a15a-77edf79a2630)
Expand Down
3 changes: 3 additions & 0 deletions src/plugins/serverListIndicators/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# serverListIndicators

Add online friend count or server count in the server list.
3 changes: 3 additions & 0 deletions src/plugins/shikiCodeblocks.desktop/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# shikiCodeblocks

Brings vscode-style codeblocks into Discord, powered by [Shiki](https://shiki.style/).
3 changes: 3 additions & 0 deletions src/plugins/showAllMessageButtons/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# showAllMessageButtons

Always show all message buttons no matter if you are holding the shift key or not.
3 changes: 3 additions & 0 deletions src/plugins/showConnections/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# showConnections

Show connected accounts in user popouts.
5 changes: 5 additions & 0 deletions src/plugins/showHiddenChannels/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# showHiddenChannels

Show channels that you do not have access to view.

Please note that this can not, and **never will** be able to view the contents of said channels.
Loading
Loading