Equicord/README.md

172 lines
6.1 KiB
Markdown
Raw Normal View History

2024-05-23 01:21:35 -04:00
# Equicord
2024-05-23 00:23:49 -04:00
2024-05-23 01:26:19 -04:00
An enhanced version of [Vencord](https://github.com/Vendicated/Vencord) by [Vendicated](https://github.com/Vendicated) called Equicord.
2024-04-18 19:15:01 -04:00
2024-04-17 14:29:47 -04:00
![image](https://i.ibb.co/xgNr2gq/image-2023-11-24-122019133.png)
2023-04-27 20:17:33 -04:00
2022-08-29 16:05:22 -04:00
## Features
2024-04-17 14:29:47 -04:00
- Third-party plugins implemented into the main build.
- 100+ plugins built-in.
2024-04-18 19:15:01 -04:00
- Some highlights: SpotifyControls, MessageLogger, Experiments, GameActivityToggle, Translate, NoTrack, QuickReply, Free Emotes/Stickers, PermissionsViewer,
2024-04-17 14:29:47 -04:00
CustomCommands, ShowHiddenChannels, PronounDB
2023-02-28 16:37:09 -05:00
- Fairly lightweight despite the many inbuilt plugins
2024-04-17 14:29:47 -04:00
- Works on any Discord branch: Stable, Canary or PTB all work (though for the best experience, I recommend stable!)
- Custom CSS and Themes: Inbuilt CSS editor with support to import any CSS files (including BetterDiscord themes)
2023-02-28 16:38:02 -05:00
- Privacy friendly, blocks Discord analytics & crash reporting out of the box and has no telemetry
2023-01-15 23:19:04 -05:00
- Maintained very actively, broken plugins are usually fixed within 12 hours
2024-04-17 14:29:47 -04:00
- Able to update inside of Equicord through the update tab.
- Same supporter badges as on Vencord (Don't lose your benefits)
- Easy to install third-party plugins through the plugin page in Discord.
- Request for plugins from Discord.
2023-04-27 20:17:33 -04:00
<details>
<summary>Extra included plugins (69 additional plugins)</summary>
- AllCallTimers by MaxHerbold and D3SOX
- AltKrispSwitch by newwares
- Annamox by Kyuuhachi
- BetterQuests by kvba
- BetterQuickReact by Ven and Sqaaakoi
- BetterShopPreview by Tolgchu
- BlockKrsip by D3SOX
- BypassDND by Inbestigator
- CleanChannelName by AutumnVN
- ColorMessage by Kyuuhachi
- CopyUserMention by Cortex and castdrian
2024-06-06 03:30:30 -04:00
- CustomAppIcons by Happy Enderman and SerStars
- CustomScreenShare by KawaiianPizza
- DNDWhilePlaying by thororen
- DoNotLeak by Perny
- DoubleCounterBypass by nyx
- EmojiDumper by Cortex, Samwich, Woosh
- EquicordCSS by FoxStorm1 and thororen (and all respective css developers)
- ExportContacts by dat_insanity
- FakeProfileThemes by Ryan
- FindReply by newwares
- FriendshipRanks by Samwich
- GlobalBadges by HypedDomi and Hosted by Wolfie
- GodMode by Tolgchu
- HideMessage by Hanzy
- HolyNotes by Wolfie
- Hop On by ImLvna
- IgnoreTerms by D3SOX
- IRememberYou by zoodogood
- Keyboard Sounds by HypedDomi
- KeywordNotify by camila314
- MessageLinkTooltip by Kyuuhachi
- MessageLoggerEnhanced (MLEnhanced) by Aria
- noAppsAllowed by kvba
- NoModalAnimation by AutumnVN
- NoNitroUpsell by thororen
- NotifyUserChanges by D3SOX
- OnePingPerDM by ProffDea
- PlatformSpoofer by Drag
- MessagePurge by bhop and nyx
- QuestionMarkReplacement (QuestionMarkReplace) by nyx
- Quoter by Samwich
- RepeatMessage by Tolgchu
- ReplyPingControl by ant0n and MrDiamond
- ScreenRecorder by AutumnVN
- Search by JacobTm and thororen
2024-06-01 14:32:22 -04:00
- SearchFix by Jaxx
- Sekai Stickers by MaiKokain
- ServerProfilesToolbox by D3SOX
- ShowBadgesInChat by Inbestigator and KrystalSkull
- Slap by Korbo
- SoundBoardLogger by Moxxie, fres, echo, thororen
- TalkInReverse by Tolgchu
- ThemeLibrary by Fafa
- Title by Kyuuhachi
- UnlimitedAccounts by Balaclava and thororen
- UserPFP by nexpid and thororen
- VCSupport by thororen
- VencordRPC by AutumnVN
- VoiceChatUtilities by Dams and D3SOX
- WhosWatching by fres
- YoutubeDescription by arHSM
2024-05-23 01:26:19 -04:00
</details>
2022-10-03 10:43:11 -04:00
2022-10-07 19:44:12 -04:00
## Installing / Uninstalling
2022-08-29 16:08:44 -04:00
2024-04-17 14:29:47 -04:00
### Dependencies
[Git](https://git-scm.com/download) and [Node.JS LTS](https://nodejs.dev/en/) are required.
2023-05-14 07:16:18 -04:00
2024-04-17 14:29:47 -04:00
### Installing Equicord
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-07 19:44:12 -04:00
2024-04-17 14:29:47 -04:00
Install dependencies:
2023-11-12 19:37:15 -05:00
2024-04-17 14:29:47 -04:00
```shell
pnpm install --frozen-lockfile
```
2023-11-12 19:37:15 -05:00
2024-04-17 14:29:47 -04:00
Build Equicord:
```shell
pnpm build
```
Inject Equicord into your client:
```shell
pnpm inject
```
After you have done this command, it will look like you are just installing Equicord but it will say it is a development build. If it doesn't say it is a development build, please reach out for support in the [Discord Server](https://discord.gg/5Xh2W87egW)
## Join our Support/Community Server
https://discord.gg/5Xh2W87egW
2023-11-12 19:37:15 -05:00
2024-05-23 01:26:19 -04:00
## Credits
Thank you to [Suncord](https://github.com/verticalsync/Suncord) by [VerticalSync](https://github.com/verticalsync) for helping me when needed.
2024-05-23 01:27:07 -04:00
Thank you to [Vendicated](https://github.com/Vendicated) for creating [Vencord](https://github.com/Vendicated/Vencord).
2024-05-23 01:26:19 -04:00
2023-07-31 23:35:45 -04:00
## Star History
2024-04-17 14:29:47 -04:00
<a href="https://star-history.com/#Equicord/Equicord&Timeline">
2023-07-31 23:35:45 -04: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-07-31 23:35:45 -04:00
</picture>
</a>
2023-04-27 20:17:33 -04:00
## Disclaimer
2022-10-07 19:44:12 -04:00
2023-04-27 20:17:33 -04: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-27 20:17:33 -04:00
<details>
<summary>Using Equicord violates Discord's terms of service</summary>
2023-04-27 20:17:33 -04:00
Client modifications are against Discords Terms of Service.
2022-10-07 19:44:12 -04: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 dont use plugins that implement abusive behaviour. But no worries, all inbuilt plugins are safe to use!
2022-09-01 22:11:52 -04: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 11:37:41 -04: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 11:37:41 -04:00
2023-04-27 20:17:33 -04:00
</details>