Files
PointsBot/pointsbot.sample.toml
2021-02-22 00:26:34 -08:00

94 lines
2.7 KiB
TOML

################################################################################
# Core
#
# These are the primary fields needed to run the bot.
################################################################################
[core]
# The name of the subreddit to monitor, without the "r/" prefix.
subreddit = ""
valid_tags = "Java,Bedrock,Dungeons,Earth,Education,Legacy"
################################################################################
# Reddit Credentials
#
# See the bot documentation for more information about these fields.
# Some of these fields are sensitive, so once these fields are provided, take
# care not to upload or distribute this file through insecure channels, or to
# public sites.
################################################################################
[credentials]
client_id = "REDACTED"
client_secret = "REDACTED"
username = "REDACTED"
password = "REDACTED"
################################################################################
# Filepaths
#
# Any filepaths needed by the bot. Can be relative or absolute paths, or just
# filenames.
################################################################################
[filepaths]
# The name/path of the SQLite database file to use. This value is optional; if not
# specified, a default filepath will be used.
database = ""
# The name/path of the log file to use. This value is optional; if not specified,
# a default filepath will be used.
log = ""
################################################################################
# Links
#
# Any links used in the bot's reply. If you do not need to use these links,
# leave these fields blank.
################################################################################
[links]
feedback = ""
scoreboard = ""
################################################################################
# User Levels
#
# These items represent the levels that contributors to the subreddit can
# attain. To add a level, add another section with the format:
#
# [[levels]]
# name = "<name inside quotes>"
# points = <integer>
# flair_template_id = "<id inside quotes>"
#
# These fields are case-sensitive, so enter the level name exactly as you want
# it to appear.
#
# The flair_template_id field is optional, so it may be omitted or left as the
# empty string, "".
#
# Furthermore, the order of these levels does not matter: they will be sorted by
# point values when the bot is run. However, it may be preferable to order them
# by point values for readability.
################################################################################
[[levels]]
name = "Level One"
points = 1
flair_template_id = ""
[[levels]]
name = "Level Two"
points = 25
flair_template_id = ""
[[levels]]
name = "Level Three"
points = 100
flair_template_id = ""