Skip to content

Commit a88c3f5

Browse files
committed
Completed plugin overhaul - need to deploy it to prod
1 parent fb80d10 commit a88c3f5

12 files changed

Lines changed: 2351 additions & 112 deletions

File tree

.env.example

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,14 @@ ENABLE_XP_SYSTEM=true
6666
ENABLE_TICKET_SYSTEM=true
6767
ENABLE_MODERATION=true
6868

69+
# ==============================================
70+
# 🔌 Plugin System Configuration
71+
# ==============================================
72+
# URL for the plugin marketplace registry (JSON file)
73+
# See REGISTRY-SETUP.md for setting up your own registry
74+
# Leave empty to use built-in default plugins
75+
PLUGIN_REGISTRY_URL=
76+
6977
# ==============================================
7078
# 🚀 Quick Setup Guide:
7179
# ==============================================

CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,53 @@ git push origin feature/amazing-new-feature
162162
7. **Push** to your branch
163163
8. **Submit** a Pull Request
164164

165+
### Creating Plugins
166+
167+
You can extend VAISH by creating plugins! Plugins can add commands, dashboards, and custom functionality.
168+
169+
**Quick Start:**
170+
171+
```bash
172+
# Create your plugin
173+
mkdir plugins/vaish-plugin-my-plugin
174+
cd plugins/vaish-plugin-my-plugin
175+
176+
# Create plugin.json
177+
echo '{
178+
"name": "vaish-plugin-my-plugin",
179+
"version": "1.0.0",
180+
"description": "My awesome plugin",
181+
"author": "YourName",
182+
"main": "index.js"
183+
}' > plugin.json
184+
185+
# Create index.js
186+
echo 'async function load(ctx) {
187+
ctx.logger.info("My plugin loaded!");
188+
189+
ctx.registerCommand({
190+
data: { name: "hello", description: "Say hello" },
191+
async execute(interaction) {
192+
await interaction.reply("Hello from my plugin!");
193+
}
194+
});
195+
}
196+
module.exports = { load };' > index.js
197+
```
198+
199+
**Publish to npm:**
200+
201+
```bash
202+
npm login
203+
npm publish
204+
```
205+
206+
**Add to Marketplace:**
207+
208+
Submit a PR to the [VAISH Plugin Registry](https://github.com/vaish-plugin-registry/registry) to have your plugin listed in the marketplace.
209+
210+
See [CREATE-PLUGIN.md](./CREATE-PLUGIN.md) for complete documentation.
211+
165212
### Development Guidelines
166213

167214
- **Code Style**: Consistent formatting with Prettier

0 commit comments

Comments
 (0)