omnibot22/config.example.toml

# The server host to connect to.
# There is no default for this and must be supplied.
server = "irc.example.com"

# Whether to use SSL or not.
# default: false
# use_ssl = true

# What port to connect on.
# default: 6667, or 6697 when use_ssl is set to true.
# port = 6697

# The nickname to use for this bot. Make sure it's available before you use it!
# default: omnibot
nick = "omnibot"

# A list of all channels to join by default.
# default: []
channels = ["#friends", "#chat"]

# A plugin block starts with [[plugins]]
[[plugins]]
# The module to load this plugin from. This should be a Python module.
# This is required.
module = "plugins.fortune"

# The list of channels that this plugin should listen on. This list can include
# channels outside of the channels supplied in the server config.
# By default, it will listen on all channels in the server config.
channels = ["#fortune_telling"]

# Whether this plugin is enabled.
# If this is set to false, then the plugin won't load.
# This is useful when you don't want to comment out an entire configuration
# block and instead just disable it.
# default: true
# enabled = false

# The rest of this plugin block are specific to the plugin - check the plugin's
# documentation for the values you can set.

# A list of fortunes, or a path to a list of fortunes - one per line.
fortunes = "data/fortunes.txt"


[[plugins]]
# The nickserv module registers and logs in a bot upon initial connection.
module = "plugins.nickserv"

# password
# The password used to log in to this server using NickServ.
password = "my_password"

# email
# The email address to use for this server when registering with NickServ.
# default: omnibotomni.bot
# email = "omnibotomni.bot"

# nickserv
# The nickname for the nickserv user.
# default: "NickServ"
# nickserv = "NickServ"

[[plugins]]
# Linkbot module will fetch the title of a value at a URL.
module = "plugins.linkbot"

# Whether URLs that are pointing to private IP addresses are allowed.
# This is recommended to be left false.
# default: false
# allow_private = false

# Additional blocked hosts, URLs, and IP ranges.
# You don't need to block things like localhost, 192.168.0.0/16, etc if you are
# using `allow_private = false` above
# default: []
blocked = [
    # This can take the form of a URL,
    "https://www.example.com/full-page/",
    # a hostname,
    "www.example.com",
    # an IP address,
    "8.8.8.8",
    # or an IP subnet
    "8.8.0.0/16"
]

[[plugins]]
# Markov module will listen to everything everyone says, and sometimes spit
# phrases back at you.
module = "plugins.markov"

# order
# Markov chains are naiive models of how a certain person speaks. Chains have an
# "order", which is close to the "accuracy" of the way a person speaks. The
# larger the order, the more RAM and hard drive space is used.
# An order of 1 or 2 is recommended, anything larger gets pretty huge in memory.
# default: 1
# order = 1

# data_path
# This is the path to the directory that holds the markov chains. Chains are
# stored by channel, and then bey user.
# For example, data/markov/#chat/nick holds the data for the user "nick".
# default: data/markov/
# data_path = "data/markov"

# save_every
# Markov chains for all users are saved periodically. This value determine the
# number of seconds between saves.
# If a user's markov chain is not accessed after their last save, it is pruned
# from memory.
# default: 1800
# save_every = 1800

# reply_chance
# Whenever someone says something, the bot will train their markov chain based
# on what they've said. Sometimes, when someone says something, the bot will
# interject its opinion about the state of affairs, based on that user. This is
# based on a random chance. The supplied number should be be between 0.0 and
# 1.0, from "never" to "always".
# Additionally, users may set their reply chance between 0.0 and the value they
# set. e.g. with a value of 0.01, a user may set their reply chance to 0.001.
# default: 0.01
# reply_chance = 0.01