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

feat: gitignored src/userplugins directory (#112)

Browse source
This commit is contained in:
megumin 2022-10-17 22:46:52 +01:00 • committed by GitHub
parent 5a18292d92
commit 9d6021f0b9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 34 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/2_PLUGINS.md
View file

@ -6,7 +6,9 @@ You don't need to run `pnpm build` every time you make a change. Instead, use `p
## Plugin Entrypoint
1. Create a folder in `src/plugins/` with the name of your plugin. For example, `src/plugins/epicPlugin/` - All of your plugin files will go here.
> If it doesn't already exist, create a folder called `userplugins` in the `src` directory of this repo.
1. Create a folder in `src/userplugins/` with the name of your plugin. For example, `src/userplugins/epicPlugin/` - All of your plugin files will go here.
2. Create a file in that folder called `index.ts`
@ -20,7 +22,7 @@ export default definePlugin({
description: "This plugin is absolutely epic",
authors: [
{
id: "your discord user id goes here",
id: 12345n,
name: "Your Name",
},
],
@ -33,6 +35,8 @@ export default definePlugin({
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
Vencord uses a different way of making mods than you're used to.
@ -97,7 +101,9 @@ abc.isStaff = function () {
The match value _can_ be a string, rather than regex, however usually regex will be better suited, as it can work with unknown values, whereas strings must be exact matches.
Once you've made your plugin, make sure you run `pnpm lint` and make sure your code is nice and clean, and then open a PR on github :)
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!
> **Warning**
> Make sure you've read [CONTRIBUTING.md](../CONTRIBUTING.md) before opening a PR