Skip to content
This repository has been archived by the owner on Jun 22, 2022. It is now read-only.

Library to assist in creating banners for BetterDiscord plugins

License

Notifications You must be signed in to change notification settings

notmike101/betterdiscord-plugin-banners

Repository files navigation

BetterDiscord Plugin Banners Library

NOTICE

This library is deprecated in favor of betterdiscord-plugin-libs.


Library to assist in displaying a top banner bar for BetterDiscord plugins.

NPM

Full Documentation: https://notmike101.github.io/betterdiscord-plugin-banners/

Installation

npm install betterdiscord-plugin-banners

Usage

This plugin should be compatible with both ESM and CJS.

To display a banner, use the createBanner method.

Example

CJS

const { Banners } = require('betterdiscord-plugin-banners');

class Plugin {
  load() {
    this.banners = new Banners();
  }

  start() {
    this.banners.createBanner('This is a banner', {
      acceptCallback: () => { console.log('Accepted!' )},
    });
  }
}

module.exports = Plugin;

ESM

import { Banners } from 'betterdiscord-plugin-banners';

class Plugin {
  load() {
    this.banners = new Banners();
  }

  start() {
    this.banners.createBanner('This is a banner', {
      acceptCallback: () => { console.log('Accepted!' )},
    });
  }
};

export default Plugin;