DiscordLife

A text-based life simulator on Discord (bot). Users can play the game by issuing command to the bot through messages.

Installation

Inviting the bot

Follow this link to add the bot to your server. You require Admin permissions in the server you wish to add the bot to.

To avoid server-wide spam the bot is coded to process commands that are issued in text channels named simulator only, and so the creation of such a channel, before or after inviting the bot, within the server is must for playing.

The bot requires no additional permissions than a regular member in your server -- to read and write messages, and other basic permissions (shown in the invite screen).

Usage (playing)

You can start playing the game by inviting the bot to your server using the above link and then invoking the !help command to get a quick help guide. !create - use this command to create a world with characters in it for the simulation. Only one character is allowed per user across all servers currently.

Contributing

We welcome contributions from the public! If you'd like to help improve the bot, please fork our project and feel free to tackle any Issues. We also welcome feedback in the form of new issues, so feel free to create new ones for discussion. The project is currently a monolith.

Prerequisites

Python 3 - The language the bot is primarily written in. https://www.python.org/downloads/
Discord.py - A popular API wrapper for the discord.js written in Python. https://github.com/Rapptz/discord.py
MySQL - The database server the bot uses to store all the game data. https://www.mysql.com/downloads/

Dependencies

faker - random data generator. Currently being used in project for address generation. https://github.com/joke2k/faker
names - random name generator. https://github.com/treyhunner/names
mysql-connector-python - The connector used to interface with the MySQL database from within python code. Used to query/read/write data to and from the database.

Configuration

Install all the prerequisites (by following the installation instructions found in the respective links).
Clone the repo by downloading the repo’s zip and extracting it or using git bash (or other CLIs).

Open MySQL workbench and create a schema name gamedata, and create a table named maintable using

CREATE TABLE `maintable` (
    `discord_userID` varchar(45) NOT NULL,
    `discord_username` varchar(45) DEFAULT NULL,
    `World_ID` int DEFAULT NULL,
    `Name` varchar(45) DEFAULT NULL,
    `Gender` varchar(6) DEFAULT NULL,
    `Age` int DEFAULT NULL,
    `Occupation` varchar(45) DEFAULT NULL,
    `Location` varchar(100) DEFAULT NULL,
    `Happiness` int DEFAULT NULL,
    `Health` int DEFAULT NULL,
    `Smarts` int DEFAULT NULL,
    `Looks` int DEFAULT NULL,
    `Schedule_deletion` int DEFAULT NULL,
    `Bank` varchar(45) DEFAULT NULL,
    `ready_to_age` int DEFAULT '0',
    PRIMARY KEY (`discord_userID`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci

Within the cloned repo, create a sub directory in the root named keys.
Create a file named DB_login.json and fill it with
```
{
    "user": "*username*",
    "password": "*password*",
    "host": "localhost",
    "database": "gamedata"
}
```
Replace the above placeholders (username, password) with your actual MySQL database credentials.
Create a file in the same sub directory named token.txt and fill it with the bot’s login token found in it Discord developer portal page. You need to create a new application in the dev portal, then head to the BOT section in the left panel and get the bot’s token from there.

Deployment

You can run the bot by simply running the code like a normal python script. If the bot successfully started you will see a message in the console saying the same with some extra details.

Credits

Licence

This repo is licensed under the MIT licence. See LICENSE file for all the info.

Playing

To get started, invite the bot using the link in above section and invoke the !help command.

nithssh / DiscordGameBot

readme