Storyteller

This bot is not available for invite.

Storyteller is a Discord bot coded in JavaScript with discord.js using the Commando command framework for Discord's 2019 Hack Week. His main feature is the ability to play the classic circle game Mafia, using a voice channel for the players to interact alongside a fully-voiced storyteller, creating one of the most immersive Discord bot games in existence.

Why Mafia?

Mafia was chosen as it utilizes in its gameplay most of the core features of Discord. I assumed Discord would want a bot that would show off what makes Discord, Discord. With Mafia, everything from voice channels and reactions to direct messages are fully utilized, making it highly capable for advertising campaigns and events. Additionally, Mafia is just a fun game in general, and encourages those users who refuse to use voice channels to join in on the fun, even if they choose not to talk. I wanted something unique and innovative, and I think Mafia is the perfect answer to what Discord is looking for with Hack Week.

Installing

Before You Begin

1. Make sure you have installed Node.js >=10 and Git.
2. Clone this repository with git clone https://github.com/dragonfire535/storyteller.git.
3. Run cd storyteller to move into the folder that you just created.
4. Create a file named .env and fill it out as shown in .env.example.

Windows

1. Open an ADMIN POWERSHELL window and run npm i -g --production windows-build-tools.
2. Follow these instructions to install ffmpeg.
3. Run npm i --production in the folder you cloned the bot.
4. Run npm i -g pm2 to install PM2.
5. Run pm2 start Storyteller.js --name mafia to run the bot.

Mac

1. Use a real (cheaper!) OS to host your bot.
2. ???
3. Profit.

Ubuntu and other Debian-based systems

1. Run apt update.
2. Run apt upgrade to install the latest dependencies of your distro.
3. Run apt install ffmpeg to install ffmpeg.
4. Run npm i --production in the folder you cloned the bot.
5. Run npm i -g pm2 to install PM2.
6. Run pm2 start Storyteller.js --name mafia to run the bot.

How to Play

1. Have all the players who want to play join a voice channel. You need at least 5 to play, and can have up to 15.
2. Use the mafia command, which will start a game using the members of the voice channel. Make sure all players open their DMs.
3. Have fun! The storyteller will guide you through the game.

Licensing

The bot is licensed under the GPL 3.0 license. See the file LICENSE for more information. If you plan to use any part of this source code in your own bot, I would be grateful if you would include some form of credit somewhere.