From 68e7d9daebbaa3425d29fc345a5119fca107452f Mon Sep 17 00:00:00 2001 From: verticalsync <60797172+verticalsync@users.noreply.github.com> Date: Mon, 15 Jul 2024 19:26:48 +0300 Subject: [PATCH] hh --- CONTRIBUTING.md | 33 +++--- src/plugins/appleMusic.desktop/README.md | 9 -- src/plugins/automodContext/README.md | 5 - src/plugins/betterRoleContext/README.md | 6 - src/plugins/betterSessions/README.md | 5 - src/plugins/betterSettings/README.md | 9 -- src/plugins/clientTheme/README.md | 7 -- src/plugins/consoleJanitor/README.md | 5 - src/plugins/copyEmojiMarkdown/README.md | 5 - src/plugins/customidle/README.md | 5 - src/plugins/dearrow/README.md | 5 - src/plugins/decor/README.md | 17 --- src/plugins/favEmojiFirst/README.md | 6 - src/plugins/favGifSearch/README.md | 5 - .../fixYoutubeEmbeds.desktop/README.md | 5 - src/plugins/friendsSince/README.md | 5 - src/plugins/imageLink/README.md | 3 - src/plugins/imageZoom/README.md | 6 - src/plugins/implicitRelationships/README.md | 7 -- src/plugins/maskedLinkPaste/README.md | 5 - src/plugins/mentionAvatars/README.md | 5 - src/plugins/messageClickActions/README.md | 5 - src/plugins/messageLatency/README.md | 31 ----- src/plugins/noDefaultHangStatus/README.md | 5 - src/plugins/notificationVolume/README.md | 3 - src/plugins/onePingPerDM/README.md | 7 -- src/plugins/pauseInvitesForever/README.md | 5 - src/plugins/permissionFreeWill/README.md | 9 -- src/plugins/previewMessage/README.md | 5 - src/plugins/quickMention/README.md | 5 - src/plugins/quickReply/README.md | 5 - src/plugins/replaceGoogleSearch/README.md | 5 - src/plugins/replyTimestamp/README.md | 5 - src/plugins/searchReply/README.md | 5 - src/plugins/seeSummaries/README.md | 9 -- src/plugins/serverInfo/README.md | 7 -- src/plugins/showAllRoles/README.md | 6 - src/plugins/showHiddenThings/README.md | 19 --- src/plugins/showTimeoutDuration/README.md | 8 -- src/plugins/superReactionTweaks/README.md | 11 -- src/plugins/themeAttributes/README.md | 29 ----- src/plugins/unlockedAvatarZoom/README.md | 5 - src/plugins/validReply/README.md | 7 -- .../watchTogetherAdblock.desktop/README.md | 6 - src/plugins/whoReacted/README.md | 5 - src/plugins/xsOverlay.desktop/README.md | 16 --- src/suncordplugins/Anammox/README.md | 8 -- src/suncordplugins/allCallTimers/README.md | 17 --- src/suncordplugins/amITyping/README.md | 3 - src/suncordplugins/betterBanReasons/README.md | 4 - .../betterScreenshare.dev/README.md | 30 ----- src/suncordplugins/blockKrisp/README.md | 5 - .../commandPalette/3_COMMAND_PALETTE.md | 49 -------- src/suncordplugins/discordColorways/README.md | 10 -- src/suncordplugins/followUser/README.md | 5 - src/suncordplugins/holyNotes/README.md | 1 - src/suncordplugins/ignoreTerms/README.md | 5 - .../mediaDownloader.desktop/README.md | 48 -------- .../mediaPlaybackSpeed/README.md | 5 - src/suncordplugins/messageColors/README.md | 12 -- .../messageLoggerEnhanced/README.md | 108 ------------------ .../notifyUserChanges/README.md | 8 -- src/suncordplugins/silentTyping/README.md | 6 - src/suncordplugins/themeLibrary/README.md | 17 --- .../voiceChatUtilities/README.md | 6 - 65 files changed, 17 insertions(+), 711 deletions(-) delete mode 100644 src/plugins/appleMusic.desktop/README.md delete mode 100644 src/plugins/automodContext/README.md delete mode 100644 src/plugins/betterRoleContext/README.md delete mode 100644 src/plugins/betterSessions/README.md delete mode 100644 src/plugins/betterSettings/README.md delete mode 100644 src/plugins/clientTheme/README.md delete mode 100644 src/plugins/consoleJanitor/README.md delete mode 100644 src/plugins/copyEmojiMarkdown/README.md delete mode 100644 src/plugins/customidle/README.md delete mode 100644 src/plugins/dearrow/README.md delete mode 100644 src/plugins/decor/README.md delete mode 100644 src/plugins/favEmojiFirst/README.md delete mode 100644 src/plugins/favGifSearch/README.md delete mode 100644 src/plugins/fixYoutubeEmbeds.desktop/README.md delete mode 100644 src/plugins/friendsSince/README.md delete mode 100644 src/plugins/imageLink/README.md delete mode 100644 src/plugins/imageZoom/README.md delete mode 100644 src/plugins/implicitRelationships/README.md delete mode 100644 src/plugins/maskedLinkPaste/README.md delete mode 100644 src/plugins/mentionAvatars/README.md delete mode 100644 src/plugins/messageClickActions/README.md delete mode 100644 src/plugins/messageLatency/README.md delete mode 100644 src/plugins/noDefaultHangStatus/README.md delete mode 100644 src/plugins/notificationVolume/README.md delete mode 100644 src/plugins/onePingPerDM/README.md delete mode 100644 src/plugins/pauseInvitesForever/README.md delete mode 100644 src/plugins/permissionFreeWill/README.md delete mode 100644 src/plugins/previewMessage/README.md delete mode 100644 src/plugins/quickMention/README.md delete mode 100644 src/plugins/quickReply/README.md delete mode 100644 src/plugins/replaceGoogleSearch/README.md delete mode 100644 src/plugins/replyTimestamp/README.md delete mode 100644 src/plugins/searchReply/README.md delete mode 100644 src/plugins/seeSummaries/README.md delete mode 100644 src/plugins/serverInfo/README.md delete mode 100644 src/plugins/showAllRoles/README.md delete mode 100644 src/plugins/showHiddenThings/README.md delete mode 100644 src/plugins/showTimeoutDuration/README.md delete mode 100644 src/plugins/superReactionTweaks/README.md delete mode 100644 src/plugins/themeAttributes/README.md delete mode 100644 src/plugins/unlockedAvatarZoom/README.md delete mode 100644 src/plugins/validReply/README.md delete mode 100644 src/plugins/watchTogetherAdblock.desktop/README.md delete mode 100644 src/plugins/whoReacted/README.md delete mode 100644 src/plugins/xsOverlay.desktop/README.md delete mode 100644 src/suncordplugins/Anammox/README.md delete mode 100644 src/suncordplugins/allCallTimers/README.md delete mode 100644 src/suncordplugins/amITyping/README.md delete mode 100644 src/suncordplugins/betterBanReasons/README.md delete mode 100644 src/suncordplugins/betterScreenshare.dev/README.md delete mode 100644 src/suncordplugins/blockKrisp/README.md delete mode 100644 src/suncordplugins/commandPalette/3_COMMAND_PALETTE.md delete mode 100644 src/suncordplugins/discordColorways/README.md delete mode 100644 src/suncordplugins/followUser/README.md delete mode 100644 src/suncordplugins/holyNotes/README.md delete mode 100644 src/suncordplugins/ignoreTerms/README.md delete mode 100644 src/suncordplugins/mediaDownloader.desktop/README.md delete mode 100644 src/suncordplugins/mediaPlaybackSpeed/README.md delete mode 100644 src/suncordplugins/messageColors/README.md delete mode 100644 src/suncordplugins/messageLoggerEnhanced/README.md delete mode 100644 src/suncordplugins/notifyUserChanges/README.md delete mode 100644 src/suncordplugins/silentTyping/README.md delete mode 100644 src/suncordplugins/themeLibrary/README.md delete mode 100644 src/suncordplugins/voiceChatUtilities/README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 80187821..f0e8fefd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# The documentation is the same as Vencord because we have just added plugins on top or such, so everything will be the same, however do not make issues on Vencord if you use Suncord unless redirected by a staff member. +# The documentation is the same as Vencord because we have just added plugins on top or such, so everything will be the same, however do not make issues on Vencord if you use Suncord unless redirected by a staff member for specific reasons. # Contributing to Vencord @@ -19,24 +19,25 @@ Pull requests can be made either to the `main` or the `dev` branch. However, unl Writing a plugin is the primary way to contribute. Before starting your plugin: -- Check existing pull requests to see if someone is already working on a similar plugin -- Check our [plugin requests tracker](https://github.com/Vencord/plugin-requests/issues) to see if there is an existing request, or if the same idea has been rejected -- If there isn't an existing request, [open one](https://github.com/Vencord/plugin-requests/issues/new?assignees=&labels=&projects=&template=request.yml) yourself - and include that you'd like to work on this yourself. Then wait for feedback to see if the idea even has any chance of being accepted. Or maybe others have some ideas to improve it! -- Familarise yourself with our plugin rules below to ensure your plugin is not banned + +- Check existing pull requests to see if someone is already working on a similar plugin +- Check our [plugin requests tracker](https://github.com/Vencord/plugin-requests/issues) to see if there is an existing request, or if the same idea has been rejected +- If there isn't an existing request, [open one](https://github.com/Vencord/plugin-requests/issues/new?assignees=&labels=&projects=&template=request.yml) yourself + and include that you'd like to work on this yourself. Then wait for feedback to see if the idea even has any chance of being accepted. Or maybe others have some ideas to improve it! +- Familarise yourself with our plugin rules below to ensure your plugin is not banned ### Plugin Rules -- No simple slash command plugins like `/cat`. Instead, make a [user installable Discord bot](https://discord.com/developers/docs/change-log#userinstallable-apps-preview) -- No simple text replace plugins like Let me Google that for you. The TextReplace plugin can do this -- No raw DOM manipulation. Use proper patches and React -- No FakeDeafen or FakeMute -- No StereoMic -- No plugins that simply hide or redesign ui elements. This can be done with CSS -- No selfbots or API spam (animated status, message pruner, auto reply, nitro snipers, etc) -- No untrusted third party APIs. Popular services like Google or GitHub are fine, but absolutely no self hosted ones -- No plugins that require the user to enter their own API key -- Do not introduce new dependencies unless absolutely necessary and warranted +- No simple slash command plugins like `/cat`. Instead, make a [user installable Discord bot](https://discord.com/developers/docs/change-log#userinstallable-apps-preview) +- No simple text replace plugins like Let me Google that for you. The TextReplace plugin can do this +- No raw DOM manipulation. Use proper patches and React +- No FakeDeafen or FakeMute +- No StereoMic +- No plugins that simply hide or redesign ui elements. This can be done with CSS +- No selfbots or API spam (animated status, message pruner, auto reply, nitro snipers, etc) +- No untrusted third party APIs. Popular services like Google or GitHub are fine, but absolutely no self hosted ones +- No plugins that require the user to enter their own API key +- Do not introduce new dependencies unless absolutely necessary and warranted ## Improve Vencord itself diff --git a/src/plugins/appleMusic.desktop/README.md b/src/plugins/appleMusic.desktop/README.md deleted file mode 100644 index 52ab93bf..00000000 --- a/src/plugins/appleMusic.desktop/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# AppleMusicRichPresence - -This plugin enables Discord rich presence for your Apple Music! (This only works on macOS with the Music app.) - -![Screenshot of the activity in Discord](https://github.com/Vendicated/Vencord/assets/70191398/1f811090-ab5f-4060-a9ee-d0ac44a1d3c0) - -## Configuration - -For the customizable activity format strings, you can use several special strings to include track data in activities! `{name}` is replaced with the track name; `{artist}` is replaced with the artist(s)' name(s); and `{album}` is replaced with the album name. diff --git a/src/plugins/automodContext/README.md b/src/plugins/automodContext/README.md deleted file mode 100644 index f70d71d9..00000000 --- a/src/plugins/automodContext/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# AutomodContext - -Allows you to jump to the messages surrounding an automod hit - -![Visualization](https://github.com/Vendicated/Vencord/assets/61953774/d13740c8-2062-4553-b975-82fd3d6cc08b) diff --git a/src/plugins/betterRoleContext/README.md b/src/plugins/betterRoleContext/README.md deleted file mode 100644 index e54e1e31..00000000 --- a/src/plugins/betterRoleContext/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# BetterRoleContext - -Adds options to copy role color, edit role and view role icon when right clicking roles in the user profile - -![](https://github.com/Vendicated/Vencord/assets/45497981/354220a4-09f3-4c5f-a28e-4b19ca775190) - diff --git a/src/plugins/betterSessions/README.md b/src/plugins/betterSessions/README.md deleted file mode 100644 index cf13e6c5..00000000 --- a/src/plugins/betterSessions/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# BetterSessions - -Enhances the sessions (devices) menu. Allows you to view exact timestamps, give each session a custom name, and receive notifications about new sessions. - -![](https://github.com/Vendicated/Vencord/assets/9750071/4a44b617-bb8f-4dcb-93f1-b7d2575ed3d8) diff --git a/src/plugins/betterSettings/README.md b/src/plugins/betterSettings/README.md deleted file mode 100644 index 127c6ce7..00000000 --- a/src/plugins/betterSettings/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# BetterSettings - -Improves Discord's Settings via multiple (toggleable) changes: -- makes opening settings much faster -- removes the scuffed transition animation -- organises the settings cog context menu into categories - -![](https://github.com/Vendicated/Vencord/assets/45497981/e8d67a95-3909-4be5-8281-8cf9d2f1c30e) - diff --git a/src/plugins/clientTheme/README.md b/src/plugins/clientTheme/README.md deleted file mode 100644 index 6c5dfe23..00000000 --- a/src/plugins/clientTheme/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Classic Client Theme - -Revival of the old client theme experiment (The one that came before the sucky one that we actually got) - -![the ClientTheme theme colour picker](https://user-images.githubusercontent.com/37855219/230238053-e90b7098-373a-459a-bb8c-c24e82f69270.png) - -https://github.com/verticalsync/Suncord/assets/45497981/6c1bcb3b-e0c7-4a02-b0b8-c4c5cd954f38 diff --git a/src/plugins/consoleJanitor/README.md b/src/plugins/consoleJanitor/README.md deleted file mode 100644 index fbba766a..00000000 --- a/src/plugins/consoleJanitor/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# ConsoleJanitor - -Disables annoying console messages/errors. This plugin mainly removes errors/warnings that happen all the time and noisy/spammy logging messages. - -Some of the disabled messages include the "notosans-400-normalitalic" error and MessageActionCreators, Routing/Utils loggers. diff --git a/src/plugins/copyEmojiMarkdown/README.md b/src/plugins/copyEmojiMarkdown/README.md deleted file mode 100644 index 9e62e663..00000000 --- a/src/plugins/copyEmojiMarkdown/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# CopyEmojiMarkdown - -Allows you to copy emojis as formatted string. Custom emojis will be copied as `<:trolley:1024751352028602449>`, default emojis as `🛒` - -![](https://github.com/Vendicated/Vencord/assets/45497981/417f345a-7031-4fe7-8e42-e238870cd547) diff --git a/src/plugins/customidle/README.md b/src/plugins/customidle/README.md deleted file mode 100644 index 63bf87d8..00000000 --- a/src/plugins/customidle/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# CustomIdle - -Lets you change the time until your status gets automatically set to idle. You can also prevent idling altogether. - -![Plugin Configuration](https://github.com/Vendicated/Vencord/assets/45801973/4e5259b2-18e0-42e5-b69f-efc672ce1e0b) diff --git a/src/plugins/dearrow/README.md b/src/plugins/dearrow/README.md deleted file mode 100644 index 5bbcfb5c..00000000 --- a/src/plugins/dearrow/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Dearrow - -Makes YouTube embed titles and thumbnails less sensationalist, powered by [Dearrow](https://dearrow.ajay.app/) - -https://github.com/verticalsync/Suncord/assets/45497981/7bf81108-102d-47c5-8ba5-357db4db1283 diff --git a/src/plugins/decor/README.md b/src/plugins/decor/README.md deleted file mode 100644 index 3397b65e..00000000 --- a/src/plugins/decor/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# Decor - -Custom avatar decorations! - -![Custom decorations in chat](https://github.com/verticalsync/Suncord/assets/30497388/b0c4c4c8-8723-42a8-b50f-195ad4e26136) - -Create and use your own custom avatar decorations, or pick your favorite from the presets. - -You'll be able to see the custom avatar decorations of other users of this plugin, and they'll be able to see your custom avatar decoration. - -You can select and manage your custom avatar decorations under the "Profiles" page in settings, or in the plugin settings. - -![Custom decorations management](https://github.com/verticalsync/Suncord/assets/30497388/74fe8a9e-a2a2-4b29-bc10-9eaa58208ad4) - -Review the [guidelines](https://github.com/decor-discord/.github/blob/main/GUIDELINES.md) before creating your own custom avatar decoration. - -Join the [Discord server](https://https://discord.gg/VasF3Ma4Ab) for support and notifications on your decoration's review. diff --git a/src/plugins/favEmojiFirst/README.md b/src/plugins/favEmojiFirst/README.md deleted file mode 100644 index fcfe6226..00000000 --- a/src/plugins/favEmojiFirst/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# FavoriteEmojiFirst - -Puts your favorite emoji first in the emoji autocomplete. - -![a screenshot of the favourite emojis section](https://github.com/verticalsync/Suncord/assets/45497981/419c8c16-1afc-46e0-9cc2-20b9c3489711) -![a comparison of the emoji picker before and after enabling this plugin](https://github.com/verticalsync/Suncord/assets/45497981/4f57626d-cfc6-4155-a47c-2eac191231bb) diff --git a/src/plugins/favGifSearch/README.md b/src/plugins/favGifSearch/README.md deleted file mode 100644 index cb586e6c..00000000 --- a/src/plugins/favGifSearch/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# FavoriteGifSearch - -Adds a search bar to favorite gifs. - -![Screenshot](https://github.com/verticalsync/Suncord/assets/45497981/19552adc-d921-4153-976e-e9361dc8fdaf) diff --git a/src/plugins/fixYoutubeEmbeds.desktop/README.md b/src/plugins/fixYoutubeEmbeds.desktop/README.md deleted file mode 100644 index 875de9e2..00000000 --- a/src/plugins/fixYoutubeEmbeds.desktop/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# FixYoutubeEmbeds - -Bypasses youtube videos being blocked from display on Discord (for example by UMG) - -![](https://github.com/Vendicated/Vencord/assets/45497981/7a5fdcaa-217c-4c63-acae-f0d6af2f79be) diff --git a/src/plugins/friendsSince/README.md b/src/plugins/friendsSince/README.md deleted file mode 100644 index ccbb09b6..00000000 --- a/src/plugins/friendsSince/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# FriendsSince - -Shows when you became friends with someone in the user popout - -![](https://github.com/Vendicated/Vencord/assets/45497981/bb258188-ab48-4c4d-9858-1e90ba41e926) diff --git a/src/plugins/imageLink/README.md b/src/plugins/imageLink/README.md deleted file mode 100644 index add65794..00000000 --- a/src/plugins/imageLink/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# ImageLink - -If a message consists of only a link to an image, Discord hides the link and shows only the image embed. This plugin makes the link show regardless. diff --git a/src/plugins/imageZoom/README.md b/src/plugins/imageZoom/README.md deleted file mode 100644 index 1fc8fca2..00000000 --- a/src/plugins/imageZoom/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# ImageZoom - -Lets you zoom in to images and gifs. Use scroll wheel to zoom in and shift + scroll wheel to increase lens radius / size - -![the plugin in action](https://github.com/verticalsync/Suncord/assets/45497981/408cd77d-c5f4-40bc-8de2-f977a31b3e5f) -![the context menu options offered by the plugin](https://github.com/verticalsync/Suncord/assets/45497981/3bede636-f1ce-493f-af46-788b920cb81c) diff --git a/src/plugins/implicitRelationships/README.md b/src/plugins/implicitRelationships/README.md deleted file mode 100644 index a76e298f..00000000 --- a/src/plugins/implicitRelationships/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# ImplicitRelationships - -Shows your implicit relationships in the Friends tab. - -Implicit relationships on Discord are people with whom you've frecently interacted and share a mutual server; even though Discord thinks you should be friends with them, you haven't added them as friends. - -![](https://camo.githubusercontent.com/6927161ee0c933f7ef6d61f243cca3e6ea4c8db9d1becd8cbf73c45e1bd0d127/68747470733a2f2f692e646f6c66692e65732f7055447859464662674d2e706e673f6b65793d736e3950343936416c32444c7072) diff --git a/src/plugins/maskedLinkPaste/README.md b/src/plugins/maskedLinkPaste/README.md deleted file mode 100644 index 30beccb6..00000000 --- a/src/plugins/maskedLinkPaste/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# MaskedLinkPaste - -Pasting a link while you have text selected will paste your link as a masked link at that location - -![](https://github.com/Vendicated/Vencord/assets/78964224/1d3be2c6-7957-44c9-92ec-551069d46c02) diff --git a/src/plugins/mentionAvatars/README.md b/src/plugins/mentionAvatars/README.md deleted file mode 100644 index 912b5191..00000000 --- a/src/plugins/mentionAvatars/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# MentionAvatars - -Shows user avatars inside mentions - -![](https://github.com/user-attachments/assets/fc76ea47-5e19-4063-a592-c57785a75cc7) diff --git a/src/plugins/messageClickActions/README.md b/src/plugins/messageClickActions/README.md deleted file mode 100644 index 82266720..00000000 --- a/src/plugins/messageClickActions/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# MessageClickActions - -Allows you to double click to edit/reply to a message or delete it if you hold the backspace key - -![](https://github.com/verticalsync/Suncord/assets/55940580/6885aca2-4021-4910-b636-bb40f877a816) diff --git a/src/plugins/messageLatency/README.md b/src/plugins/messageLatency/README.md deleted file mode 100644 index 8d2a776c..00000000 --- a/src/plugins/messageLatency/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# MessageLatency - -Displays an indicator for messages that took ≥n seconds to send. - -> **NOTE** -> -> - This plugin only applies to messages received after opening the channel -> - False positives can exist if the user's system clock has drifted. -> - Grouped messages only display latency of the first message - -## Demo - -### Chat View - -![chat-view](https://github.com/Vendicated/Vencord/assets/82430093/69430881-60b3-422f-aa3d-c62953837566) - -### Clock -ve Drift - -![pissbot-on-top](https://github.com/Vendicated/Vencord/assets/82430093/d9248b66-e761-4872-8829-e8bf4fea6ec8) - -### Clock +ve Drift - -![dumb-ai](https://github.com/Vendicated/Vencord/assets/82430093/0e9783cf-51d5-4559-ae10-42399e7d4099) - -### Connection Delay - -![who-this](https://github.com/Vendicated/Vencord/assets/82430093/fd68873d-8630-42cc-a166-e9063d2718b2) - -### Icons - -![icons](https://github.com/Vendicated/Vencord/assets/82430093/17630bd9-44ee-4967-bcdf-3315eb6eca85) diff --git a/src/plugins/noDefaultHangStatus/README.md b/src/plugins/noDefaultHangStatus/README.md deleted file mode 100644 index e6bc9f83..00000000 --- a/src/plugins/noDefaultHangStatus/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# NoDefaultHangStatus - -Disable the default hang status when joining voice channels - -![Visualization](https://github.com/Vendicated/Vencord/assets/24937357/329a9742-236f-48f7-94ff-c3510eca505a) diff --git a/src/plugins/notificationVolume/README.md b/src/plugins/notificationVolume/README.md deleted file mode 100644 index 05e5af4e..00000000 --- a/src/plugins/notificationVolume/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# NotificationVolume - -Set a separate volume for notifications and in-app sounds (e.g. messages, call sound, mute/unmute) helping your ears stay healthy for many years to come. diff --git a/src/plugins/onePingPerDM/README.md b/src/plugins/onePingPerDM/README.md deleted file mode 100644 index 43f89b72..00000000 --- a/src/plugins/onePingPerDM/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# OnePingPerDM -If unread messages are sent by a user in DMs multiple times, you'll only receive one audio ping. Read the messages to reset the limit - -## Purpose -- Prevents ping audio spam in DMs -- Be able to distinguish more than one ping as multiple users -- Be less annoyed while gaming diff --git a/src/plugins/pauseInvitesForever/README.md b/src/plugins/pauseInvitesForever/README.md deleted file mode 100644 index 7ccf0b72..00000000 --- a/src/plugins/pauseInvitesForever/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# PauseInvitesForever - -Adds a button to the Security Actions modal to to pause invites indefinitely. - -![](https://github.com/Vendicated/Vencord/assets/47677887/e5ba40a3-cb08-462a-8615-fb74dd54c790) diff --git a/src/plugins/permissionFreeWill/README.md b/src/plugins/permissionFreeWill/README.md deleted file mode 100644 index ca30575f..00000000 --- a/src/plugins/permissionFreeWill/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# PermissionFreeWill - -Removes the client-side restrictions that prevent editing channel permissions, such as permission lockouts ("Pretty sure -you don't want to do this") and onboarding requirements ("Making this change will make your server incompatible [...]") - -## Warning - -This plugin will let you create permissions in servers that **WILL** lock you out of channels until an administrator -can resolve it for you. Please be careful with the overwrites you are making and check carefully. diff --git a/src/plugins/previewMessage/README.md b/src/plugins/previewMessage/README.md deleted file mode 100644 index 15b10626..00000000 --- a/src/plugins/previewMessage/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# PreviewMessage - -Lets you preview your message before sending it. - -![the plugin in action](https://github.com/verticalsync/Suncord/assets/45497981/3ce32860-e5cd-4ea2-bdab-e121f1703579) diff --git a/src/plugins/quickMention/README.md b/src/plugins/quickMention/README.md deleted file mode 100644 index 75fab48d..00000000 --- a/src/plugins/quickMention/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# QuickMention - -Adds a mention icon to the messages action bar - -![](https://github.com/verticalsync/Suncord/assets/55940580/82d3fec7-4196-4917-b3c2-6e652b2aff9e) diff --git a/src/plugins/quickReply/README.md b/src/plugins/quickReply/README.md deleted file mode 100644 index a902ceca..00000000 --- a/src/plugins/quickReply/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# QuickReply - -Reply to (ctrl + up/down) and edit (ctrl + shift + up/down) messages via keybinds - -![](https://github.com/verticalsync/Suncord/assets/55940580/df79a27a-6529-4c70-8870-3c17d3637e4f) diff --git a/src/plugins/replaceGoogleSearch/README.md b/src/plugins/replaceGoogleSearch/README.md deleted file mode 100644 index 1ab30212..00000000 --- a/src/plugins/replaceGoogleSearch/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# ReplaceGoogleSearch - -Replaces the Google search with different Engines - -![Visualization](https://github.com/Vendicated/Vencord/assets/61953774/8b8158d2-0407-4d7b-9dff-a8b9bdc1a122) diff --git a/src/plugins/replyTimestamp/README.md b/src/plugins/replyTimestamp/README.md deleted file mode 100644 index b7952bf3..00000000 --- a/src/plugins/replyTimestamp/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# ReplyTimestamp - -Shows timestamps on the previews of replied-to messages. Pretty simple. - -![](https://github.com/Vendicated/Vencord/assets/1547062/62e2b67a-e567-4c7a-884d-4640f897f7e0) diff --git a/src/plugins/searchReply/README.md b/src/plugins/searchReply/README.md deleted file mode 100644 index cca952df..00000000 --- a/src/plugins/searchReply/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# SearchReply - -Adds a reply button to search results. - -![the plugin in action](https://github.com/verticalsync/Suncord/assets/45497981/07e741d3-0f97-4e5c-82b0-80712ecf2cbb) diff --git a/src/plugins/seeSummaries/README.md b/src/plugins/seeSummaries/README.md deleted file mode 100644 index 1c8b6c79..00000000 --- a/src/plugins/seeSummaries/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# Summaries - -Enables Discord's experimental Summaries feature on every server, displaying AI generated summaries of conversations. - -Read more about summaries in the [official Discord help article](https://support.discord.com/hc/en-us/articles/12926016807575-In-Channel-Conversation-Summaries)! - -Note that this plugin can't fetch old summaries, it can only display ones created while your Discord is running with the plugin enabled. - -![](https://github.com/Vendicated/Vencord/assets/45497981/bd931b0c-2e85-4c10-9f7c-8ba01eb55745) diff --git a/src/plugins/serverInfo/README.md b/src/plugins/serverInfo/README.md deleted file mode 100644 index 98c9013e..00000000 --- a/src/plugins/serverInfo/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# ServerInfo - -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) -![Available as "Server Profile" option in the server context menu](https://github.com/Vendicated/Vencord/assets/45497981/f43be943-6dc4-4232-9709-fbeb382d8e54) diff --git a/src/plugins/showAllRoles/README.md b/src/plugins/showAllRoles/README.md deleted file mode 100644 index d5d99c79..00000000 --- a/src/plugins/showAllRoles/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# ShowAllRoles - -Display all roles on the new profiles instead of limiting them to the default two rows. - -![image](https://github.com/Vendicated/Vencord/assets/71079641/3f021f03-c6f9-4fe5-83ac-a1891b5e4b37) - diff --git a/src/plugins/showHiddenThings/README.md b/src/plugins/showHiddenThings/README.md deleted file mode 100644 index 753e5c14..00000000 --- a/src/plugins/showHiddenThings/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# ShowHiddenThings - -Displays various hidden & moderator-only things regardless of permissions. - -## Features - -- Show member timeout icons in chat -![](https://github.com/Vendicated/Vencord/assets/47677887/75e1f6ba-8921-4188-9c2d-c9c3f9d07101) - -- Show the invites paused tooltip in the server list -![](https://github.com/Vendicated/Vencord/assets/47677887/b6a923d2-ac55-40d9-b4f8-fa6fc117148b) - -- Show the member mod view context menu item in all servers - -![](https://github.com/Vendicated/Vencord/assets/47677887/3dac95dd-841c-4c15-ad87-2db7bd1e4dab) - -- Disable filters in Server Discovery search that hide servers that don't meet discovery criteria - -- Disable filters in Server Discovery search that hide NSFW & disallowed servers diff --git a/src/plugins/showTimeoutDuration/README.md b/src/plugins/showTimeoutDuration/README.md deleted file mode 100644 index 13780247..00000000 --- a/src/plugins/showTimeoutDuration/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# ShowTimeoutDuration - -Displays how much longer a user's timeout will last. -Either in the timeout icon tooltip, or next to it, configurable via settings! - -![indicator in tooltip](https://github.com/Vendicated/Vencord/assets/45497981/606588a3-2646-40d9-8800-b6307f650136) - -![indicator next to timeout icon](https://github.com/Vendicated/Vencord/assets/45497981/ab9d2101-0fdc-4143-9310-9488f056eeee) diff --git a/src/plugins/superReactionTweaks/README.md b/src/plugins/superReactionTweaks/README.md deleted file mode 100644 index 624ab866..00000000 --- a/src/plugins/superReactionTweaks/README.md +++ /dev/null @@ -1,11 +0,0 @@ -# Super Reaction Tweaks - -This plugin applies configurable various tweaks to super reactions. - -![Screenshot](https://user-images.githubusercontent.com/22851444/281598795-58f07116-9f95-4f64-940b-23a5499f2302.png) - -## Features: - -**Super React By Default** - The reaction picker will default to super reactions instead of normal reactions. - -**Super Reaction Play Limit** - Allows you to decide how many super reaction animations can play at once, including removing the limit entirely. diff --git a/src/plugins/themeAttributes/README.md b/src/plugins/themeAttributes/README.md deleted file mode 100644 index fba78e8a..00000000 --- a/src/plugins/themeAttributes/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# ThemeAttributes - -This plugin adds data attributes and CSS variables to various elements inside Discord - -This allows themes to more easily theme those elements or even do things that otherwise wouldn't be possible - -## Available Attributes - -### All Tab Bars (User Settings, Server Settings, etc) - -`data-tab-id` contains the id of that tab - -![image](https://github.com/verticalsync/Suncord/assets/45497981/1263b782-f673-4f09-820c-4cc366d062ad) - -### Chat Messages - -- `data-author-id` contains the id of the author -- `data-author-username` contains the username of the author -- `data-is-self` is a boolean indicating whether this is the current user's message - -![image](https://github.com/Vendicated/Vencord/assets/45497981/34bd5053-3381-402f-82b2-9c812cc7e122) - -## CSS Variables - -### Avatars - -`--avatar-url-` contains a URL for the users avatar with the size attribute adjusted for the resolutions `128, 256, 512, 1024, 2048, 4096`. - -![image](https://github.com/Vendicated/Vencord/assets/26598490/192ddac0-c827-472f-9933-fa99ff36f723) diff --git a/src/plugins/unlockedAvatarZoom/README.md b/src/plugins/unlockedAvatarZoom/README.md deleted file mode 100644 index 9ecd0b1a..00000000 --- a/src/plugins/unlockedAvatarZoom/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# UnlockedAvatarZoom - -Allows you to zoom in further in the image crop tool when changing your avatar - -![](https://raw.githubusercontent.com/Vencord/plugin-assets/main/UnlockedAvatarZoom/demo.avif) diff --git a/src/plugins/validReply/README.md b/src/plugins/validReply/README.md deleted file mode 100644 index 49e313cf..00000000 --- a/src/plugins/validReply/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# ValidReply - -Fixes referenced (replied to) messages showing as "Message could not be loaded". - -Hover the text to load the message! - -![](https://github.com/Vendicated/Vencord/assets/45801973/d3286acf-e822-4b7f-a4e7-8ced18f581af) diff --git a/src/plugins/watchTogetherAdblock.desktop/README.md b/src/plugins/watchTogetherAdblock.desktop/README.md deleted file mode 100644 index 4c64df67..00000000 --- a/src/plugins/watchTogetherAdblock.desktop/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# WatchTogetherAdblock - -Block ads in the YouTube 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) diff --git a/src/plugins/whoReacted/README.md b/src/plugins/whoReacted/README.md deleted file mode 100644 index d047b407..00000000 --- a/src/plugins/whoReacted/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# WhoReacted - -Next to each reaction, display each user's avatar. Each avatar can be clicked and will open the profile. - -![](https://github.com/verticalsync/Suncord/assets/57493648/97fec9e8-396f-4f5e-916e-1ec21445113d) diff --git a/src/plugins/xsOverlay.desktop/README.md b/src/plugins/xsOverlay.desktop/README.md deleted file mode 100644 index f2dfab51..00000000 --- a/src/plugins/xsOverlay.desktop/README.md +++ /dev/null @@ -1,16 +0,0 @@ -# XSOverlay Notifier - -Sends Discord messages to [XSOverlay](https://store.steampowered.com/app/1173510/XSOverlay/) for easier viewing while using VR. - -## Preview - -![](https://github.com/verticalsync/Suncord/assets/24845294/205d2055-bb4a-44e4-b7e3-265391bccd40) - -![](https://github.com/verticalsync/Suncord/assets/24845294/f15eff61-2d52-4620-bcab-808ecb1606d2) - -## Usage - -- Enable this plugin -- Set plugin settings as desired -- Open XSOverlay -- get ping spammed diff --git a/src/suncordplugins/Anammox/README.md b/src/suncordplugins/Anammox/README.md deleted file mode 100644 index 7914bd4b..00000000 --- a/src/suncordplugins/Anammox/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Anammox - -Removes Nitro-exclusive stuff from various places: -- The shops above private chats -- The gift button in the chat box -- The "billing" section in settings - -While this can be done with css, a plugin is able to do it much more thorougly — for example, the shops are still accessible via keyboard navigation. diff --git a/src/suncordplugins/allCallTimers/README.md b/src/suncordplugins/allCallTimers/README.md deleted file mode 100644 index 4bc6f91a..00000000 --- a/src/suncordplugins/allCallTimers/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# AllCallTimers - -Adds a timer to each user in a guild voice call. - -Original author: [AllCallTimersDiscordPlugin](https://github.com/Max-Herbold/AllCallTimersDiscordPlugin) - -image -image -
-image -image -
- -Potential improvements: - -- [ ] Add a log to each voice channel of join/leave and potentially mute/unmute events -- [ ] Add a timer to each user in private voice calls diff --git a/src/suncordplugins/amITyping/README.md b/src/suncordplugins/amITyping/README.md deleted file mode 100644 index 3f157dbe..00000000 --- a/src/suncordplugins/amITyping/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# AmITyping - -Simply shows if you are typing. This is almost exactly what it will look like for other users, so it may show after you have finished typing. diff --git a/src/suncordplugins/betterBanReasons/README.md b/src/suncordplugins/betterBanReasons/README.md deleted file mode 100644 index a87ab1cc..00000000 --- a/src/suncordplugins/betterBanReasons/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# Better Ban Reasons - -- Create custom reasons to use in the Discord ban modal. -- Show a text input by default instead of the options diff --git a/src/suncordplugins/betterScreenshare.dev/README.md b/src/suncordplugins/betterScreenshare.dev/README.md deleted file mode 100644 index e6c79361..00000000 --- a/src/suncordplugins/betterScreenshare.dev/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# Better Screenshare Plugin - -## How to use each Setting? - -- **Audio Source** - Choose a window from the drop-down list and the audio will be shared whether you're streaming a window or a screen. -- **Resolution** - Here you can set the width and the height (both are required). The ideal resolution is the resolution of the monitor you are streaming. An example would be `1080p` (height: `1920` width: `1080`). -- **Framerate** - Here you can set the frame rate. The most common frame rate is `60`, but you can set it higher or lower if you like. -- **Keyframe Interval** - Here you can set the keyframe interval in milliseconds. If you don't know anything about it, just leave it disabled, but if you want to understand it better, read through this [article](https://filmora.wondershare.com/video-editing/keyframe-interval-obs.html). -- **Video Bitrate** - This is one of the most important settings as it affects the quality the most. Discord uses a low bitrate by default, so it's important to set it if you want good quality. If you want to find out your optimal bitrate, go to the video bitrate [section](https://github.com/Vendicated/Vencord/tree/main/src/plugins/betterScreenshare#video-bitrate). -- **Audio Bitrate** - This is almost the same as video bitrate, but it works a little differently for audio. If you want to learn more about it, you can read through this [article](https://www.adobe.com/creativecloud/video/discover/audio-bitrate.html). But I would recommend setting it between `96kb/s` and `320kb/s` (higher means better). -- **Video Codec** - Here you can set your video codec. Discord currently supports 4 codecs. Each codec offers different quality and performance. The most popular codec is **H264**, which I recommend. However, if you have a 40 series card, use the **AV1** codec. - - **AV1** - Only supported on 40-series cards. - - **VP8** - - **VP9** - - **H264** -- **HDR** - Allows streaming in HDR. - -## Bitrate - -To find your optimal bitrate, you must first find your upload speed. You can do this by running a speed test on this [website](https://www.speedtest.net/). When you're done, you'll see a number in the upload field that represents your maximum upload speed in (`Mbps`) `Mb/s`. To use the upload you need to convert it from `Mb/s` to `Kb/s` by multiplying it by `1000`. I'd recommend going a bit lower as you probably won't always hit your max upload speed and it will affect your ping. Heres is a example `5000 Kb/s` -> `4000 Kb/s`. - -**IMPORTANT**: Discord added a cap of `10000 Kb/s`, if you went higher everyone would experience packet loss. It is not known if there is a bypass for this. - -## Presets - -If you don't want to do any of the above, you can just try the presets in the Profile Options tab and see what works best for you. And if you want to change a setting in the preset, you can simply copy it and save it as a new one. - -## Known Issues - -~~When sharing a window directly it can sometimes happen that no changes are applied, the reason for this is currently unknown, but to avoid this you can simply share your whole screen and set the audio source if required.~~ diff --git a/src/suncordplugins/blockKrisp/README.md b/src/suncordplugins/blockKrisp/README.md deleted file mode 100644 index 7966620d..00000000 --- a/src/suncordplugins/blockKrisp/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# BlockKrisp - -Prevent Krisp from loading - -![Screenshot](./screenshot.png) diff --git a/src/suncordplugins/commandPalette/3_COMMAND_PALETTE.md b/src/suncordplugins/commandPalette/3_COMMAND_PALETTE.md deleted file mode 100644 index d3c72c40..00000000 --- a/src/suncordplugins/commandPalette/3_COMMAND_PALETTE.md +++ /dev/null @@ -1,49 +0,0 @@ -# Command Palette Actions Guide - -Welcome to the Command Palette Actions Guide! This guide serves to inform you on how to implement your own actions to the CommandPalette plugin. To do so you have two options: hardcoding or utilizing the `registerAction` function. This guide will focus on using the function as its best practice and is what should be used in most situations. - -> [!IMPORTANT] -> While both methods hardcoding and using `registerAction` offer similar implementations, it's recommended to refrain from Hardcoding unless you solely plan on using this locally. - -### Implementing Multiple Choice Modals - -```ts -registerAction({ - id: "multipleChoiceCommand", - label: "Multiple Choice", - callback: async () => { - // Open a modal with multiple choices - const choice = await openMultipleChoice([ - { id: "test1", label: "Test 1" }, - { id: "test2", label: "Test 2" }, - ]); - - // Log the selected choice with its label and ID - console.log(`Selected ${choice.label} with the ID ${choice.id}`); - }, -}); -``` - -- **ID**: A unique identifier for the command/action, ensuring uniqueness across specific options in that modal instance. -- **Label**: The text displayed in the command palette for user recognition. -- **Callback (optional)**: The function executed when the command is triggered. - -Inside the callback, the `openMultipleChoice` function opens a modal with a list of choices. Users can select an option, and upon choosing, a `ButtonAction` type is returned. The user's choice is then logged for reference. - -### Implementing String Input Modals - -```ts -registerAction({ - id: "stringInputCommand", - label: "String Input", - callback: async () => { - // Open a modal with a text input - const text = await openSimpleTextInput(); - - // Log the inputted text to console - console.log(`They typed: ${text}`); - }, -}); -``` - -When the `stringInputCommand` is triggered, a modal with a simple text input field appears. Users can input text, and the entered string is returned. In this case, we log their input to console. diff --git a/src/suncordplugins/discordColorways/README.md b/src/suncordplugins/discordColorways/README.md deleted file mode 100644 index a2cd8158..00000000 --- a/src/suncordplugins/discordColorways/README.md +++ /dev/null @@ -1,10 +0,0 @@ -# DiscordColorways-VencordUserplugin -A repo for the Vencord userplugin version of DiscordColorways - -To install the plugin: -* Go inside your Vencord fork's `userplugins` folder -* Open a terminal there -* Run: -```bash -git clone https://github.com/DaBluLite/DiscordColorways-VencordUserplugin.git discordColorways -``` diff --git a/src/suncordplugins/followUser/README.md b/src/suncordplugins/followUser/README.md deleted file mode 100644 index 309c55b2..00000000 --- a/src/suncordplugins/followUser/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# FollowUser - -Adds a follow option in the user context menu to always be in the same VC as them - -![Screenshot](./screenshot.png) diff --git a/src/suncordplugins/holyNotes/README.md b/src/suncordplugins/holyNotes/README.md deleted file mode 100644 index 11da2106..00000000 --- a/src/suncordplugins/holyNotes/README.md +++ /dev/null @@ -1 +0,0 @@ -# HolyNotes \ No newline at end of file diff --git a/src/suncordplugins/ignoreTerms/README.md b/src/suncordplugins/ignoreTerms/README.md deleted file mode 100644 index b014411a..00000000 --- a/src/suncordplugins/ignoreTerms/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# IgnoreTerms - -Ignore Discord's new terms of service - -![Screenshot](./screenshot.png) diff --git a/src/suncordplugins/mediaDownloader.desktop/README.md b/src/suncordplugins/mediaDownloader.desktop/README.md deleted file mode 100644 index b8263eb5..00000000 --- a/src/suncordplugins/mediaDownloader.desktop/README.md +++ /dev/null @@ -1,48 +0,0 @@ -# MediaDownloader - -This plugin adds a new `/download` command. This command downloads a video from a given url, and creates a video attachment, ready to send. - -![](https://github.com/Vendicated/Vencord/assets/18369995/4b396740-f128-41f9-9392-90ff7bc2a104) - -## Requirements - -This plugin requires that [yt-dlp](https://github.com/yt-dlp/yt-dlp) is insalled on the system, and accessible by Discord. This usually just means that it should be on PATH. -An optional dependency is [ffmpeg](https://ffmpeg.org/). Note that many installations of `yt-dlp` already come with `ffmpeg` preinstalled. - -Yt-dlp is required for core functionality, e.g. downloading videos. Ffmpeg can also be installed to allow for local merging and muxing of video tracks. This means that, with ffmpeg installed, yt-dlp will be able to download video and audio separately and later merge them, which allows you to end up with higher quality videos without increasing filesize. -Ffmpeg is also required to use the Gif format, as they are not supported natively by most video sources. - -## Usage - -The plugin adds a single application command, activated by typing `/download`. It has the following parameters. - -| name | required | description | -| ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | Yes | URL of the video to download. Supports any urls also supported by `yt-dlp`, most famously YouTube. | -| `format` | No | The upload format, either Video, Audio or GIF. GIF requires ffmpeg to be installed. Defaults to Video. | -| `gif_quality` | No | Gif quality level when using `format:GIF`. You cannot dynamically determine gif quality based on target filesize like is possible with Audio and Video, so this option exists to make it possible to increas/decrease the quality of the gif as desired or needed. Defaults to 3. | -| `yt-dlp_args` | No | Additional command line arguments to pass to yt-dlp¹. These will take precedence over the default arguments used by the plugin. See the yt-dlp documentation for more information. | -| `ffmpeg_args` | No | Additional command line arguments to pass to ffmpeg². These will take precedence over the default arguments used by the plugin. See the ffmpeg documentation for more information. | - -¹ The default arguments are: `yt-dlp -f -o "download.%(ext)s" --force-overwrites -I 1 --remux-video ` where: - -- `` is a custom download format visible [here](./native.ts##L117-L147), -- `--remux-video ` is only available when ffmpeg is installed, -- `` is equal to `"webm>webm/mp4"` for video and `mp3` for audio. - -² The default arguments are: - -- Audio: `ffmpeg -i -b:a k -maxrate k -bufsize 1M -y remux.mp3`. -- Video: `ffmpeg -i -b:v k -b:a k -maxrate k -bufsize 1M -y -filter:v scale=-1:`. -- GIF: `ffmpeg -i -vf fps=,scale=w=:h=-1:flags=lanczos,mpdecimate,split[s0][s1];[s0]palettegen=max_colors=[p];[s1][p]paletteuse=dither=bayer:bayer_scale= -loop 0 -bufsize 1M -y`. - - where - -- `` is the output from the `yt-dlp` command, -- `` is the total target bitrate, based on your nitro upload limit, -- `` is `*0.8`, bitrate for video, -- `` is `*0.2`, bitrate for audio, -- `` is the video size (480p, 720p or 1080p) calculated based on the target bitrate. -- ``, ``, `` and `` are based on the `gif_quality` selected. - -Note that you cannot use the above variables in your additional command line arguments. diff --git a/src/suncordplugins/mediaPlaybackSpeed/README.md b/src/suncordplugins/mediaPlaybackSpeed/README.md deleted file mode 100644 index 066a2406..00000000 --- a/src/suncordplugins/mediaPlaybackSpeed/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# MediaPlaybackSpeed - -Adds an icon to change the playback speed of media embeds - -![New icon with menu to change the playback speed](https://github.com/Vendicated/Vencord/assets/24937357/21792b09-8d6a-45be-a6e8-916cdd67a477) diff --git a/src/suncordplugins/messageColors/README.md b/src/suncordplugins/messageColors/README.md deleted file mode 100644 index 4eac3dbc..00000000 --- a/src/suncordplugins/messageColors/README.md +++ /dev/null @@ -1,12 +0,0 @@ -### MessageColors - -Displays hex/rgb/hsl colors in messages with a tiny-colored box nearby :3 -Also adds color picker in message input - -#### Block Display - -![](https://github.com/Vendicated/Vencord/assets/68553709/c72c82a7-cec0-471f-a52a-2f28cee6ec00) - -#### Color Picker - -![](https://github.com/Vendicated/Vencord/assets/68553709/c0ed8505-efb6-42f2-91e2-d8179f17fa0f) diff --git a/src/suncordplugins/messageLoggerEnhanced/README.md b/src/suncordplugins/messageLoggerEnhanced/README.md deleted file mode 100644 index b610792d..00000000 --- a/src/suncordplugins/messageLoggerEnhanced/README.md +++ /dev/null @@ -1,108 +0,0 @@ -# vc-message-logger-enhanced - -## What is this? - -This is a third-party-plugin for [Vencord](https://vencord.dev/) that logs messages, images, and ghost pings in Discord. -The plugin saves messages to a json file, and can restore them after reloading Discord. - -## Features - -- Restore deleted and edited messages even after reloading Discord (optional). -- Log messages from channels or DMs you haven't opened. -- Save deleted images -- View logs in a modal that shows your logged messages. - - Sort messages based on timestamps. - - Search logs by channel ID, user ID, server ID, and message ID. - - Ghost Pinged tab to track and view ghost pings. -- Set a message limit to manage the number of saved logs (settings). -- Blacklist servers, channels, and users to prevent logging specific content. -- Whitelist feature to selectively allow logging for specific servers, channels, or users. -- Whitelist overrides server blacklist, allowing logging of whitelisted users' actions in blacklisted servers and channels. -- Export logs for backup and analysis purposes. -- Import logs to restore previous logging data. - -> [!NOTE] -> The "Cache Messages From Servers" Option basically treats all servers as whitelisted if its not blacklisted. If you have a lot of servers, this can cause a lot of messages to be logged. - -# How to Install - -tutorial: https://youtu.be/8wexjSo8fNw - -# How to manually update - -https://github.com/Syncxv/vc-message-logger-enhanced/assets/47534062/31be3fcb-71db-4714-9d94-99b340371e96 - -# Changelog - -## 3.0.1 -- Delete message without it being logged by other message loggers (by [@redbaron2k7](https://github.com/redbaron2k7)) - -## 3.0.0 - -- Added updater - -## 2.0.4 - -- Fix always log current channel -- Fix channel reloading due to invalid attachments -- Started storing deleted timestamps - -## 2.0.2 - -- Fix image saving -- Improve security - -## 2.0.0 - -- Use native api -- save logs to a real file -- fix some image bugs - -## Version 1.4.0 - -- Save Images :D - -## Version 1.3.2 - -- Fixed Modal and Toolbox Icon -- Made update message less confusing https://github.com/Syncxv/vc-message-logger-enhanced/issues/2 - -## Version 1.3.1 - -- Added option to always log Direct Messages by [@CatGirlDShadow](https://github.com/CatGirlDShadow) in https://github.com/Syncxv/vc-message-logger-enhanced/pull/1 -- Added option to always log Selected Channel by [@CatGirlDShadow](https://github.com/CatGirlDShadow) in https://github.com/Syncxv/vc-message-logger-enhanced/pull/1 -- Added option to ignore muted Categories by [@CatGirlDShadow](https://github.com/CatGirlDShadow) in https://github.com/Syncxv/vc-message-logger-enhanced/pull/1 -- Added option to ignore muted Channels by [@CatGirlDShadow](https://github.com/CatGirlDShadow) in https://github.com/Syncxv/vc-message-logger-enhanced/pull/1 - -## Version 1.3.0 - -- Log bulk deleted messages (feat) -- Ignore muted guild option (feat) -- Fix Limits not working (fix) -- Fix message limit not working (fix) - -most of the big exams are over :D -can finally go back to makin tuff - -## Version 1.2.0 - -- Render Embeds in logs modal :D - -## Version 1.1.0 - -- Added Whitelist feature -- Improved message caching: - - Graylisted messages that aren't cached by Discord won't be saved -- Added Ghost Ping Tab -- Improved searching functionality: - - Can now search by names in addition to existing search options -- Added an automatic update check feature -- Improved modal performance for better user experience - -# Demo - -https://github.com/Syncxv/vc-message-logger-enhanced/assets/47534062/de932bff-91fe-4825-8ef7-551cf245e51a - -## found a bug? - -Message me on discord. @daveyy1 diff --git a/src/suncordplugins/notifyUserChanges/README.md b/src/suncordplugins/notifyUserChanges/README.md deleted file mode 100644 index 334876bc..00000000 --- a/src/suncordplugins/notifyUserChanges/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# NotifyUserChanges - -Adds a notify option in the user context menu to get notified when a user changes voice channels or online status - -![Context Menu](./context-menu.png) -![Screenshot](./screenshot.png) - -I will not add more features to this plugin. If you're insane you can try https://github.com/zastlx/vc-stalker-plugin diff --git a/src/suncordplugins/silentTyping/README.md b/src/suncordplugins/silentTyping/README.md deleted file mode 100644 index f6651641..00000000 --- a/src/suncordplugins/silentTyping/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# SilentTyping - -Enhanced version of SilentTyping with the feature to disable it for specific guilds or users - -![Screenshot User](./screenshot-user.png) -![Screenshot Guild](./screenshot-guild.png) diff --git a/src/suncordplugins/themeLibrary/README.md b/src/suncordplugins/themeLibrary/README.md deleted file mode 100644 index 945ecec9..00000000 --- a/src/suncordplugins/themeLibrary/README.md +++ /dev/null @@ -1,17 +0,0 @@ -## ThemeLibrary - -Add Themes directly within Vencord! - -### Features - -- Ability to submit themes -- You are able to like your favourite themes -- ... more may or may not be added in the future - -## Installation - -The installation guide can be found [here](https://discord.com/channels/1015060230222131221/1257038407503446176/1257038407503446176) or via [the official Vencord Docs](https://docs.vencord.dev/installing/custom-plugins/)! - -## Preview - -