Bukkit

# AuditTrail Configuration File

#-----------------------------------------------------------------------------------
# General plugin settings
#
# allowMetrics: true to send plugin information to MCStats, false otherwise
#-----------------------------------------------------------------------------------

allowMetrics: true

#-----------------------------------------------------------------------------------
# File log settings
#
# NOTE: File logs will only be created if individual listeners are enabled AND
# appropriate filter conditions are met (i.e. world to log in, players to audit,
# items/blocks/commands to audit)
#
# The server log will contain all events from enabled listeners in a single file
# located in the \AuditTrail\server_log folder called AuditTrail.log.
#
# Listener logs will be created in the \AuditTrail\listener_logs folder.  Each
# listener will have its own file logging only events related to it.  e.g. The
# teleport listener will log all teleport events to TeleportListener.log.
#
# Player logs will be created in the \AuditTrail\player_logs folder.  Each file will
# be named based on the UUID of the player and will contain all events
# generated by the player based on the enabled listeners.
#
# serverLog: true to enable the server log, false to disable
# listenerLog: true to enable listener log, false to disable
# playerLog: true to enable player logs, false to disable
# timeStamp: time stamp format to use.
# showWorldName: true to display world name within the log, false to hide
# showGameMode: true to display game mode within the log, false to hide
# showOP: true to display if a player is current OP within the log, false to hide
# showLocation: true to display location of player within the log, false to hide
# showLore: true to display item lore within the log, false to hide
# showEnchants: true to display item enchantments within the log, false to hide
#
#-----------------------------------------------------------------------------------

fileLog:
  serverLog: false
  listenerLog: false
  playerLog: false
  timeStamp: 'yyyy-MM-dd HH:mm:ss'
  showWorldName: true
  showGameMode: true
  showOP: true
  showLocation: true
  showLore: true
  showEnchants: true

#-----------------------------------------------------------------------------------
#
# Player log settings
#
# maxSize:  Maximum size the log can grow before a new log file is created
# (in megabytes).  Use whole numbers only, minimum size of 1MB.
#
# rollOverMethod: The amount of time to pass before creating a new log file.
# Valid values are: minute, hour, day, week or month
#
# NOTE: If the roll over time passes and no new events occur, a new file will
# NOT be created.
#
#-----------------------------------------------------------------------------------

playerLog:
  maxSize: 10MB
  rollOverMethod: day

#-----------------------------------------------------------------------------------
#
# Listener log settings
#
# maxSize:  Maximum size the log can grow before a new log file is created
# (in megabytes).  Use whole numbers only, minimum size of 1MB.
#
# rollOverMethod: The amount of time to pass before creating a new log file.
# Valid values are: minute, hour, day, week or month.
#
# NOTE: If the roll over time passes and no new events occur, a new file will
# NOT be created.
#
#-----------------------------------------------------------------------------------

listenerLog:
  maxSize: 10MB
  rollOverMethod: day

#-----------------------------------------------------------------------------------
#
# Server log settings
#
# log: Name of the default server log file
#
# maxSize:  Maximum size the log can grow before a new log file is created
# (in megabytes).  Use whole numbers only, minimum size of 1MB.
#
# rollOverMethod: The amount of time to pass before creating a new log file.
# Valid values are: minute, hour, day, week or month
#
# NOTE: If the roll over time passes and no new events occur, a new file will
# NOT be created.
#
#-----------------------------------------------------------------------------------

serverLog:
  log: 'AuditTrail_Events.log'
  maxSize: 10MB
  rollOverMethod: day

