mirrors/Equicord
1
1
Fork 0
mirror of https://github.com/Equicord/Equicord.git synced 2025-06-14 09:03:03 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

forked!!

Browse source
This commit is contained in:
thororen 2024-04-17 14:29:47 -04:00
parent 538b87062a
commit ea7451bcdc
326 changed files with 24876 additions and 2280 deletions
Download patch file Download diff file Expand all files Collapse all files

40
docs/1_INSTALLING.md
View file

@ -1,26 +1,26 @@
> [!WARNING]
> These instructions are only for advanced users. If you're not a Developer, you should use our [graphical installer](https://github.com/Vendicated/VencordInstaller#usage) instead.
> No support will be provided for installing in this fashion. If you cannot figure it out, you should just stick to a regular install.
> [!WARNING]
> These instructions are only for advanced users. If you're not a Developer, you should use our [graphical installer](https://github.com/Equicord/Installer#usage) instead.
> No support will be provided for installing in this fashion. If you cannot figure it out, you should just stick to a regular install.
# Installation Guide
Welcome to Megu's Installation Guide! In this file, you will learn about how to download, install, and uninstall Vencord!
Welcome to Megu's Installation Guide! In this file, you will learn about how to download, install, and uninstall Equicord!
## Sections
- [Installation Guide](#installation-guide)
- [Sections](#sections)
- [Dependencies](#dependencies)
- [Installing Vencord](#installing-vencord)
- [Updating Vencord](#updating-vencord)
- [Uninstalling Vencord](#uninstalling-vencord)
- [Installing Equicord](#installing-equicord)
- [Updating Equicord](#updating-equicord)
- [Uninstalling Equicord](#uninstalling-equicord)
## Dependencies
- Install Git from https://git-scm.com/download
- Install Node.JS LTS from here: https://nodejs.dev/en/
## Installing Vencord
## Installing Equicord
Install `pnpm`:
@ -30,13 +30,13 @@ Install `pnpm`:
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/Vencord instance and you **will** most likely have to reinstall.
> :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 Vencord:
Clone Equicord:
```shell
git clone https://github.com/Vendicated/Vencord
cd Vencord
git clone https://github.com/Equicord/Equicord
cd Equicord
```
Install dependencies:
@ -45,21 +45,19 @@ Install dependencies:
pnpm install --frozen-lockfile
```
Build Vencord:
Build Equicord:
```shell
pnpm build
```
Inject vencord into your client:
Inject Equicord into your client:
```shell
pnpm inject
```
Then fully close Discord from your taskbar or task manager, and restart it. Vencord should be injected - you can check this by looking for the Vencord section in Discord settings.
## Updating Vencord
Then fully close Discord from your taskbar or task manager, and restart it. Equicord should be injected - you can check this by looking for the Equicord section in Discord settings.
If you're using Discord already, go into the `Updater` tab in settings.
@ -71,9 +69,9 @@ To pull latest changes:
git pull
```
If this fails, you likely need to reset your local changes to vencord to resolve merge errors:
If this fails, you likely need to reset your local changes to equicord to resolve merge errors:
> :exclamation: This command will remove any local changes you've made to vencord. Make sure you back up if you made any code changes you don't want to lose!
> :exclamation: This command will remove any local changes you've made to equicord. Make sure you back up if you made any code changes you don't want to lose!
```shell
git reset --hard
@ -88,10 +86,12 @@ pnpm build
Then just refresh your client
## Uninstalling Vencord
## Uninstalling Equicord
Simply run:
```shell
pnpm uninject
```
If you need more help, ask in the support channel in our [Discord Server](https://discord.gg/D9uwnFnqmd).

8
docs/2_PLUGINS.md
View file

@ -2,7 +2,7 @@
Welcome to Megu's Plugin Guide! In this file, you will learn about how to write your own plugin!
You don't need to run `pnpm build` every time you make a change. Instead, use `pnpm watch` - this will auto-compile Vencord whenever you make a change. If using code patches (recommended), you will need to CTRL+R to load the changes.
You don't need to run `pnpm build` every time you make a change. Instead, use `pnpm watch` - this will auto-compile Equicord whenever you make a change. If using code patches (recommended), you will need to CTRL+R to load the changes.
## Plugin Entrypoint
@ -37,9 +37,9 @@ Change the name, description, and authors to your own information.
Replace `12345n` with your user ID ending in `n` (e.g., `545581357812678656n`). If you don't want to share your Discord account, use `0n` instead!
## How Plugins Work In Vencord
## How Plugins Work In Equicord
Vencord uses a different way of making mods than you're used to.
Equicord uses a different way of making mods than you're used to.
Instead of monkeypatching webpack, we directly modify the code before Discord loads it.
This is _significantly_ more efficient than monkeypatching webpack, and is surprisingly easy, but it may be confusing at first.
@ -103,7 +103,7 @@ The match value _can_ be a string, rather than regex, however usually regex will
Once you've made your plugin, make sure you run `pnpm test` and make sure your code is nice and clean!
If you want to publish your plugin into the Vencord repo, move your plugin from `src/userplugins` into the `src/plugins` folder and open a PR!
If you want to publish your plugin into the Equicord repo, move your plugin from `src/userplugins` into the `src/plugins` folder and open a PR!
> **Warning**
> Make sure you've read [CONTRIBUTING.md](../CONTRIBUTING.md) before opening a PR