mafiabot

Credit to aeternalis1/mafiabot. Modified based on the original code.

Deployment

1. Create a new bot on Discord Developer Portal
2. Configure credentials:
   • Bot token:
     • Enter the app page for the bot from My Applications
     • Go to Bot, reset token, and copy it
     • Paste it in the .env file: DISCORD_BOT_TOKEN={token}
   • OpenAI API key:
     • Go to OpenAI Playground, create an API key, and copy it
     • Paste it in the .env file: OPENAI_API_KEY={key}
3. Invite the bot to your server with administrator permission and top role:
   • Go to OAuth2 and select 'bot' under 'scopes',
   • Select 'Administrator' under 'Bot Permissions'
   • Copy the link and paste it in a browser to confirm the invitation
   • Go to Server Settings - Roles and make sure the bot's role (the bot's name by default) is at the top: if not, drag it to the top
4. Run commands in Makefile on a local or remote machine to start the bot server:
   • make all
5. Use the commands to play mafia with other members in the server (keep the bot server running)

Quick walkthrough of a Mafia game:

Setup

1. [Channel] Each player sends m!join to join the game
2. [Channel] Send m!set <role> <number> for each role (e.g. ‘m!set villager 3’). Available roles: villager, mafia, doctor, paritycop, normalcop. The sum of all roles should be equal to the number of players.
3. [Channel] Send m!context to set the context (e.g. ‘20th century Europe’)
4. [Channel] Send m!start to start the game
5. [DM] Respond to the bot’s dm to customize your own character

Gameplay

1. Night: respond to the bot’s dm (every player has something to do at night)
2. Day: talk and vote with m!vote @<who_you_want_to_vote> in the channel

Bot commands

Basic

m!help displays the help screen, with a list of commands.

m!h2p describes how to play: the basic rules and premise of the game.

m!start begins a new round of mafia.

m!end ends the current game, if existing. Can only be called by a moderator or a player.

Setup

m!roles lists all available roles that can be added to the game.

m!set [role] [number] sets the quantity of [role] in the setup to [number]. e.g. m!set villager 3

m!setup shows the full complement of roles in the current setup.

m!settings displays all the settings of the current game.

m!toggle [setting] flips [setting] from on to off, or vice versa. Type m!settings to see options. e.g. m!toggle daystart

m!setlimit [phase] [time] sets the time limit for [phase] to [time] in minutes. [time] can be a positive real number at least 1 or inf. e.g. m!setlimit day 10

m!join adds you to the game.

m!leave removes you from the game. This may end an ongoing game, so be careful using this command.

m!context sets the context of the game.

m!style sets the narration style of the crime scene.

In-game

m!vote [player] puts your current vote on player. Vote this bot to set your vote to no-lynch. e.g. m!vote @mafiabot

m!unvote sets your vote to nobody (no vote).

m!status displays all players and their votes, as well as the vote count on each player.

m!players displays all players who are currently alive

m!alive displays all the roles and their quantities that are still in play.

m!dead displays the players in the graveyard and their roles (if roles are revealed upon death).

m!time displays the amount of time left, before the day or night ends.

Roles and settings

Roles

villager: Village-aligned role. No special powers.

normalcop: Village-aligned role, capable of determining the alignment of a target player during nighttime.

paritycop: Village-aligned role, capable of determining whether his LAST TWO targets are of the same alignment (will not get a report after night 1).

doctor: Village-aligned role, capable of saving a target player from death during nighttime.

mafia: Mafia-aligned role. Capable of killing a villager during nighttime with fellow mafia.

Game settings

daystart: If toggled, the game begins during a day phase in lieu of a night phase.

selfsave: If toggled, doctors are allowed to save themselves.

conssave: If toggled, doctors may save the same target on consecutive days.

continue: If toggled, the game will continue even if a living player leaves.

reveal: If toggled, players' roles will be revealed upon death.

limit1: Determines the time limit for day phases (by default infinite).

limit2: Determines the time limit for night phases (by default infinite).