VIP Configuration
The table below is generated from the local JSON5 config templates found for this plugin. When dashboard-backed configuration is enabled, use the dashboard first because live settings may be stored in MongoDB instead of only reading local JSON5 files.
Config Files
- Source-backed docs were generated from the local plugin source and JSON5 templates.
- Plugin entry:
main.js - Config templates:
en-vip-lang.json5,en-vip.json5
Main Fields
| Field | Type | Default / Template Value | Notes |
|---|---|---|---|
debug | boolean | false | Boolean switch used by the plugin. |
vipRoleId | string | Empty string | Discord role ID or role-related setting. |
defaultDuration | number | 30 | Source-backed config field used by this plugin. |
customRolePrefix | string | ★ | Discord role ID or role-related setting. |
maxCustomRolesPerUser | number | 1 | Discord role ID or role-related setting. |
requiredRoleForCustomRole | string | Empty string | Discord role ID or role-related setting. |
customRoleBasePosition | string | Empty string | Discord role ID or role-related setting. |
paginationPageSize | number | 10 | Source-backed config field used by this plugin. |
embedColor | string | #FFD700 | Controls text or embed output shown in Discord. |
embedFooter | string | ✨ VIP System | Controls text or embed output shown in Discord. |
autoRemoveExpired | boolean | true | Boolean switch used by the plugin. |
autoRegisterOnRoleAssign | boolean | true | Discord role ID or role-related setting. |
autoRemoveOnRoleRemove | boolean | true | Discord role ID or role-related setting. |
expiryCheckInterval | number | 60 | Interval used by scheduled or repeated work. |
notifications.dmOnGrant | boolean | true | Boolean switch used by the plugin. |
notifications.dmOnRemove | boolean | true | Boolean switch used by the plugin. |
notifications.dmOnExpiry | boolean | true | Boolean switch used by the plugin. |
notifications.expiryWarning.enabled | boolean | true | Turns this part of the plugin on or off. |
notifications.expiryWarning.hoursBeforeExpiry | number | 24 | Source-backed config field used by this plugin. |
logging.enabled | boolean | false | Turns this part of the plugin on or off. |
logging.channelId | string | Empty string | Discord channel ID or channel-related setting. |
boosterFeatures.customRole | boolean | true | Discord role ID or role-related setting. |
boosterFeatures.rename | boolean | true | Boolean switch used by the plugin. |
boosterFeatures.color | boolean | true | Boolean switch used by the plugin. |
boosterFeatures.style | boolean | true | Boolean switch used by the plugin. |
boosterFeatures.roleIcon | boolean | true | Discord role ID or role-related setting. |
boosterFeatures.customEmoji | boolean | true | Boolean switch used by the plugin. |
boosterFeatures.shareRole | boolean | true | Discord role ID or role-related setting. |
boosterFeatures.autoReactMention | boolean | true | Boolean switch used by the plugin. |
permissions.vip_command | string | booster | Permission key, role, or access setting used before the action runs. |
permissions.vipmanage_command | string | admin | Permission key, role, or access setting used before the action runs. |
permissions.customrole_command | string | booster | Permission key, role, or access setting used before the action runs. |
permissions.customroles_command | string | admin | Permission key, role, or access setting used before the action runs. |
Notes
- Keep Discord IDs as strings.
- After changing local JSON5 files, restart AthenaBot or reload the plugin so the config manager reads the new values.
- If a dashboard page exists for this plugin, prefer editing there during normal operation.