#
# Community Bridge Configuration File
#

# Log level controls the degree of detail that is sent to the console/log
# The possible settings are (in order of quietest to noisiest:
#   info, config, fine, finer, finest, all
# - During configuration, I recommend using 'config'.
# - During normal operation, I recommend using 'info'.
# - If you want to see the notifications that the synchronize and reminder
#   notices have been sent, use 'fine'
# - During troubleshooting of problems, set this to either finest or all.
log-level: config

# Allow plugin metrics to start up for this plugin.
# Disable for all plugins by editing the plugins/PluginMetrics/config.yml file.
# They can be viewed at: http://mcstats.org
plugin-metrics: true

# The permissions system (PEX, bPerms, GroupManager, PermsBukkit)
permissions-system: PEX

# Please ensure if you run your minecraft server on a remote host
# that your MySQL server allows REMOTE connections.
#
# Hostname for your MySQL Server
db-host: *

# MySQL Port
db-port: 3306

# Database Name
db-database: *

# Database Username
db-username: *

# Database Password
db-password: *

# If set to true it will show a message to the user that they have been placed
# into a group
show-primary-group: false

# This message is displayed when show-primary-group is false to registered users
registered-message:

# This is shown to users when they connect that arn't registered
unregistered-message: Unregistered Account - Please Register at * for full access

# This is shown when auto-sync runs to remind a user to register
unregistered-messagereminder: Just a reminder, for full access visit * and register

# When true this will not allow un-registered players onto the server, and show
# the unregistered-message in the form of a kick
kick-unregistered: false

# Multi-Tables are when you have all your tracking/minecraft usernames in a
# different table to the users table
multi-tables: false

# Forums like XenForo use a table that has rows for each custom field as opposed
# to columns for each custom field
multi-tables-use-key: false

# If set to true it will not allow banned players from your website to connect
use-banned-field: false

# Ban List in Seperate Table (Such as PHPBB) If you include a value for reason
# then it will display that when booting the player
banlist-table:
    enabled: false
    table: phpbb_banlist
    user-id-field: ban_userid
    reason-field: ban_reason

# Eventually, all settings related to group synchronization will reside here.
group-synchronization:
  primary-group:
    enabled: true
    # If a user's group ID on the web application side is on this list, it
    # won't be synchronized. Example: ['1','2','3','115']. [] is an empty list.
    group-ids-to-ignore: []

    # If a player's group name is on this list the web application group won't
    # be synchronized over it. (NOT YET IMPLEMENTED)
    group-names-to-ignore: []

# Groups in Separate Table (Such as PHPBB)
groups-table:
    enabled: true
    table: phpbb_user_group
    user-id-field: user_id
    group-id-field: group_id

# If you have a second group level and want to make use of it
secondary-groups: false

# This is a timer that will check and sync all data with your database at a set
# interval
auto-sync: true

# Set the unit of measurement for sync and reminder scheduling. Options are:
# ticks, seconds, minutes, or hours. Note that this applies to both
# auto-sync-every and auto-remind-every.
auto-every-unit: minutes

# The interval for the auto-sync timer, this should be no less than
# 15-20 minutes.
auto-sync-every: 20

# This is a timer that will notify unregistered users more frequently to
# register
auto-remind: true

# The interval for the auto-remind timer, this should be no less than
# 5-10 minutes.
auto-remind-every: 10

# This is for extra features of the bridge plugin that allow you to save age,
# gametime, last online, health, etc. to the database
enable-basic-tracking: false

#
# Main Users table configuration
#
users-table:
  # Users Database Table
  table: phpbb_users

  # The field that contains their Minecraft Username
  user-name-field: username

  # The field that contains their Unique ID across your site
  user-id-field: user_id

  # The field that contains their Primary Group
  groups-id-field: group_id

  # The field that contains their Secondary Group
  secondary-groups-id-field: sub_group_ids

  # The Banned Field should be a 1 or 0
  banned-field: member_banned

  # The Group Banned Users are placed in on your site
  banned-users-group: 14

  # The Default Group for when a group can't be found or they are unregistred.
  # Note that this is the group ID on the web application, not the permissions
  # group name.
  default-group: 1

#
# This is only for multi-table websites where information is not all contained
# in the users table
#
multi-table:

  # Table that contains custom information for MineCraft
  table: ipbog3pfields_content

  # The field that has their users id
  field-user-id-field: member_id

  # This is the field that contains the KEY for multi-tables-use-key (XenForo)
  field-key-field: key_str

  # The value that is to be matched in field-key-field when looking for their
  # Minecraft Username
  field-key-value: mcusername

  # This is for when multi-tables-use-key is false (Invision Power Board) it
  # contains their Minecraft Username
  field-value-field: field_11


#
# Optional
# You can place users in the default group if they do not have an Avatar or
# Minimum Posts or both
#

profile-requirements:

  # Enable Forced Website Avatar
  require-avatar: false

  # Message when Avatar Not Found
  require-avatar-message: This server requires players to upload an avatar to their profile.

  # Table that contains user avatars
  require-avatar-table: ipbog3profile_portal

  # Field that has their User ID
  require-avatar-user-id-field: member_id

  # Field that has their Avatar (Empty/null value for no avatar)
  require-avatar-field: pp_main_photo

  # Enable Forced Minimum Posts
  require-minposts: false

  # Messages when Minimum Posts not met
  require-minposts-message: This server requires players to have a minimum of 3 forum posts.

  # Required amount of minimum Posts
  require-minposts-count: 3

  # Table that contains their post count
  require-minposts-table: ipbog3members

  # Field that has their User ID
  require-minposts-user-id-field: member_id

  # Field that has their post count
  require-minposts-field: posts