#-----------------------------------------------------------------------------------
#
# mySQL settings
#
# AuditTrail will log events to a mySQL database. Each enabled listener will write
# data to its own table.  IMPORTANT: The database to be used MUST exist prior
# to using it with AuditTrail as the plugin will not create the database for you.
# As well, the plugin requires the credentials of a mySQL user which has the
# appropriate permissions to create tables and insert data (i.e. CREATE and
# INSERT global privileges).
#
# AuditTrail will use a connection pool to efficiently connect and reuse database
# connections.  In most cases, the default number is sufficient to handle the
# load of many events logged / second.  Use caution and check your server's
# performance if altering the maxPoolSize setting.
#
# use: true to log events to mySQL database, false to disable
# hostname:  IP address/name of mySQL computer
# port: Port number use to communicate with mySQL server
# database: Name of database to use for logging events
# userName: User name to use for mySQL connection
# userPassword: Password of user for mySQL connection
# prefix: Prefix to use for AuditTrail table names within database
# maxPoolSize: Maximum number of connections to use in connection pool
# maxBatch: Maximum number of events to batch insert at a time
#
# consumerSleepTime: Number of milliseconds for consumer thread to wait
# before checking for events in the queue.  NOTE: If this value is set too high,
# it can add extra load to your server.  If the number of events being generated
# is low, this value can be set lower to check for events less often
#
# connectionPoolWait: Number of milliseconds to wait before trying to get a
# new connection from the mySQL connection pool.  This value is only used if
# all connections within the pool are used and a new connection is required.
# NOTE: If this value is set too high, it can add extra load to your server.  If
# connections are not maxed out, this value can be set lower.
#
# playerLog: True to log all player specific events to the "playerLog" table,
# false otherwise.  This is required to be enabled if you wish to do specific
# user queries within AuditTrail-Web.
#
# eventRecycler: True to delete events from the database after a specific
# period of time.  False to never delete events from the database.
#
# eventAge: The number of days a log event must stay in the database
# before it is deleted by the recycler.  In order for this value to be used,
# eventRecycler must be set to true.  Valid values range from 1-365. Default
# value is 30 days.
#
# recycleSchedule: The number of hours to wait before checking to see if any
# events need to be removed from the database.  Valid values range from
# 1-672 (once per hour - once per every 4 weeks). Default value is every
# 24 hours.
#
#-----------------------------------------------------------------------------------

mySQL:
  use: false
  hostName: localhost
  port: 3306
  database: db
  userName: username
  userPassword: password
  prefix: 'auditTrail_'
  maxPoolSize: 10
  maxBatch: 200
  consumerSleepTime: 25
  connectionPoolWait: 25
  playerLog: false
  eventRecycler: false
  eventAge: 30
  recycleSchedule: 24

#-----------------------------------------------------------------------------------
#
# Bed listener settings
#
# These events are fired when a player enters a bed
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

bed:
  audit: false
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# Block breaking listener settings
#
# These events are fired when a player break a block
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
# itemsToAudit: list of items which should be audited.  Use '*' for all'
#
# A complete list of possible items can be found in the itemList.txt file located
# in the AuditTrail plugin folder.
#
#-----------------------------------------------------------------------------------

blockBreak:
  audit: false
  worlds: []
  playersNotAudited: []
  blocksToAudit:
    - '*'

#-----------------------------------------------------------------------------------
#
# Block placing listener settings
#
# These events are fired when a player places a block
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
# itemsToAudit: list of items which should be audited.  Use '*' for all'
#
# A complete list of possible items can be found in the itemList.txt file located
# in the AuditTrail plugin folder.
#
#-----------------------------------------------------------------------------------

blockPlace:
  audit: false
  worlds: []
  playersNotAudited: []
  blocksToAudit:
    - '*'

#-----------------------------------------------------------------------------------
#
# Book listener settings
#
# These events are fired when a player edits a book
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

book:
  audit: false
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# Bucket emptying listener settings
#
# These events are fired when a player empties a bucket
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

bucketEmpty:
  audit: false
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# Bucket filling listener settings
#
# These events are fired when a player fills a bucket
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

bucketFill:
  audit: false
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# Chat listener settings
#
# These events are fired when a player enters a chat message
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

chat:
  audit: false
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# Command listener settings
#
# These events are fired when a player enters a command
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
# commandsToAudit: list of commands which are audited.  Use '*' for all
#
#-----------------------------------------------------------------------------------

command:
  audit: false
  worlds: []
  playersNotAudited: []
  commandsToAudit:
    - '*'

#-----------------------------------------------------------------------------------
#
# Console listener settings
#
# These events are fired when a command is entered from the console
#
# audit: true to enable listener, false to disable
# commandsToAudit: list of commands which are audited.  Use '*' for all
#
#-----------------------------------------------------------------------------------

console:
  audit: false
  commandsToAudit:
    - '*'

#-----------------------------------------------------------------------------------
#
# Container listener settings
#
# These events are fired when a player removes or adds an item to a
# container.
#
# audit: true to enable listener, false to disable
# logAdd: true to log items added to a container, false otherwise
# logRemove: true to log items removed from a container, false otherwise
#
# logPlayerInventory: true to log items added/removed from a player
# inventory, false to ignore player inventory changes
#
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

container:
  audit: false
  logAdd: true
  logRemove: true
  logPlayerInventory: true
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# Craft listener settings
#
# These events are fired when a player crafts an item using a workbench or
# the player inventory
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
# itemsToAudit: list of items which should be audited.  Use '*' for all'
#
# A complete list of possible items can be found in the itemList.txt file located
# in the AuditTrail plugin folder.
#
#-----------------------------------------------------------------------------------

craft:
  audit: false
  worlds: []
  playersNotAudited: []
  itemsToAudit:
    - '*'

#-----------------------------------------------------------------------------------
#
# Creature spawn listener settings
#
# These events are fired when a creature is spawned into a world
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
#
#-----------------------------------------------------------------------------------

creatureSpawn:
  audit: false
  worlds: []

#-----------------------------------------------------------------------------------
#
# Enchant listener settings
#
# These events are fired when a player sucessfully enchants an item
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

enchant:
  audit: false
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# Entity damage listener settings
#
# These events are fired when a non-player entity is damaged
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
#
#-----------------------------------------------------------------------------------

entityDamage:
  audit: false
  worlds: []

#-----------------------------------------------------------------------------------
#
# Entity death listener settings
#
# These events are fired when a non-player entity is killed by a player
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

entityDeath:
  audit: false
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# Entity target listener settings
#
# These events are fired when an entity targets or untargets another entity
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
#
#-----------------------------------------------------------------------------------

entityTarget:
  audit: false
  worlds: []

#-----------------------------------------------------------------------------------
#
# Fish listener settings
#
# These events are fired when a player fishes
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

fish:
  audit: false
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# Item consume listener settings
#
# These events are fired when a player consumes an item
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
# itemsToAudit: list of items which should be audited.  Use '*' for all'
#
# A complete list of possible items can be found in the itemList.txt file located
# in the AuditTrail plugin folder.
#
#-----------------------------------------------------------------------------------

itemConsume:
  audit: false
  worlds: []
  playersNotAudited: []
  itemsToAudit:
    - '*'

#-----------------------------------------------------------------------------------
#
# Item drop listener settings
#
# These events are fired when a player drops an item
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
# itemsToAudit: list of items which should be audited.  Use '*' for all'
#
# A complete list of possible items can be found in the itemList.txt file located
# in the AuditTrail plugin folder.
#
#-----------------------------------------------------------------------------------

itemDrop:
  audit: false
  worlds: []
  playersNotAudited: []
  itemsToAudit:
    - '*'

#-----------------------------------------------------------------------------------
#
# Item pickup listener settings
#
# These events are fired when a player picks up an item
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
# itemsToAudit: list of items which should be audited.  Use '*' for all'
#
# A complete list of possible items can be found in the itemList.txt file located
# in the AuditTrail plugin folder.
#
#-----------------------------------------------------------------------------------

itemPickup:
  audit: false
  worlds: []
  playersNotAudited: []
  itemsToAudit:
    - '*'

#-----------------------------------------------------------------------------------
#
# Join listener settings
#
# These events are fired when a player sucessfully joins the server
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

join:
  audit: false
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# Kick listener settings
#
# These events are fired when a player is kicked from the server
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

kick:
  audit: false
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# Level change listener settings
#
# These events are fired when a player gains or loses a level
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

levelChange:
  audit: false
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# Player death listener settings
#
# These events are fired when a player dies
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

playerDeath:
  audit: false
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# Player interact listener settings
#
# These events are fired when a player interacts with a block
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

playerInteract:
  audit: false
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# Quit listener settings
#
# These events are fired when a player leaves the server
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

quit:
  audit: false
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# Shear listener settings
#
# These events are fired when a player shears an entity
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

shear:
  audit: false
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# Sign listener settings
#
# These events are fired when a player sucessfully changes / creates a sign
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

sign:
  audit: false
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# Tame listener settings
#
# These events are fired when a player tames a horse, wold or ocelot
# This can include moving from one location to another within a world or from
# one world to another.
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

tame:
  audit: false
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# Teleport listener settings
#
# These events are fired when a player teleports from one location to another.
# This can include moving from one location to another within a world or from
# one world to another.
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

teleport:
  audit: false
  worlds: []
  playersNotAudited: []

#-----------------------------------------------------------------------------------
#
# xpChange listener settings
#
# These events are fired when a player gains xp
#
# audit: true to enable listener, false to disable
# worlds: list of worlds the listener should be enable on.  Use '*' for all
# playersNotAudited: list of player UUID's which are ignored by the listener
#
#-----------------------------------------------------------------------------------

xpChange:
  audit: false
  worlds: []
  playersNotAudited: []