Configuration

From Werewolf Wiki
Jump to: navigation, search

This page gives information on how to configure lykos.

In order to run lykos, you will need to create a botconfig.py file. We supply a botconfig.py.example file that you should copy to your botconfig.py to get a mostly-working configuration. The bot will not start if it does not detect the botconfig.py file.

If you cannot find what you are looking for in this article, do not hesitate to come ask us for help at #lykos on freenode.

Note: You can overwrite any setting in src/settings.py by adding it to your botconfig.py file. Do not modify src/settings.py directly.

Network

HOST
Default: "chat.freenode.net"
The address of the IRC server for the bot to connect to.
PORT
Default: 6697
The port of the IRC server for the bot to connect to.
USE_SSL
Default: True
Whether to connect with SSL (secure socket layer) or not.

Credentials

NICK
Default: "mywolfbot"
The nick that your bot will use when connected to a network.
IDENT
Default: NICK
Determines the bot's ident string, if the server doesn't provide one by default.
REALNAME
Default: NICK
Determines the real name which the bot sends to the server.
USERNAME
Default: ""
Username for authentication, can be left blank if same as nickname.
PASS
Default: "my_nickserv_pass"
Determines what password will be used for authentication.
SASL_AUTHENTICATION
Default: True
Determines whether to use SASL authentication or not.
CHANNEL
Default: "##mywolfgame"
The main (game) channel you want your bot to be in.
CMD_CHAR
Default: "!"
The character to address your bot by.
SERVER_PASS
Default: "{account}:{password}"
If your server requires a connection password, or your services package expects a different format if authenticating to NickServ via the PASS command, modify this.
OWNERS
Default: ("unaffiliated/wolfbot_admin1",)
Hostmasks for the owners of the bot, wildcards (* and ?) are allowed.
Note: The comma is required at the end if there is only one owner.
OWNERS_ACCOUNTS
Default: ("1owner_acc",)
Account names for the owners of the bot.
Note: The comma is required at the end if there is only one owner.
ADMINS
Default: None
Hostmasks for bot admins, wildcards (* and ?) are allowed. Specifying a user here is equivalent to giving them the +F flag via the !fflags command.
ADMINS_ACCOUNTS
Default: None
Account names for bot admins. Specifying a user here is equivalent to giving them the +F flag via the !fflags command.

Development

ALLOWED_NORMAL_MODE_COMMANDS
Default: []
Debug mode commands to be allowed in normal mode.
OWNERS_ONLY_COMMANDS
Default: []
Commands that should only be allowed for owners, regardless of their original permissions.
DISABLE_DEBUG_MODE_REAPER
Default: True
Disables the idle timer in debug mode.
DISABLE_DEBUG_MODE_STASIS
Default: True
Disable/ignore stasis when in debug mode.
DISABLE_DEBUG_MODE_TIMERS
Default: True
Disable day/night timeout in debug mode.
DISABLE_DEBUG_MODE_TIME_LORD
Default: False
Disables time lord in debug mode. The role will still appear but there will be no effect.
ALT_CHANNELS
Default: ""
Defines alternate channels for lykos to be in.
ALLOWED_ALT_CHANNELS_COMMANDS
Default: []
Defines commands that are allowed in alternate channels.
DEV_CHANNEL
Default: ""
Defines the developer channel.
DEV_PREFIX
Default: ""
If set, messages sent to DEV_CHANNEL are sent only to users with this prefix (requires an IRCd with STATUSMSG support).
PASTEBIN_ERRORS
Default: False
If DEV_CHANNEL is set, errors will be posted there.
LOG_CHANNEL
Default: ""
Define channel to log !fwarn commands, if set.
Example: <lykos> (ADD) Warning #666 to meaniehead by woffle - Terrible attitude towards other players; channel rule #1 is "Be nice to each other" | see -ops log at around time warning was issued for context (1 point, expires in 60d)
LOG_PREFIX
Default: None
If set, messages sent to LOG_CHANNEL are sent only to users with this prefix (requires an IRCd with STATUSMSG support).
IGNORE_HIDDEN_COMMANDS
Default: True
Defines whether to ignore commands sent to @#channel or +#channel or not.
ALLOW_NOTICE_COMMANDS
Default: False
Defines whether notices can be interpreted as a command or not.
ALLOW_PRIVATE_NOTICE_COMMANDS
Default: True
Defines whether private notices can be interpreted as a command or not.
CHANGING_HOST_QUIT_MESSAGE
Default: "Changing host"
Quit message when changing hostname.
USE_UTC
Default: True
If true, logs will use the UTC time; otherwise, they will use local time.
TIMESTAMP_FORMAT
Default: "[%Y-%m-%d %H:%M:%S{tzoffset}]"
Consult the Python documentation for more information on what format codes are allowable in this string. Additionally, {tzname} resolves to the timezone name (like UTC) and {tzoffset} resolves to the timezone offset (+0000).