A bot to play planning poker on Discord.

# Clone the repository
git clone https://github.com/Fubinator/planning-poker-discord-bot.git

# Enter into the directory
cd planning-poker-discord-bot/

# Install the dependencies
npm install

After cloning the Repository and installing the dependencies, you need to copy the .env.example File to .env and add your Discord API Token to the environment variable DISCORD_SECRET (getting your API token is covered in the next section.)

To run your own instance of planning-poker-discord-bot you will need to creat a bot app on Discord's Developer Portal.

1. Go to the Discord Developers Portal in your browser.
2. Sign in with your Discord login details.
3. In the top right of the page, click the button "New Application".
4. Enter a relevant name and click "Create".
5. From the panel on the left, select the menu option "Bot" then click on the button "Add Bot".
6. There will now be a Token that is hidden, copy it and add it your .env file you created previously. The Token is your DISCORD_SECRET.
7. From the panel on the left, select the menu option "OAuth2"
8. Give your bot the bot scope with the Send Messages permissions.
9. Paste the link it generates into your browser, this links to the bots invitation portal where you can add it to a server you control.
10. The link should look like: https://discord.com/api/oauth2/authorize?client_id={YOUR_CLIENT_ID}&permissions=2048&scope=bot
11. Once the bot arrives in your server, you are ready to run the bot.

npm start

Planning Poker is a gamified estimating and planning technique used frequently in agile teams to get an idea of how long certain task will take. A short video explanation can be found here.

Once your instance of the bot is added to your chosen server, gather your participants in text channel you wish to play in. It may be a good idea to make a channel specifically for playing planning poker.

Once every has there focus in the right channel, to start playing, type !start. The bot will will commence the game.

To join the game, each player has to add a reaction to the bot's last message.

To put forward a user story or question to consider, just type !play followed by the question or feature to be considered. All players will then have 30 seconds to send their estimation to the bot via direct message.

After 30 seconds the bot will automatically close the question and display all players estimations in the text channel the game was started in.

If there are conflicting estimations, players will then have time to discuss there reasoning for the response they gave.

!play How long will it take to do implement x?

After a consensus has been reached and the team has decided on an amount of storypoints / ideal days / etc. for the proposed user story, you can type !storypoints followed by the agreed amount of effort to tell the bot that the question has finished.

!storypoints 15

After all user stories have had an agreed upon amount of storypoints assigned to them you can then finish the game by typing !end. The bot will end the game and send all questions with the amount of given story points to the channel the game was started in.

If you want to contribute, have a look here.

MIT