Commands

The command prefix is >.

command	description
help	Displays the help command. Expand
	Usage: >help
snakes	Play snake battles. Expand
	Snake battles is a custom game where 2 players define statistics for their snakes and they duel on the a random statistic. Like top-trumps in a way. Only 2 player.
	Usage: >snakes [user]
	Begin the game as so:
	Then choose your stats:
	Then the snakes will fight each round:
	Eventually one snake will lose all of its hp:
	Finally the winner is announced in the channel the game began in:
blackjack	Play blackjack. Expand
	The traditional card game. Except aces are always worth 11. The aim of blackjack is to have your card totals add to as close as 21 with out going over 21 (or going bust). The winner has the highest total card values (below 21). Picture cards are worth 10 points, others are worth face-value. More details on how to play can be found here.
	Usage: >blackjack
	Begin the game and wait for others to reply then type start:
8ball	Let's play 8 ball. Expand
	Usage: >8ball [user]
2048	Play 2048. Expand
	Usage: >2048
meme	Shows a meme. Expand
	This command grabs a meme from /r/memes. You can also get memes from /r/dankmemes, /r/historymemes, /r/prequelmemes or /r/comedyheaven or /r/me_irl.
	Usage: >meme, >dankmeme, >historymeme, >prequelmeme, >comedyheaven or >me_irl
joke	Tells a joke. Expand
	This command grabs a joke from /r/jokes. You can also get jokes from /r/dirtyjokes, /r/cleanjokes or /r/antijokes.
	Usage: >joke, >dirtyjoke, >cleanjoke or >antijoke
comic	Sends a comic. Expand
	This command grabs a comic from /r/comics. You can also get a comic from /r/webcomics.
	Usage: >comic or >webcomic
hangman	Play hangman. Expand
	Usage: >hangman to play hangman with a random word or >hangman [user] to play with a word picked by that user
chess	Play chess. Expand
	Usage: >chess [user] to play chess with the specified user
battleships	Play battleships. Expand
	Usage: >battleships [user] to play battleships with the specified user
connect4	Play connect 4. Expand
	Usage: >connect4 to play connect 4 against the bot or >connect4 [user] to play connect 4 with the specified user
trivia	Answer a trivia question. Expand
	Usage: >trivia or >trivia [category] to get a trivia question. Defaults to the video games category. Do >trivia categories to see the list of categories available. You can react to the question and the bot will tell you if you are correct or incorrect.
rockpaperscissors	Play rock, paper scissors. Expand
	Usage: >rockpaperscissors [user] or >rps [user] to play against the specified user.
wouldyourather	Get asked a would you rather question, fetched from /r/wouldyourather. Expand
	Usage: >wouldyourather to get a question. React to the message and see the percentage of other users that agreed with you.
makememe	Make your own meme! Expand
	Uses imgflip to let you make your own meme. Usage: >makememe formats to see all the formats available. >makememe [format] [line one] [line two] to make a meme, specifying the format and bot lines of text to put on the meme. Multi-word lines must be enclosed within quotes (" ").
trending	Fetch a YouTube video of the trending page. Expand
	Usage: >trending to get a video from the American trending page. Do >trending [country code] to fetch videos from the specified country.
youtube	Search for a YouTube video. Expand
	Usage: >youtube [search term] to search for that video.
tictactoe	Play tic tac toe. Expand
	Usage: >tictactoe [user] or >ttt [user] to play tic tac toe with the specified user.
emojistring	Turns the text into emojis. Expand
	Usage: >emojistring [text] or >emojitext [text]
score	Displays your score. Expand
	Every time you win a game your score increases. Usage: >score to display your score.
leaderboard	Displays up to 10 users with the highest scores. Expand
	Usage: >leaderboard to display the current leaderboard.
website	Links to our website. Expand
	Usage: >website
add	Gives a link to add the bot to your server. Expand
	Usage: >add
server	Gives a link to the official Ludus discord server. Expand
	Usage: >server
github	Gives a link to the github. Expand
	Usage: >github
contributors	Displays the contributors. Expand
	Usage: >contributors to display the contributors.

Installation instructions

Set up the bot

• Download Python 3.6+
• Clone the repository: git clone https://github.com/mninc/ludus.git
• Fill in the config file (see below)
• Install packages necessary packages using pip: pip3 install discord.py praw pillow. (pip not installed? Do sudo apt install python3-pip)
• Run main.py: python3 main.py

Config file

You need to make a config file to run the bot. Fill in config_example.json with the following details and rename it to config.json before running the bot for the first time.

• token - discord bot token. If you don't already have one, you can create one here
• prefix - discord bot command prefix
• reddit_id - reddit application id. You can create one here. You must select 'script' to make it a script application
• reddit_secret - reddit application secret
• reddit_user_agent - the user agent reddit will see when a query is made to their api. Changing this will not affect the functionality of the bot
• imgflip_username - username to an imgflip account
• imgflip_password - password to that imgflip account
• youtube_api_key - api key to access the youtube APIs. Go to the Google Developer Console, create a project, enable YouTube Data API v3 and create an API key