#  (c) Maxim Van de Wynckel
#
# ------------------------------ #

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
# GENERAL PLUGIN SETTINGS
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#

## Config version (DO NOT EDIT)
config: 2

## Language file
lang: 'en'

## Debug mode
debug: false

## Log to file
log:
  enabled: true
  # Reset log on startup
  reset: true

## Update checking
update:
  # RECOMMENDED YOU LEAVE THIS TRUE
  check: true

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
# PLUGIN SPECIFIC SETTINGS
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#

## INSTALL NEW MODULES WITH /qaplugin modules

# The database is used to keep data of specific players
# this can range from key value data used to rember user information
# (like names, ...) to things talked about to the bot
# NOTE: This is mainly utilized by modules
database:
  # If you want to remember user data after a restart. Enable this
  persistent: false
  # Database configuration is SIMILAR to http://wiki.bukkit.org/Bukkit.yml#database
  # with isolation, url, driver, ...
  # Database name
  database: "qaplugin"
  # Database username
  username: 'root'
  # Database password
  password: ''
  # Database driver URL
  # {DIR} will be replaced with the plugin directory
  # {NAME} will be replaced wit the plugin name
  url: jdbc:mysql://localhost:3306/{DATABASENAME}
  # url: jdbc:sqlite:{DIR}{NAME}.db
  # Save interval in ticks
  save-interval: 6000

# Disabled worlds. Add your world name in this list to
# disable it.
# The QAPlugin will not 'LISTEN' to chat in these worlds
# announcement messages won't appear in these worlds as well
disabled-worlds:
- 'example_world'

# API.ai integration
# This allows you to add artificial intelligence by adding/creating your own bot
# THIS IS REALLY WORTH IT!
api-ai:
  # When enabled, all questions that are not configured in this plugin
  # will be redirected to the online API
  enabled: false
  # Time in seconds before contexts get cleared.
  # Context is the thing you are talking about. It can be a dialog waiting for your
  # response or 3rd party data
  context-timeout: 35
  # See: https://www.spigotmc.org/wiki/qaplugin-adding-custom-ai/?noRedirect=1
  client-access-token: ""
  # Used by 3rd party modules to dynamically add entities or intents (aka. questions and objects you are talking about)
  # without you having to upload a zip to API.ai
  developer-access-token: ""

# QUESTION SETTINGS
#   Settings related to questions and triggering
question-settings:
  # Triggers are required to filter false positives
  # You can give the QA Plugin a name like "Server"
  # or you can use "what","who","how","when"
  # You may want to include your name as well...
  # You can leave both start and end empty (start: [] , end: [])
  # but this may not give good results.
  triggers:
    # Start triggers check for with what a phrase starts
    start:
    - 'maxim '
    - 'maxim, '
    - 'helper, '
    - 'bot, '
    - 'helper '
    - 'bot '
    - 'hey helper '
    - 'hey maxim '
    - 'hey bot '
    - 'hey bot, '
    - 'hey maxim, '
    - 'hey helper, '
    - 'hey helper,'
    - 'hey bot,'
    - 'hey helper'
    - 'hey bot'
    - 'ok google'
    # End triggers check for with what a phrase ends ("?")
    # "Hey what is that plugin maxim?"
    end:
    - ' maxim'
    - ' maxim?'
    - ' maxim!'
    - ' helper'
    - ' helper?'
    - ' helper!'
    - ' bot'
    - ' bot?'
    - ' bot!'
    # Check if the question contains the word
    # This is mainly advised to be used in combination with API.ai
    # since the word is randomly located in a question
    contains: []
  # Hide the question in the chat for all players except the one who asked it
  hide-question-player: false
  # Hide the question in the chat for all players
  hide-question-all: false
  # If you prefer to use words instead
  # of phrases for your questions you can set the minimum-matches
  # this will only show "an" answer when a minimum amount
  # of matches is reached.
  #
  # (For example: "what","plugin","you","use","for","the","tab")
  # You do not want to trigger a question when a user just asked "what"
  # you want it to at least match 3-4 words
  # THIS IS OVERIDDEN BY THE minimum-matches in the individual questions
  # set to -1 to disable.
  minimum-matches: -1
  # Anti spam messures
  anti-spam:
    # Enable to prevent spamming the bot
    enabled: true
    # Block question. When spam is detected the question will be blocked (no reply)
    # NOTE: This happens when the severe-level is reached (not the warning level)
    # It will also not send a severe-spam-reply
    block-question: false
    # Warning threshold. This is the amount of questions per minute
    warning-level: 15
    # Severe threshold. This the amount of questions per minute
    severe-level: 25
    # When "Block-question" is set to false it will use one of these spam replies
    # These replies are send when you reach the warning level
    #    You can use {player} as the player name
    #     Execute command as the player who asked the question
    #       |player:/command_as_player|...random answer here...
    #     Execute command as the opped player
    #       |opplayer:/some_command|...random answer here...
    #     Execute command as the console
    #       |console:give {player} 1 1|... random answer here
    #     Send player chat
    #       |chat:HEYYYY!|....random answer here...
    warning-spam-reply:
    - 'Hey! Stop spamming me!'
    - 'I do have a life you know ...'
    - 'Cut the crap...'
    - 'Stop it... I am not a toy!'
    - 'I will ban you if you do not stop...'
    # When "Block-question" is set to false it will use one of these spam replies
    # These replies are send when you reach the severe level
    #    You can use {player} as the player name
    #     Execute command as the player who asked the question
    #       |player:/command_as_player|...random answer here...
    #     Execute command as the opped player
    #       |opplayer:/some_command|...random answer here...
    #     Execute command as the console
    #       |console:give {player} 1 1|... random answer here
    #     Send player chat
    #       |chat:HEYYYY!|....random answer here...
    severe-spam-reply:
    - '|console:kick {player}|Bye bye ...'
    - '|console:kick {player}|Shut up!'