#
# Optional
# This is for Online Status, Health, Age etc...
#

basic-tracking:

  # Table that contains the custom fields
  table: ipbog3pfields_content

  # Enable Tracking of Online status
  field-onlinestatus-enabled: true

  # Value to place in table when online
  field-onlinestatus-valueonline: 1

  # Value to place in table when offline
  field-onlinestatus-valueoffline: 0

  # Multi-Tables-Use-Key value for multi-tables.field-key-field
  field-onlinestatus-key-value: mconlinestatus

  # Multi-Tables / Single Table field for Value
  field-onlinestatus-field: field_14

  # Enable tracking if player is online or not
  field-lastonline-enabled: true

  # Multi-Tables-Use-Key value for multi-tables.field-key-field
  field-lastonline-key-value: mclastonline

  # Multi-Tables / Single Table field for Value
  field-lastonline-field: field_15

  # If you want to have a profile field that contains the gametime expressed
  # in words (5 hours, 33 minutes...), create the custom field on your forum
  # and enter its name here. Otherwise, leave 'blank': ''
  # Note that for this to work, the field-lastonline-field must also have
  # field/column and be configured correctly.
  field-lastonline-formatted-field: ''

  # Multi-Tables-Use-Key value for multi-tables.field-key-field
  # If you want to have a profile field that contains the gametime expressed
  # in words (5 hours, 33 minutes...), create the custom field on your forum
  # and enter its name here. Otherwise, leave 'blank': ''
  # Note that for this to work, the field-lastonline-key-value must also have
  # field/column and be configured correctly.
  field-lastonline-formatted-key-value: ''

  # Enable tracking how much time is spent on server
  # Note: This relies on 'lastonline' being enabled to work.
  field-gametime-enabled: true

  # Multi-Tables-Use-Key value for multi-tables.field-key-field
  field-gametime-key-value: mcgametime

  # Multi-Tables / Single Table field for Value
  field-gametime-field: field_16

  # If you want to have a profile field that contains the gametime expressed
  # in words (5 hours, 33 minutes...), create the custom field on your forum
  # and enter its name here. Otherwise, leave 'blank': ''
  # Note that for this to work, the field-gametime-field must also be set.
  field-gametime-formatted-field: ''

  # Multi-Tables-Use-Key value for multi-tables.field-key-field
  # If you want to have a profile field that contains the gametime expressed
  # in words (5 hours, 33 minutes...), create the custom field on your forum
  # and enter its name here. Otherwise, leave 'blank': ''
  # Note that for this to work, the field-gametime-key-value must also be set.
  field-gametime-formatted-key-value: ''

  # Enable Total XP earnt tracking
  field-totalxp-enabled: true

  # Multi-Tables-Use-Key value for multi-tables.field-key-field
  field-totalxp-key-value: mctotalxp

  # Multi-Tables / Single Table field for Value
  field-totalxp-field: field_18

  # Enable Current XP tracking (progress to next level)
  field-currentxp-enabled: true

  # Multi-Tables-Use-Key value for multi-tables.field-key-field
  field-currentxp-key-value: mccurrentxp

  # Multi-Tables / Single Table field for formatted version.
  field-currentxp-formatted-field: ''

  # Multi-Tables-Use Key 'field' for formatted version.
  field-currentxp-formatted-key-value: ''

  # Multi-Tables / Single Table field for Value
  field-currentxp-field: field_17

  # Enable Level tracking
  field-level-enabled: true

  # Multi-Tables-Use-Key value for multi-tables.field-key-field
  field-level-key-value: mclevel

  # Multi-Tables / Single Table field for Value
  field-level-field: field_19

  # Enable tracking of players health
  field-health-enabled: true

  # Multi-Tables-Use-Key value for multi-tables.field-key-field
  field-health-key-value: mchealth

  # Multi-Tables / Single Table field for Value
  field-health-field: field_20

  # Enable tracking of players time alive since last death
  field-lifeticks-enabled: true

  # Multi-Tables-Use-Key value for multi-tables.field-key-field
  field-lifeticks-key-value: mclifeticks

  # Multi-Tables / Single Table field for Value
  field-lifeticks-field: field_21

  # Multi-Tables-Use-Key value for multi-tables.field-key-field
  field-lifeticks-formatted-key-value: ''

  # Multi-Tables / Single Table field for Value
  field-lifeticks-formatted-field: ''

  # Enable Wallet Tracking (NOT IN USE YET)
  field-wallet-enabled: false

  # Multi-Tables-Use-Key value for multi-tables.field-key-field
  field-wallet-key-value: mcwallet

  # Multi-Tables / Single Table field for Value
  field-wallet-field: field_23

#
# Group Configuration
# The strings on the left ('1', '2', etc.) is the group ID in the web application's
# mysql database, the string on the right is the group name in your permissions
# system.
#
groups:
  '1': noob
  '2': default
  '5': admin
  '8': donator
  '8': donator_anon
  '9': hero
  '9': hero_anon
  '10': savior
  '10': savior_anon
  '11': jr_moderator
  '12': moderator
  '13': sr_moderator
  '14': banned