xinfo/bircbot.conf.example at master · xshellz/xinfo · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
#!/usr/bin/env bash

# SERVER
SERVER="irc.freenode.net"
PORT="6667"

# MAX LENGTH OF TEXT
#MAXLENGTH=400

# BOT NICK/USER
NICK="mybot"
PASS="password"
NAME="droid"
USER="bot"
#MODE="8"

# CHANNELS
CHANNELS=( "#debian-bots" )

# ADDRESSING THE BOT
ADDRESS="!"

# ERROR MESSAGE IF ADDRESSED IN PRIVMSG's
# if set, the bot will reply with this when its nick or $ADDRESS is prefixed in private messages
# if empty, the bot will go ahead and do the command anyway
# comment out to use default error message
PRIVADDRESS=""

# QUIT MESSAGE
#QUITMSG="I quit!"

# CUSTOM VERSION REPLY
#CUSTOMVERSION="Fake Client v1.0"

# CUSTOM TIME REPLY
#CUSTOMTIME="It's about tea o'clock"

# DISABLE ALL DEFAULT BEHAVIOUR
#GHOST=true

# FLOOD PROTECTION
FLOOD_CHECK=true
FLOOD_COUNT=4
FLOOD_TIME=10

# TIMEOUTS
PING_TIME=120
TIMEOUT=300

# BANTER
BANTER=false # reply to things said in channels that don't address the bot, like "lol" and "hello"
BANTER_CHANNELS=( "#debian-bots" ) # where to banter - an empty array means "all"
BANTER_GREET_STATEMENTS=( "hi" "hello" "helo" "ehlo" )

# RANDOM SHUTDOWN AFTER A GIVEN TIME
#UPTIME_LIMIT=1440		# minutes (1 day)
#UPTIME_RANDOM=120		# will stop after LIMIT + ( rand(0-100) * RANDOM )
#UPTIME_MESSAGE="brb"	# written in all channels

# OWNER (admin.bmod)
OWNER="~r00t@unaffiliated/bolt" # owner will be auto-added as admin and can not be removed

# FACTOIDS
FACTOIDS_ALWAYS=true	# reply to everything
FACTOIDS_RECURSIVE=true	# if someone asks about "foo bar" and we only know about "foo", answer with that
FACTOIDS_HELPFUL=false	# helpful replies on errors
FACTOIDS_PRIORITY=0		# fallback priority
FACTOIDS_EASYLEARN=true	# enables teaching the bot things by saying "a is b", i.e. "pizza is very good". causes problems if people want to use "is" as part of a factoid name

# ARITHMETIC
ARITHMETIC_PRIORITY=5	# fallback priority

# HTTPTITLE LIMITING
HTTPTITLE_DELAY=10		# how many seconds required between each url lookup per user

# PROXY FOR HTTP REQUESTS MADE BY CURL
#CURL_PROXY="localhost:1080"	# <host[:port]>

# EXTRA CURL OPTIONS
#CURL_OPTS="-4"

# CHANNEL
CHANNEL_GREET=true		# greet new users (those not seen before) using files named like "~/.bircbot/greeting-#debian.txt" where #debian is the channel name
CHANNEL_SUBSTRING=true	# check for substrings of new users. if this is enabled, "jdoe-laptop" will not be greeted if "jdoe" has already been seen
CHANNEL_PUBMAX=true		# publically announce increased peak headcount in channel

# FIFO INPUT
#FIFO="$HOME/.bircbot/bircbot.fifo"

# MOSQUITTO (MQTT)
#MQTT_HOST="1.2.3.4"
#MQTT_PORT="1883"
#MQTT_USER="bircbot"
#MQTT_PASS="secret"
#MQTT_CAFILE="/etc/mosquitto/certs/ca.crt"
#MQTT_CID="bircbot-$(hostname -s)-$(whoami)"
#MQTT_BASE="/irc"		# the bot will send and receive messages on /<base>/channel/<channelname> and /<base>/priv/<nick>