# ANSWER SETTINGS
#   Settings related to answering a question
answer-settings:
  # Broadcast answer to everyone
  # When turned to false it will be send to all recipients of the
  # question. This means the following:
  # - If you have hide-question-player set to true it will only be send to the player who asked the question
  # - In a normal chat it is send to all players who can see the question
  # - If you have a chat plugin that limits chat to specific players (range, town, faction,... )
  # it will only be send to them
  # IMPORTANT: Some chat plugins that completely change the chat such as
  #            plugins with hover and clickable text may require you to use broadcast true
  broadcast: true
  # Answer prefix: This will add a prefix to the answer
  # useful if you want to format the answer.
  # You can also use MVdWPlaceholders placeholders
  # here.
  prefix: '&7[&cBot&7] &cHelper&f: '
  # Answer suffix: This will add a suffix to the answer
  # useful if you want to format the answer
  suffix: ''
  # Answer delay (delay before a response is made (in ticks)
  response-delay: 4
  # Show unknown question messages
  # hide if you have commonly triggered triggers
  unknown-question:
    # Disabling unknown-question will just not return anything
    # when the question is not found.
    enabled: true
    # A list of possible responses
    # You can also use MVdWPlaceholders placeholders
    # here.
    responses:
    - "Sorry, I can't answer that question :("
    - 'I think you better ask a real player.'
    - "I am smart... but sorry I can't help you with that."
    - 'Maybe try rephrasing it?'
    - 'My responses are limited to my masters configuring skills.'
    - 'Lets change subject shall we?'
    - 'ERROR: I can not find your question! #NotReallyAnError'


# Announces that you can ask QAPlugin a question
announcer:
  # Enable announcer
  enabled: true
  # Announce with the same prefix as configured
  # with answers. [QAPluginBot] Helper: Ask a question!
  answer-prefix: true
  # Interval in seconds
  interval: 750
  # Randomize the "list"
  randomize: true
  # A list of random announcements
  list:
  - 'Hey! Got a question? Type &7&o"Helper, <QUESTION HERE>"'
  - 'If you need help, ask me ;)'
  - 'Install new modules with &7/qaplugin modules'
  - 'Ask me anything (except money)'
  - 'To give me more things to do, install some new modules with &7/qaplugin modules'
  - 'Ask your question: &7Helper ..question here..'