klasa-giveaway
TypeScript icon, indicating that this package has built-in type declarations

1.3.0 • Public • Published

Klasa Giveaway Plugin

npm npm Total alerts Language grade: JavaScript Dependabot Status

This plugin adds a customisable giveway feature in your discord klasa bot. It comes with the following commands:

  1. gcreate - Creates a giveaway in the specified channel!
  2. gdelete - Deletes a giveaway!
  3. gend - Ends a giveaway immediately
  4. glist - Lists all running giveaways in the server
  5. greroll - Rerolls a previously finished giveaway.
  6. gstart - Immediately starts a giveaway in the current channel

NOTE:

Features

  • Customizable built-in commands
  • Dynamic refresh intervals
  • Automatic loading and restarting of giveaways
  • Customizable embeds and locales

How to use

  1. Install the plugin

    npm i klasa-giveaway yarn add klasa-giveaway

  2. Use the plugin in your code

    const { Client } = require("klasa");
     
    Client.use(require("klasa-giveaway"));
    new Client().login("Your Beautiful Token");

    or in typescript

    import { Client } from 'klasa';
    import { GiveawayClient } from 'klasa-giveaway';
     
    Client.use(GiveawayClient);
    new Client().login("Your Beautiful Token");

GiveawayOptions

  • To your KlasaClientOptions you can optionally add giveaway options.

    For example:

    new Client({
        giveaway: {
            maxGiveaways: 5,
            requiredPermission: 5,
            provider: 'mongodb'
        }
    })

    For a list of giveaway options see here

  • It also allows you to define your own locales. See built in en-US Locale

Contact

  • ImmortalSnake#0449

Credits

Readme

Keywords

Package Sidebar

Install

npm i klasa-giveaway

Weekly Downloads

0

Version

1.3.0

License

MIT

Unpacked Size

36.7 kB

Total Files

41

Last publish

Collaborators

  • immortalsnake