Config#

Setting available via settings.toml or .env

########################################
###          DEFAULT SETTINGS        ###
########################################

# Any of those settings can be changed
# by the user. To overwrite a setting, 
# create a settings.toml or load the 
# settings from .env file or vars.
# As an example, to disable the 
# iamlistening object:
# settings.toml
# [default]
# iamlistening_enabled = false

[default]
# settings load verification
VALUE = "On Default"

# Module Enable/Disable
iamlistening_enabled = true

# chat_platform is used to launch 
# the specific handler
# for the chat platform. Value can be
# telegram, discord, matrix, etc.

# [default.platform]
# platform = ""
# bot_token = ""
# bot_channel_id = ""
# bot_api_id = ""
# bot_api_hash = ""
# bot_hostname = ""
# bot_user = ""
# bot_pass = ""
# bot_auth_token = ""
# iteration_enabled = false
# iteration_limit = -1

[default.platform.template]
platform = ""
enabled=true
bot_token = ""
bot_channel_id = ""
bot_api_id = ""
bot_api_hash = ""
bot_hostname = ""
bot_user = ""
bot_pass = ""
bot_auth_token = ""
iteration_enabled = false
iteration_limit = -1

# [default.platform.backup]
# platform = ""
# enabled=true
# bot_token = ""
# bot_channel_id = ""
# bot_api_id = ""
# bot_api_hash = ""
# bot_hostname = ""
# bot_user = ""
# bot_pass = ""
# bot_auth_token = ""
# iteration_enabled = false
# iteration_limit = -1

# Iteration settings used for testing
# if you need the bot to run 
# for a long time
# set iteration_enabled to false
# if you need the bot to run 
# for a short time
# set iteration_enabled to true
# iteration_limit is the number 
# of iterations
# the bot will run for 
# iteration_enabled = true
# iteration_limit = 1


########################################
###     END OF DEFAULT SETTINGS      ###
########################################

Chat Platform Credentials#

Telegram#

Create your bot token via Telegram @BotFather https://core.telegram.org/bots#how-do-i-create-a-bot
Telegram portal to create an API key via https://core.telegram.org/api/obtaining_api_id
check https://docs.telethon.dev/en/stable/ for more info

example:

chat_platform="telegram"
iteration_enabled = false
iteration_limit = -1
bot_token = "1233242342"
bot_channel_id = "123123123"
bot_api_id = "123123123"
bot_api_hash = "123123123"
bot_hostname = ""
bot_user = ""
bot_pass = ""
bot_auth_token = ""

Discord#

Create your bot token via Discord Dev Portal https://discord.com/developers/docs/intro
check https://pycord.readthedocs.io for more info

example:

chat_platform="discord"
iteration_enabled = false
iteration_limit = -1
bot_token = "12345"
bot_channel_id = "12345"
bot_api_id = ""
bot_api_hash = ""
bot_hostname = ""
bot_user = ""
bot_pass = ""
bot_auth_token = ""

Matrix#

Create your bot token, server, and user via https://app.element.io/#/register
check https://simple-matrix-bot-lib.readthedocs.io for more info

example:

chat_platform="matrix"
iteration_enabled = false
iteration_limit = -1
bot_token = "12345"
bot_channel_id = "!myroom:matrix.org"
bot_api_id = ""
bot_api_hash = ""
bot_hostname = "https://matrix.org"
bot_user = "1234"
bot_pass = "1234"
bot_auth_token = ""

Guilded#

Create your bot token via Guilded Dev Portal https://support.guilded.gg/hc/en-us/articles/1500009005861-How-to-make-a-bot
Check https://guildedpy.readthedocs.io/en/stable/

example:

chat_platform="guilded"
iteration_enabled = false
iteration_limit = -1
bot_token = "12345"
bot_channel_id = ""
bot_api_id = ""
bot_api_hash = ""
bot_hostname = ""
bot_user = ""
bot_pass = ""
bot_auth_token = ""

Mastodon#

Create your bot token via Mastodon Dev Portal
check https://Mastodonpy.readthedocs.io/en/stable/

example:

chat_platform="mastodon"
iteration_enabled = false
iteration_limit = -1
bot_token = ""
bot_channel_id = ""
bot_api_id = ""
bot_api_hash = ""
bot_hostname = "https://mastodon.social""
bot_user = ""
bot_pass = ""
bot_auth_token = "12345"

Lemmy#

Use your user name, user password and lemmy instance url
check db0/pythorhead

example:

chat_platform="lemmy"
iteration_enabled = false
iteration_limit = -1
bot_token = ""
bot_channel_id = "lemmyworld"
bot_api_id = ""
bot_api_hash = ""
bot_hostname = "https://lemmy.world"
bot_user = "1234"
bot_pass = "1234"
bot_auth_token = ""

Twitch#

Use https://twitchtokengenerator.com to get your bot token
check https://twitchio.dev/en/latest/

example:

chat_platform="twitch"
iteration_enabled = false
iteration_limit = -1
bot_token = "1233435"
bot_channel_id = ""
bot_api_id = ""
bot_api_hash = ""
bot_hostname = ""
bot_user = ""
bot_pass = ""
bot_auth_token = ""