Doot Doot is a discord bot for playing sound files in a voice channel. Users can upload files to the bot and query stats. Metadata is cached using Redis and persistent data is stored using sqlite3.

This is a table of environment variables that can be set before running the container. It includes the ENV VAR name, description and default value and type. Environment Variables that are (required) need values in order for the app to run.

System Package Requirements Please make sure these packages are installed before proceeding.

• Python3.8 or higher
• Sqlite3 (https://www.sqlite.org/download.html)
• Redis Server (https://redis.io/)
• FF-Mpeg (https://www.ffmpeg.org/download.html)

Install python packages Navigate to the project directory and install the python package requirements: pip3 install -r requirements.txt

Directories

By default the app puts the media directory in the root directory of the project The media directory contains the sounds, gifs, images, and videos sub directories. You can optionally choose to specifiy your own path for media but the subdirectories must be contained in the media folder.

The directory structure is as follows: media/. | ____sounds/ | ____images/ | ____videos/ | ____gifs/

The db/ directory by default is in the root project directory. You can specify in the config.js or as system environment variables the path for the db/ directory. NOTE: The .sql files are by default located in the applications db/ directory, and are used for setting up the sqlite3 databases for persistent data.

Getting config.json ready Make a copy of config_example.json and rename it to config.json The following keys in the config.json file require these values:

• "token"
  • (string) The API token obtained from discord
• "log_channel"
  • (int) The channel ID that logged events are posted to
• "prefix"
  • (char) The prefix to prepend to bot commands in order to call them
  • The default is '
• "reverse_char"
  • (char) The character to flag the reversal of sounds during playback
  • The default is -
• "sounds_path"
  • (string) The path to the media directory
  • The project by default includes the media directory with the required sub-directories
    • The path still needs to be specified before startup.
• "database_path"
  • (string) The path to the db directory
  • The project by default includes this directory in the root folder
• "sub_cmd_sep"
  • (char) The character that separates sub-commands that can be used for main commands
    • The default is a space
    • warning: Changing this value will result in undefined behaviour of the bot
• "owb_id"
  • (int) The discord role id that is used for elevated users
  • We reccomend making a custom discord role for privileged functions
• "redis"
  • "address"
    • The address of the redis server to use for caching
      • The default is localhost
  • "port"
    • The port to access the redis caching server on
      • The default is 6379
  • "charset"
    • The charset type used for encoding with redis
      • The default is utf-8

The database files need to be created. Navigate to your db/ directory and make sure schema.sql and metadata_schema.sql are in the directory Create the sqlite3 database with the command: sqlite3 sounds.db < schema.sql

And create the metadata database sqlite3 metadata.db < metadata_schema.sql

Navigate to the directory that contains main.py and issue the command: python3.x main.py Where x is the python 3 version you are using.