DraftBot is a text adventure game. The story takes place in a medieval world, and the player embodies an adventurer who wants to win a competition launched by the king, to win the princess' hand. To achieve this, he must travel and earn points by going through a lot of danger, including thieves, wilderness, and scary children. Every few hours, the player can follow their adventure through "reports" and interact with a multiple choice system, using reactions below the report. Each choice has multiple issues, which could hurt the character, heal them, or even give them some stuff. During the journey, they earn money, equipments, and points, and can use them to buy potions, items, or effects in the shop, fight other players, and ascend the leaderboard.
DraftBot is originally a discord bot and has evolved to become a fully fledged game that you can play either through discord or through other clients.
You can start playing by visiting our website: https://draftbot.com
Before creating your own instance, please note that you can add the bot to your server through the link available on the bot's discord
If you decide to work on the creation of your own instance of the bot, you are supposed to have a minimum of computer skills. Bot support team will prioritize players of the main instance and will only provide very limited assistance. We will fix bugs you report, but we will not teach you how to code a discord bot.
Please do not copy and paste the commands we provide in this readme without :
- Understanding the command
- Replacing the relevant parts with your data
- Having read the whole document
Only the code available in the "release" tab is considered "stable".
This list contains all the software programs necessary to run DraftBot. Our start guide will walk you through the installation process
- Docker desktop
- Webstorm
- (or any other IDE, but we recommend Webstorm since our team uses it and we provide configurations for it)
- Git
- nvm (not mandatory but highly recommended)
- Node
- (see package.json of any service for the relevant version)
This guide will help you run DraftBot on your computer. We provide instructions for Linux, MacOS (🐧) and Windows (🪟). If not specified, the command is the same for all OS. Please do not skip any step of this guide; otherwise, the following commands will not work.
For step 1 and 2, you can either do it manually or use this script to do it (Linux and MacOS only)
- Install Yarn
- Check package.json of any service for the relevant version
- Follow the provided guide to install yarn https://yarnpkg.com/getting-started/install
Beware, if you do this at the root of the project, this will create a new package.json file, you can delete this file
- Setup projects
Run yarn install in each project folder:
cd Lib && yarn install
cd ../Discord && yarn install
cd ../Core && yarn install- Setup database, Keycloak and an MQTT broker
For Keycloak, follow instructions in README.md in the keycloak folder.
For the database, you can use a mariadb container with the following command:
# Run mariadb database with docker
docker run -d --name mariadb -e MARIADB_USER=draftbot -e MARIADB_PASSWORD=secret_password -e MARIADB_ROOT_PASSWORD=super_secret_password -v /path/to/volumes/mariadb:/var/lib/mysql -p 3306:3306 mariadb:latestYou can use any MQTT broker, but we recommend using Mosquitto.
You can use this guide to install it with docker. Step 1, 2, 3, and 5 are enough to have a working MQTT broker.
The following config file can be used:
allow_anonymous true
listener 1883
persistence true
persistence_file mosquitto.db
persistence_location /mosquitto/data/
The only thing important is to allow anonymous connections.
- Fill config files
# Copy files with default values
cp $DRAFTBOT_ROOT/Core/config/config.default.toml $DRAFTBOT_ROOT/Core/config/config.toml
cp $DRAFTBOT_ROOT/Discord/config/config.default.toml $DRAFTBOT_ROOT/Discord/config/config.toml
# The Core module also need access to the Keycloak server on the first launch
touch $DRAFTBOT_ROOT/Core/config/keycloak.toml # 🐧
New-Item $DRAFTBOT_ROOT/Core/config/keycloak.toml # 🪟You can copy and paste the content of the keycloak section from the config.toml file in the Discord folder in the keycloak.toml file.
- Run projects
# First: start the core module
cd $DRAFTBOT_ROOT/Core && yarn start
# Then: start the discord module
cd $DRAFTBOT_ROOT/Discord && yarn startYou can set up npm launch scripts to make the start easier.
From now on you should be able to start the bot by running yarn start in the Core and Discord folders while having the
database and keycloak running.
Starting order is important, start with the database container and keycloak, then the Core and finally the Discord
module.
You can also compile the bot in a docker container. To do so, you can use the following commands at the root of the project:
docker build . -f Core/Dockerfile -t draftbot/core
docker build . -f Discord/Dockerfile -t draftbot/discordThis project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0) or, at your option, any later version.
For details, see the LICENSE file in this repository.
