A game based on the Scout and Girlguide event Monopoly Run. The game works similar to the real world game in which a team visits a property and answers a question at the property. If they are the first one to answer the question correctly they own the property if they are not then they pay rent to the owner.
All commands are called using mr in a Discord channel. mr help will list all commands available to a player.
You will need to be a Server Administrator to run the following commands:
mr setup <number of teams> <question set> This command is used for setting up the server. It will will create roles, channels, a record in the database and a table in the database.
mr add Will add a team. Meaning it will create a role and channel for the new team.
mr remove Will do the opposite effect of the above command. So will remove the roles, channels, database records and the table in the database.
You will need to have the Monopoly Run Administrator role to use the following commands:
mr start Will start the game allowing players to send messages in there team channel. It will also update the properties and leader board channel every 2 mins.
mr stop Will stop the game meaning player can no longer send messages. It will also stop updating the properties and leader board channel.
mr goto <property id> Will display the question for that property.
mr answer <your answer> Should be used to answer the question.
mr money Will display how much money the team has.
mr owner <property id> Will display the owner of the property.
Will not display Administrator Commands!
mr help Will display help.
- Max number of teams is 99 and Minimum is 2!
- While the program does use a clever bit of code(FuzzyWuzzy) to check the teams answer against the correct answer, its not 100% perfect!
To Do!
Setting up Monopoly Run Discord is reasonable easy. Monopoly Run Discord requires two things Python 3.8 or greater and a MariaDB Server 10.x or MySQL Server
I suggest you use Python 3.9 or greater as it has some performance improvements for C modules.
-
First you need to install a Database do this with:
sudo apt-get install mariadb-server mariadb-client -
Clone the repository with:
git clone https://github.com/bxdavies/monopoly-run-discord-bot.git -
Next you need to create a database and user then create tables with SQL Files...
sudo mysql -u root -p(If you have not set a password just press enter when prompted)- Next we create a database:
CREATE DATABASE monopolyrun; - Then we create a user:
CREATE USER 'monopolyrun'@'localhost' IDENTIFIED BY 'YOUR-DB-PASSWORD';(Change YOUR-DB-PASSWORD to your password) - Grant all privileges to the user on the new database:
GRANT ALL ON monopolyrun.* TO 'monopolyrun'@'localhost'; - Update privileges with:
FLUSH PRIVILEGES; - Exit out:
Exit - Go to the SQL folder inside the cloned repository with:
cd Monoply-Run-Discord-Bot/sql/ - Create the guilds table with:
sudo mysql -u root -p monopolyrun < tbl_guilds.sql(If you have not set a password just press enter when prompted) - Create the questions table with:
sudo mysql -u root -p monopolyrun < tbl_london.sql(If you have not set a password just press enter when prompted) - Secure the MySQL install with:
sudo mysql_secure_installation(Set a root password and then press y for all the questions)
-
Install python and the MariaDB C Connector with:
sudo apt-get install python3.9 python3.9-dev python3-pip gcc libmariadb3 libmariadb-dev -y. -
From the SQL directory go back to the repository folder with
cd .. -
Install python modules with:
pip3 install -r requirements.txt -
Create a .env file using the following:
nano .envand then add the following to it:
#Discord Bot Token #
TOKEN=?
# Database Credentials #
HOST="localhost"
PORT=3306
USER="monopolyrun"
PASSWORD="?"
DATABASE="monopolyrun"
# Logging #
LOGGING_LOCATION=/home/ben/
LOG_LEVEL=WARNING
Replace the question mark with your token and the other question mark with your database password. (It must have quotes around it!)
You can also set logging location and log level. Its important that the user your running the python script as can write to the log directory. For log level you have a choice of "DEBUG", "INFO", "WARNING", "ERROR" and "CRITICAL".
- Now start the bot and check for errors with:
python3 bot.pyYou have now setup Monopoly Run Discord if you want to run it as a service see Running the bot as a service:
logging_setup.py Sets up logging.
database_connection.py Establishes a connection to the database.
bot.py Is the main starting point for the bot, from here the cogs are loaded.
game_administration.py Is used for administrating the game. This is things such as setting up the game,starting and stop the game and updating the leader board and properties channel.
game_main.py Is where the actually game play is handled. This includes all the commands players will run to goto and answer questions at properties.
game_help.py Includes the help commands and the help reaction button.
errors.py Holds all the custom exceptions.
Because this a big project the formatting is not necessarily standard but used to show clearly what it does. I have named variables like you would in c# which is not correct for python but I prefer.
Variable names should start with there type followed by a sensible name. They should be camel case. So for example: strTeamName is string Team Name.
Double Quotes are to be used only for SQL quires anything else should be single quotes.
The code should be well commented. There is a hierarchy for the comments though.
A Comment surrounded by comments represents that the code is now doing something completely different to the above.
#############
# Info Here #
#############
And then any other comments should be standard like so:
# Comment Here #