Giveaways-js NPM

Discord Giveaways | Giveaways-js

Giveaways-js is a powerful Node.js module that allows you to easily create giveaways!

The Features

⏱️ Simple to use!
🔄 Automatic restart after client crash!
🇫🇷 Support for translations: adapt the strings for your own language!
📁 Support for all databases! (default is json)
⚙️ Very customizable! (prize, duration, winners, ignored permissions, etc...)
🔨 Super-powerful: start, edit, reroll, stop, end giveaways!
🕸️ Support for shards!
and more!

Installation

npm i giveaways-js

Examples

Join our Discord Server to get help!

Launch of the module

const Discord = require("discord.js"),
client = new Discord.Client(),
config = {
    prefix: ":?",
    token: "Your_Token"
};

// Requires Manager from giveaways-js
const { GiveawaysManager } = require("giveaways-js");
// Starts updating currents giveaways
const manager = new GiveawaysManager(client, {
    storage: "./giveaways.json",
    updateCountdownEvery: 10000,
    default: {
        botsCanWin: false,
        exemptPermissions: [ "MANAGE_MESSAGES", "ADMINISTRATOR" ],
        embedColor: "#FF0000",
        reaction: "🎉"
    }
});
// We now have the giveawaysManager to access the manager anywhere.
client.giveawaysManager = manager;

client.on("ready", () => {
    console.log("Giveaway? Ready!!");
});

client.login(config.token);

After that, giveaways that are not yet completed will start to be updated again and new giveaways can be started. You can pass an options object to customize the giveaways. Here is a list of them:

client: the discord client (your discord bot instance)
options.storage: the json file that will be used to store giveaways
options.updateCountdownEvery: the number of seconds it will take to update the timers
options.default.botsCanWin: whether the bots can win a giveaway
options.default.exemptPermissions: an array of discord permissions. Members who have at least one of these permissions will not be able to win a giveaway even if they react to it.
options.default.embedColor: a hexadecimal color for the embeds of giveaways.
options.default.embedColorEnd: a hexadecimal color the embeds of giveaways when they are ended.
options.default.reaction: the reaction that users will have to react to in order to participate!

Start the giveaway

client.on("message", (message) => {

    const ms = require("ms"); // npm install ms
    const args = message.content.slice(settings.prefix.length).trim().split(/ +/g);
    const command = args.shift().toLowerCase();

    if(command === "start"){
        // :?start 1d 2 PS 4!
        // will create a giveaway with a duration of one days, with two winner and the prize will be "PS 4"

        client.giveawaysManager.start(message.channel, {
            time: ms(args[0]),
            prize: args.slice(2).join(" "),
            winnerCount: parseInt(args[1])
        }).then((gData) => {
            console.log(gData); // {...} (messageid, end date and more)
        });
        // And the giveaway has started!
    }
});

options.time: the giveaway length.
options.prize: the giveaway prize.
options.hostedBy: the user who hosts the giveaway.
options.winnerCount: the number of giveaway winners.
options.botsCanWin: whether the bots can win a giveaway.
options.exemptPermissions: an array of discord permissions. Members who have at least one of these permissions will not be able to win a giveaway even if they react to it.
options.embedColor: a hexadecimal color for the embeds of giveaways.
options.embedColorEnd: a hexadecimal color the embeds of giveaways when they are ended.
options.reaction: the reaction that users will have to react to in order to participate.

This allows you to start a new giveaway. Once the start() function is called, the giveaway starts and you only have to observe the result, the package does the rest!

Fetch the giveaways

    // The list of all the giveaways
    let allGiveaways = client.giveawaysManager.giveaways; // [ {Giveaway}, {Giveaway} ]

    // The list of all the giveaways on the server with ID "1909282092"
    let onServer = client.giveawaysManager.giveaways.filter((g) => g.guildID === "46947023632097");

    // The list of the current giveaways (not ended)
    let notEnded = client.giveawaysManager.giveaways.filter((g) => !g.ended);

Reroll a giveaway

client.on("message", (message) => {

    const ms = require("ms"); // npm install ms
    const args = message.content.slice(settings.prefix.length).trim().split(/ +/g);
    const command = args.shift().toLowerCase();

    if(command === "reroll"){ // reroll won't work if giveaways are still running
        let messageID = args[0];
        client.giveawaysManager.reroll(messageID).then(() => {
            message.channel.send("Success! Giveaway rerolled!");
        }).catch((err) => { // If giveaway's ID are not found
            message.channel.send("No giveaway found for "+messageID+", please check and try again");
        });
    }

});

