Equicord/README.md

316 lines
10 KiB
Markdown
Raw Normal View History

# [<img src="./browser/icon.png" width="40" align="left" alt="Equicord">](https://github.com/Equicord/Equicord) Equicord
2024-05-23 00:23:49 -04:00
2024-08-25 13:18:16 -06:00
[![Equibop](https://img.shields.io/badge/Equibop-grey?style=flat)](https://github.com/Equicord/Equibop)
[![Tests](https://github.com/Equicord/Equicord/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/Equicord/Equicord/actions/workflows/test.yml)
2025-03-30 12:57:16 -04:00
[![Discord](https://img.shields.io/discord/1173279886065029291.svg?color=768AD4&label=Discord&logo=discord&logoColor=white)](https://discord.gg/5Xh2W87egW)
2024-04-18 19:15:01 -04:00
2024-08-25 13:18:16 -06:00
Equicord is a fork of [Vencord](https://github.com/Vendicated/Vencord), with over 300+ plugins.
2023-04-28 02:17:33 +02:00
You can join our [discord server](https://discord.gg/5Xh2W87egW) for commits, changes, chat or even support.
2023-04-28 02:17:33 +02:00
2024-08-25 13:18:16 -06:00
### Extra included plugins
2025-03-30 12:57:16 -04:00
<details>
2025-06-10 16:34:52 -04:00
<summary>187 additional plugins</summary>
2024-10-29 02:30:38 -04:00
### All Platforms
2025-03-30 12:57:16 -04:00
- AllCallTimers by MaxHerbold & D3SOX
- AltKrispSwitch by newwares
- AlwaysExpandProfile by thororen
- AmITyping by MrDiamond
- Anammox by Kyuuhachi
- AudiobookShelfRPC by vMohammad
- AtSomeone by Joona
- BannersEverywhere by ImLvna & AutumnVN
- BetterActivities by D3SOX, Arjix, AutumnVN
- BetterAudioPlayer by Creations
- BetterBanReasons by Inbestigator
- BetterBlockedUsers by TheArmagan
- BetterInvites by iamme
- BetterPlusReacts by Joona
- BetterQuickReact by Ven & Sqaaakoi
- BlockKeywords by catcraft
- BlockKrisp by D3SOX
- BypassPinPrompt by thororen
- BypassStatus by Inbestigator & thororen
- ChannelBadges by Creations
- ChannelTabs by TheSun, TheKodeToad, keifufu, Nickyux
- CharacterCounter by Creations & Panniku
- CleanChannelName by AutumnVN
- ClientSideBlock by Samwich
- CommandPalette by Ethan
- CopyStickerLinks by Byeoon
- CopyUserMention by Cortex & castdrian
- CustomFolderIcons by sadan
- CustomSounds by TheKodeToad & SpikeHD
- CustomTimestamps by Rini, nvhrr, Suffocate, Obsidian
- CustomUserColors by mochienya
- CuteAnimeBoys by ShadyGoat
- CuteNekos by echo
- CutePats by thororen
- DecodeBase64 by ThePirateStoner
- Demonstration by Samwich
- DisableAnimations by S€th
- DisableCameras by Joona
- DontFilterMe by Samwich
- Encryptcord by Inbestigator
- EquicordHelper by thororen & nyx
- Equissant by SomeAspy & thororen
- ExportContacts by dat_insanity
- FakeProfileThemesAndEffects by ryan
- CopyProfileColors by Crxa
- FastDeleteChannels by thororen
- FindReply by newwares
- FixFileExtensions by thororen
- FollowVoiceUser by TheArmagan
- FontLoader by vmohammad
- ForwardAnywhere by thororen
- Freaky by nyx
- FrequentQuickSwitcher by Samwich
- FriendCodes by HypedDomi
- FriendshipRanks by Samwich
- FriendTags by Samwich
- FullVcPfp by mochie
- GensokyoRadioRPC by RyanCaoDev & Prince527
- GifCollections by Aria & Creations
- GifRoulette by Samwich
- GitHubRepos by talhakf
- Glide by Samwich
- GlobalBadges by HypedDomi & Hosted by Wolfie
- GoogleThat by Samwich
- GuildPickerDumper by Cortex, Samwich, Synth, thororen
- HideChatButtons by iamme
- HideServers by bepvte
- HolyNotes by Wolfie
- HomeTyping by Samwich
- HopOn by ImLvna
- Husk by nin0dev
- IconViewer by iamme
- Identity by Samwich
- IgnoreCalls by TheArmagan
- IgnoreTerms by D3SOX
- ImagePreview by Creations
- ImgToGif by zyqunix
- Ingtoninator by zyqunix
- InRole by nin0dev
- InstantScreenshare by HAHALOSAH & thororen
- IRememberYou by zoodogood
- JellyfinRichPresence by vMohammad
- Jumpscare by Surgedevs
- JumpToStart by Samwich
- KeyboardSounds by HypedDomi
- KeywordNotify by camila314 & x3rt
- LastActive by Crxa
- LimitMiddleClickPaste by no dev listed
- LoginWithQR by nexpid
- MediaPlaybackSpeed by D3SOX
- Meow by Samwich
- MessageBurst by port
- MessageColors by Hen
- MessageFetchTimer by GroupXyz
- MessageLinkTooltip by Kyuuhachi
- MessageLoggerEnhanced by Aria
- MessageTranslate by Samwich
- ModalFade by Kyuuhachi
- MoreCommands by Arjix, echo, Samu
- MoreKaomoji by JacobTm & voidbbg
- MoreStickers by Leko & Arjix
- MoreUserTags by Cyn, TheSun, RyanCaoDev, LordElias, AutumnVN, hen
- Morse by zyqunix
- Moyai by Megu & Nuckyz
- NeverPausePreviews by vappstar
- NewPluginsManager by Sqaaakoi
- NoAppsAllowed by meowabyte
- NoBulletPoints by Samwich
- NoDeleteSafety by Samwich
- NoMirroredCamera by Nyx
- NoModalAnimation by AutumnVN
- NoNitroUpsell by thororen
- NoOnboarding by omaw & Glitch
- NoRoleHeaders by Samwich
- NotificationTitle by Kyuuhachi
- PartyMode by UwUDev
- PingNotifications by smuki
- PinIcon by iamme
- PlatformSpoofer by Drag
- PolishWording by Samwich
- PurgeMessages by bhop & nyx
- QuestCompleter by Amia
- QuestionMarkReplacement by nyx
- Quoter by Samwich
- RandomVoice by xijexo, omaw, thororen
- Remix by MrDiamond
- RemixMe by meowabyte
- RepeatMessage by Tolgchu
- ReplyPingControl by ant0n & MrDiamond
- RPCEditor by Nyako & nin0dev
- RPCStats by Samwich
- SearchFix by Jaxx
- SekaiStickers by MaiKokain
- ServerSearch by camila314
- ShowBadgesInChat by Inbestigator & KrystalSkull
- SidebarChat by Joona
- Signature by Ven, Rini, ImBanana, KrystalSkull
- Slap by Korbo
- Soggy by sliwka
- SoundBoardLogger by Moxxie, fres, echo, maintained by thororen
- SplitLargeMessages by Reycko
- SpotifyActivityToggle by thororen
- SpotifyLyrics by Joona
- StatsfmPresence by Crxa
- StatusPresets by iamme
- SteamStatusSync by niko
- StickerBlocker by Samwich
- StreamingCodecDisabler by davidkra230
- TalkInReverse by Tolgchu
- TeX by Kyuuhachi
- TextToSpeech by Samwich
- ThemeLibrary by Fafa
- TidalEmbeds by vmohammad
- Timezones by Aria
- Title by Kyuuhachi
- ToastNotifications by Skully, Ethan, Buzzy
- ToggleVideoBind by mochie
- TosuRPC by AutumnVN
- Translate+ by Prince527 & Ven
- UnitConverter by sadan
- UnlimitedAccounts by thororen
- UnreadCountBadge by Joona
- UserPFP by nexpid & thororen
- UwUifier by echo
- VCNarratorCustom by Loukios, ported by example-git
- VCPanelSettings by nin0dev
- VCSupport by thororen
- VencordRPC by AutumnVN
- VideoSpeed by Samwich
- ViewRawVariant by Kyuuhachi
- VoiceChatUtilities by D3SOX
- VoiceJoinMessages by Sqaaakoi & maintained by thororen
- WallpaperFree by Joona
- WebpackTarball by Kyuuhachi
- WhitelistedEmojis by Creations
- WhosWatching by fres
- WigglyText by nexpid
- Woof by Samwich
- WriteUpperCase by Samwich & KrystalSkull
- YoutubeDescription by arHSM
2024-05-23 01:26:19 -04:00
2024-10-29 02:30:38 -04:00
### Web Only
2025-03-30 12:57:16 -04:00
- None At This Time
2024-10-29 02:30:38 -04:00
### Vesktop & Equibop Only
2025-03-30 12:57:16 -04:00
- ScreenRecorder by AutumnVN
2024-10-29 02:30:38 -04:00
### Discord Desktop Only
2025-03-30 12:57:16 -04:00
- ClipsEnhancements by niko
- MediaDownloader by Colorman
- NoRPC by Cyn
- StatusWhilePlaying by thororen
2024-10-29 02:30:38 -04:00
### Equicord Devbuilds Only
2025-03-30 12:57:16 -04:00
- FurudoSpeak by example-git
- Shakespearean by vmohammad
- VoiceChannelLog by Sqaaakoi & maintained by thororen
2024-10-29 02:30:38 -04:00
</details>
2022-10-08 00:44:12 +01:00
## Installing / Uninstalling
2022-08-29 22:08:44 +02:00
2024-07-18 19:52:17 -04:00
Windows
2025-03-30 12:57:16 -04:00
- [GUI](https://github.com/Equicord/Equilotl/releases/latest/download/Equilotl.exe)
- [CLI](https://github.com/Equicord/Equilotl/releases/latest/download/EquilotlCli.exe)
2024-07-18 19:52:17 -04:00
MacOS
2025-03-30 12:57:16 -04:00
- [GUI](https://github.com/Equicord/Equilotl/releases/latest/download/Equilotl.MacOS.zip)
2024-07-18 19:52:17 -04:00
Linux
2025-03-30 12:57:16 -04:00
- [GUI-X11](https://github.com/Equicord/Equilotl/releases/latest/download/Equilotl-x11)
- [CLI](https://github.com/Equicord/Equilotl/releases/latest/download/EquilotlCli-Linux)
- [AUR](https://aur.archlinux.org/packages?O=0&K=equicord)
2025-03-30 12:57:16 -04:00
```shell
sh -c "$(curl -sS https://raw.githubusercontent.com/Equicord/Equicord/refs/heads/main/misc/install.sh)"
```
2025-03-30 12:57:16 -04:00
## Installing Equicord Devbuild
2024-04-17 14:29:47 -04:00
### Dependencies
2025-03-30 12:57:16 -04:00
2024-04-17 14:29:47 -04:00
[Git](https://git-scm.com/download) and [Node.JS LTS](https://nodejs.dev/en/) are required.
2023-05-14 13:16:18 +02:00
2024-04-17 14:29:47 -04:00
Install `pnpm`:
> :exclamation: This next command may need to be run as admin/root depending on your system, and you may need to close and reopen your terminal for pnpm to be in your PATH.
```shell
npm i -g pnpm
```
> :exclamation: **IMPORTANT** Make sure you aren't using an admin/root terminal from here onwards. It **will** mess up your Discord/Equicord instance and you **will** most likely have to reinstall.
Clone Equicord:
2024-04-17 14:29:47 -04:00
```shell
git clone https://github.com/Equicord/Equicord
cd Equicord
```
2022-10-08 00:44:12 +01:00
2024-04-17 14:29:47 -04:00
Install dependencies:
2023-11-13 01:37:15 +01:00
2024-04-17 14:29:47 -04:00
```shell
2025-03-03 17:24:03 -05:00
pnpm install --no-frozen-lockfile
2024-04-17 14:29:47 -04:00
```
2023-11-13 01:37:15 +01:00
2024-04-17 14:29:47 -04:00
Build Equicord:
```shell
pnpm build
```
2025-03-30 12:57:16 -04:00
2024-04-17 14:29:47 -04:00
Inject Equicord into your client:
```shell
pnpm inject
```
2023-11-13 01:37:15 +01:00
2024-05-23 01:26:19 -04:00
## Credits
2024-08-25 13:18:16 -06:00
Thank you to [Vendicated](https://github.com/Vendicated) for creating [Vencord](https://github.com/Vendicated/Vencord) & [Suncord](https://github.com/verticalsync/Suncord) by [verticalsync](https://github.com/verticalsync) for helping when needed.
2024-07-29 16:13:44 -04:00
2023-08-01 04:35:45 +01:00
## Star History
2024-04-17 14:29:47 -04:00
<a href="https://star-history.com/#Equicord/Equicord&Timeline">
2023-08-01 04:35:45 +01:00
<picture>
2024-04-17 14:29:47 -04:00
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Equicord/Equicord&type=Timeline&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Equicord/Equicord&type=Timeline" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Equicord/Equicord&type=Timeline" />
2023-08-01 04:35:45 +01:00
</picture>
</a>
2023-04-28 02:17:33 +02:00
## Disclaimer
2022-10-08 00:44:12 +01:00
2023-04-28 02:17:33 +02:00
Discord is trademark of Discord Inc. and solely mentioned for the sake of descriptivity.
2024-04-17 14:29:47 -04:00
Mentioning it does not imply any affiliation with or endorsement by Discord Inc.
Vencord is not connected to Equicord and as such, all donation links go to Vendicated's donation link.
2023-04-28 02:17:33 +02:00
<details>
<summary>Using Equicord violates Discord's terms of service</summary>
2023-04-28 02:17:33 +02:00
Client modifications are against Discord’s Terms of Service.
2022-10-08 00:44:12 +01:00
2024-04-17 14:29:47 -04:00
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 if you don’t use plugins that implement abusive behaviour. But no worries, all inbuilt plugins are safe to use!
2022-09-02 04:11:52 +02:00
2024-04-17 14:29:47 -04:00
Regardless, if your account is essential to you and getting disabled would be a disaster for you, you should probably not use any client mods (not exclusive to Equicord), just to be safe
2023-03-12 16:37:41 +01:00
2024-04-17 14:29:47 -04:00
Additionally, make sure not to post screenshots with Equicord in a server where you might get banned for it
2023-03-12 16:37:41 +01:00
2023-04-28 02:17:33 +02:00
</details>