GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-30 14:49:28 +01:00
Code Issues Projects Releases Wiki Activity

example-conf: roughly sort config options by usefulness

Browse Source 
Also, remove the example for the deprecated pylink:prefixes option.
This commit is contained in:
James Lu 2017-07-12 08:37:08 -07:00
parent dbc1e80def
commit 1eb2743421
1 changed files with 21 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
example-conf.yml
View File

@ -17,11 +17,12 @@ pylink:
# Sets the fantasy command prefix for the main PyLink bot. To configure fantasy prefixes for # Sets the fantasy command prefix for the main PyLink bot. To configure fantasy prefixes for
# other service bots, add or modify the "prefix:" option in the configuration section of each # other service bots, add or modify the "prefix:" option in the configuration section of each
# plugin. # plugin. (see the "games:" block for an example)
# Note: prior to PyLink 1.2, defining a prefix here made it global for all service bots. This # Note: prior to PyLink 1.2, defining a prefix here made it global for all service bots. This
# was removed because it called all bots in a channel at once (even if they have conflicting # was removed because it called all bots in a channel at once (even if they have conflicting
# commands), which usually led to one successful reply and a string of "Command not found" # commands), which usually leads to one successful reply and a string of "Command not found"
# errors. # errors.
# Note 2: this option REPLACES the deprecated "prefixes:" option from PyLink 1.1 and earlier.
prefix: "&" prefix: "&"
# Determines whether PyLink service bots will respond to commands prefixed with their nick # Determines whether PyLink service bots will respond to commands prefixed with their nick
@ -29,36 +30,12 @@ pylink:
# it was renamed for consistency. This defaults to false. # it was renamed for consistency. This defaults to false.
#respond_to_nick: true #respond_to_nick: true
# Custom prefixes for other service bots if they are loaded. Note: this is DEPRECATED
# since PyLink 1.2 in favour of adding prefixes into each plugin's configuration block
# itself (see the "prefix:" option in the "games:" block for an example).
#prefixes:
# games: "@"
# Determines whether hideoper modes should be respected in WHOIS replies.
# Defaults to true if not specified.
#whois_use_hideoper: true
# Determines whether extended WHOIS replies should be sent to users marked as a
# bot (usually with umode +B). For better security (i.e. with bots that track services
# accounts for authentication), it is recommended to leave this off.
#whois_show_extensions_to_bots: false
# Determines whether PyLink should return its time of initial connection when replying to WHOIS
# for service bots. This defaults to true if not set.
#whois_show_startup_time: true
# Determines whether PyLink service clients should protect themselves from # Determines whether PyLink service clients should protect themselves from
# kicks, kills, etc. using IRCd-side servprotect modes. For this to work # kicks, kills, etc. using IRCd-side servprotect modes. For this to work
# properly, this usually requires that PyLink be U-Lined. This defaults to # properly, this usually requires that PyLink be U-Lined. This defaults to
# False. # False.
#protect_services: false #protect_services: false
# Determines how long plugins should wait (in seconds) before flushing their
# databases to disk. Defaults to 300 seconds. Changes here require a reload
# of all database-enabled plugins to take effect.
#save_delay: 300
# Determines whether services should default to sending command responses as private notices, # Determines whether services should default to sending command responses as private notices,
# even if the command was called in a channel. This defaults to False. # even if the command was called in a channel. This defaults to False.
#prefer_private_replies: false #prefer_private_replies: false
@ -76,6 +53,24 @@ pylink:
# Determines whether we should show unknown command errors for service bots. Defaults to True. # Determines whether we should show unknown command errors for service bots. Defaults to True.
#show_unknown_commands: true #show_unknown_commands: true
# Determines whether hideoper modes should be respected in WHOIS replies.
# Defaults to true if not specified.
#whois_use_hideoper: true
# Determines whether extended WHOIS replies should be sent to users marked as a
# bot (usually with umode +B). For better security (i.e. with bots that track services
# accounts for authentication), it is recommended to leave this off.
#whois_show_extensions_to_bots: false
# Determines whether PyLink should return its time of initial connection when replying to WHOIS
# for service bots. This defaults to true if not set.
#whois_show_startup_time: true
# Determines how long plugins should wait (in seconds) before flushing their
# databases to disk. Defaults to 300 seconds. Changes here require a reload
# of all database-enabled plugins to take effect.
#save_delay: 300
login: login:
# NOTE: for users migrating from PyLink < 1.1, the old login:user/login:password settings # NOTE: for users migrating from PyLink < 1.1, the old login:user/login:password settings
# have been deprecated. We strongly recommend migrating to the new "accounts:" block below, as # have been deprecated. We strongly recommend migrating to the new "accounts:" block below, as