options.winnerCount: the number of winners to pick.

Edit a giveaway

client.on("message", (message) => {

    const args = message.content.slice(settings.prefix.length).trim().split(/ +/g);
    const command = args.shift().toLowerCase();

    if(command === "edit"){
        let messageID = args[0];
        client.giveawaysManager.edit(messageID, {
            newWinnerCount: 3,
            newPrize: "New Prize!",
            addTime: 5000
        }).then(() => {
            message.channel.send("Success! Giveaway will updated in less than "+(manager.updateCountdownEvery/1000)+" seconds.");
        }).catch((err) => {
            message.channel.send("No giveaway found for "+messageID+", please check and try again");
        });
    }

});

options.newWinnerCount: the new number of winners.
options.newPrize: the new prize.
options.addTime: the number of milliseconds to add to the giveaway duration.
options.setEndTimestamp: the timestamp of the new end date. Date.now()+1000.

⚠️ Pro Tips: to reduce giveaway time, define addTime with a negative number! For example addTime: -5000 will reduce giveaway time by 5 seconds!

Deleting a giveaway

client.on("message", (message) => {

    const args = message.content.slice(settings.prefix.length).trim().split(/ +/g);
    const command = args.shift().toLowerCase();

    if(command === "delete"){
        let messageID = args[0]; // This will ensure if args[0] is a message ID of the giveaway
        client.giveawaysManager.delete(messageID).then(() => {
            message.channel.send("Success! Giveaway deleted!");
        }).catch((err) => { // If message ID are not giveaway, it'll give an error
            message.channel.send("No giveaway found for "+messageID+", please check and try again");
        });
    }

});

When you use the delete function, the giveaway data and the message of the giveaway are deleted. You cannot restore a giveaway once you have deleted it.

🇫🇷 Translation

You can also pass a messages parameter for start() function, if you want to translate the bot text :

options.messages.giveaway: the message that will be displayed above the embeds.
options.messages.giveawayEnded: the message that will be displayed above the embeds when the giveaway is ended.
options.messages.timeRemaining: the message that displays the remaining time (the timer).
options.messages.inviteToParticipate: the message that invites users to participate.
options.messages.winMessage: the message that will be displayed to congratulate the winner(s) when the giveaway is ended.
options.messages.embedFooter: the message displayed at the bottom of the embeds.
options.messages.noWinner: the message that is displayed if no winner can be drawn.
options.messages.winners: simply the word "winner" in your language.
options.messages.endedAt: simply the words "Ended at" in your language.
options.messages.units.seconds: simply the word "seconds" in your language.
options.messages.units.minutes: simply the word "minutes" in your language.
options.messages.units.hours: simply the word "hours" in your language.
options.messages.units.days: simply the word "days" in your language.

Note: units should be in the plural!

For example :

client.giveawaysManager.start(message.channel, {
    time: ms(args[0]),
    prize: args.slice(2).join(" "),
    winnerCount: parseInt(args[1]),
    messages: {
        giveaway: "@everyone\n\n🎉🎉 **GIVEAWAY** 🎉🎉",
        giveawayEnded: "@everyone\n\n🎉🎉 **GIVEAWAY ENDED** 🎉🎉",
        timeRemaining: "Time remaining: **{duration}**!",
        inviteToParticipate: "React with 🎉 to participate!",
        winMessage: "Congratulations, {winners}! You won **{prize}**!",
        embedFooter: "Giveaways",
        noWinner: "Giveaway cancelled, no valid participations.",
        hostedBy: "Hosted by: {user}",
        winners: "winner(s)",
        endedAt: "Ended at",
        units: {
            seconds: "seconds",
            minutes: "minutes",
            hours: "hours",
            days: "days",
            pluralS: false // Not needed, because units end with a S so it will automatically removed if the unit value is lower than 2
        }
    }
});

And for the reroll() function:

client.giveawaysManager.reroll(messageID, {
    messages: {
        congrat: ":tada: New winner(s) : {winners}! Congratulations!",
        error: "No valid participations, no winners can be chosen!"
    }
}).catch((err) => {
    message.channel.send("No giveaway found for "+messageID+", please check and try again");
});

options.messages.congrat: the congratulatory message.
options.messages.error: the error message if there is no valid participations.

Custom database

You can use your custom database to save giveaways, instead of the json files (the "database" by default for giveaways-js). For this, you will need to extend the GiveawaysManager class, and replace some methods with your custom ones. There are 4 methods you will need to replace:

getAllGiveaways: this method returns an array of stored giveaways.
saveGiveaway: this method stores a new giveaway in the database.
editGiveaway: this method edits a giveaway already stored in the database.
deleteGiveaway: this method deletes a giveaway from the database (permanently).

All the methods should be asynchronous to return a promise.

Here is an example, using Data.id, a Sqlite database. The comments in the code below are very important to understand how it works!

const Discord = require("discord.js"),
client = new Discord.Client(),
config = {
    prefix: ":?",
    token: "Your_Token"
};

// Load data.id - it's an example of custom database, you can use MySQL, Quick.db, etc...
const id = require("data.id"); // npm install data.id | Join the support server => https://discord.gg/78RyqJK 
if(!id.get("giveaways")) id.set("giveaways", []);

const { GiveawaysManager } = require("giveaways-js");
const GiveawayManagerWithOwnDatabase = class extends GiveawaysManager {

    // This function is called when the manager needs to get all the giveaway stored in the database.
    async getAllGiveaways(){
        // Get all the giveaway in the database
        return id.get("giveaways");
    }

    // This function is called when a giveaway needs to be saved in the database (when a giveaway is created or when a giveaway is edited).
    async saveGiveaway(messageID, giveawayData){
        // Add the new one
        id.push("giveaways", giveawayData);
        // Don't forget to return something!
        return true;
    }

    async editGiveaway(messageID, giveawayData){
        // Gets all the current giveaways
        const giveaways = id.get("giveaways");
        // Remove the old giveaway from the current giveaways ID
        const newGiveawaysArray = giveaways.filter((giveaway) => giveaway.messageID !== messageID);
        // Push the new giveaway to the array
        newGiveawaysArray.push(giveawayData);
        // Save the updated array
        id.set("giveaways", newGiveawaysArray);
        // Don't forget to return something!
        return true;
    }

    // This function is called when a giveaway needs to be deleted from the database.
    async deleteGiveaway(messageID){
        // Remove the giveaway from the array
        const newGiveawaysArray = id.get("giveaways").filter((giveaway) => giveaway.messageID !== messageID);
        // Save the updated array
        id.set("giveaways", newGiveawaysArray);
        // Don't forget to return something!
        return true;
    }

};

// Create a new instance of your new class
const manager = new GiveawayManagerWithOwnDatabase(client, {
    storage: false, // Important - use false instead of a storage path
    updateCountdownEvery: 10000,
    default: {
        botsCanWin: false,
        exemptPermissions: [ "MANAGE_MESSAGES", "ADMINISTRATOR" ],
        embedColor: "#FF0000",
        reaction: "🎉"
    }
});
// We now have a giveawaysManager property to access the manager everywhere!
client.giveawaysManager = manager;

client.on("ready", () => {
    console.log("I'm ready !");
});

client.login(config.token);

Support shards

To make giveaways-js working with shards, you will need to extend the GiveawaysManager class and to update the refreshStorage() method. This method should call the getAllGiveaways() method for every shard, so all the GiveawaysManager synchronize their cache with the updated database.

const Discord = require("discord.js"),
client = new Discord.Client(),
config = {
    prefix: ":?",
    token: "Your_Token"
};

// Extends the GiveawaysManager class and update the refreshStorage method
const { GiveawaysManager } = require("giveaways-js");
const GiveawayManagerWithShardSupport = class extends GiveawaysManager {

    // Refresh storage method is called when the database is updated on one of the shards
    async refreshStorage(){
        // This should make all shard refreshing their cache with the updated database
        return client.shard.broadcastEval(() => this.giveawaysManager.getAllGiveaways());
    }

};

// Create a new instance of your new class
const manager = new GiveawayManagerWithShardSupport(client, {
    storage: "./storage.json",
    updateCountdownEvery: 10000,
    default: {
        botsCanWin: false,
        exemptPermissions: [ "MANAGE_MESSAGES", "ADMINISTRATOR" ],
        embedColor: "#FF0000",
        reaction: "🎉"
    }
});
// We now have a giveawaysManager property to access the manager everywhere!
client.giveawaysManager = manager;

client.on("ready", () => {
    console.log("I'm ready !");
});

client.login(config.token);

What Is Giveaway-js?

Giveaways-js is a powerful Node.js module that allows you to easily create giveaways! You can create giveaways easily by using Giveaway-js from Discord.js. If you still don't understand or need help from your error, please join our Discord Server. Giveaways-js Made by InPlex Development: Kanao#7695

discord discord.js giveaway bot giveaways-js

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago