Run Locally

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

If you intend to run or test this bot yourself, you must have Node.js installed. You can also find instructions bellow on how to host it on Heroku.

Install

Clone or download this repository and run the following commands from your terminal, to install dependencies before running the bot.

The commands assume your local clone of the repository is in your Downloads folder, and that you didn't renamed the downloaded folder.

cd ~/Downloads/mrraffle
npm install

Configure

First you'll need to rename de .env.example file to .env and replace the example value there with your own bot token. If you don't have a bot token yet, you can follow this guide on how to do it.

Once you've set your bot token, you should open the config.json file to further configure your bot. The options available are pretty self explanatory:

{
    "prefix": "",
    "admins": [],
    "color": ""
}

• The 'prefix' property defines a unique character that will be used in your server to run commands.
• The 'admins'property is an array of either usernames or roles that have permission to run special commands, such as starting a raffle and drawing a winner.
• The 'color' property should be a hexadecimal code, without the # symbol, of a color of your preference, used in the Rich Embedded messages that the bot sends when starting a raffle or drawing a winner.

Here's an example:

{
    "prefix": "#",
    "admins": [
       "Administrators",
       "Moderators",
       "Digitalirony"
    ],
    "color": "ffffff"
}

Run Bot

If you've configured your bot properly, you can now run the command bellow on your terminal and get a message that the bot is running

npm run start

Commands

For the following examples, it's assumed you're using the prefix # as configured above. If not, you'd have to replace the command with whatever prefix you configured, so for example if your prefix is !, you'd type !start instead of #start

Start a Raffle

To start a raffle all you use the command #start.

#start

This command will start a raffle with default parameters. It will set a time limit of 30 days, and an undefined prize.

You can also define custom parameters for day limit, and the prize by typing them after the #start command. The order is important. It should always be: day limit first, in number days; and lastly prize.

#start 15 Chicken Dinner

Both of these parameters are optional, but they must be input in the right order. You can choose to set only the number of days, for example, but if you want to set a prize then you must also input a day limit.

#start 24 

Take a Number

Once a raffle has started, tickets can be given to a user. An Admin should type !addtickets <username> <number of tickets>(must be a user tag using the @sign) followed by their desired number of tickets. If no tickets are given, defaults to 1.

#addtickets @digitalirony 9999

Tickets given are just an incremental number. At this time no custom or random ticket numbers.

##Status## During the raffle, someone may want to check how many tickets have been given out. What will the prize be? When will the drawing be? This can be done with the !status command. This can be ran by anyone. You can use !status without any options to see general information about the raffle, or pass in a user mention to retrieve how many tickets that specific user has.

#status @digitalirony

Draw a Winner

At the moment, drawing has to be done manually by typing #draw <#of winners>. The bot will then randomly select a winner or winners from the pool and print a message, letting everyone know what the winning number or numbers were, and who it belongs to. If no number of winners is given, then 1 is assumed, and only one will be picked. If multiple winners are selected, they will all be unique. One person can not win twice.

#draw 3