[bukkit]CommunityBridge IPB config

# Sample Invision Power Board Config
#
# Lines marked with brakcets (#) are comments. The plugin does not read these lines.
# You need to replace [yourdata] with your information.
# Enabling basic tracking has made my server lag. As far as I understand this come from the huge amount of mysql write queries the plugin executes.
#
#
# IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT
#
# I have set my IPB so that the users fill out a custom field with their minecraft username which is than
# used in CommunityBridge authentication check. In my opinion this is a better way of authenticating,
# because users can set their own username.
#
# This will require basic phpMyAdmin knowledge.
#
# You will need to create a custom profile field in IPB AdminCP.
# Now using phpMyAdmin find which field the new custom profile field uses.
# - The field is stored in the table <prefix>pfields_content


db-host: [yourdata]
db-port: [yourdata]
db-database: [yourdata]
db-username: [yourdata]
db-password: [yourdata]

#This will make the plugin print out your config into your console on start.
show-config: true

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

# This is the msg displayed to registered users.
registered-message: Registered Account, Linked to Server Forums. Full features unlocked.

# Msg displayed to unregistered users.
unregistered-message: Unregistered Account

# Msg displayed after [auto-remind-every] time.
unregistered-messagereminder: Just a reminder to visit [yourdata] and register for full access!

kick-unregistered: false

# [CUSTOM USER FIELD CONFIG]
# Because now, the minecraft username is stored in a different location than other data like ranks, we need to use multi tables configuration.
multi-tables: true

# This is unrelated to IPB
multi-tables-use-key: false
use-banned-field: false
banlist-table:
  enabled: false
  table: phpbb_banlist
  user-id-field: ban_userid
  reason-field: ban_reason
groups-table:
  enabled: false
  table: phpbb_users_groups
  user-id-field: ban_userid
  group-id-field: ban_reason
secondary-groups: false

#The permissions system you are using. (PEX, bPerms, GroupManager)
permissions-system: bPerms

#This will make the plugin autosync. Which means that the plugin will check the database for any changes to your users. This will cause some server load, and because the sync is done on login, this feature is on such a long timer, it will just cause lag with no real gain. In my opinion, best set to false.
#users will have to relogin to get new ranks you set.
auto-sync: false

# Remind unregistered people to register.
auto-remind: true

# These numbers are ms(miliseconds) so if you divide by 1000 you get the seconds.
auto-sync-every: 1200000
auto-remind-every: 470000

#This feature will record all basic user stats and store them into the forum database.
#Because there is currently no documentation on the configuration of website-end scripts that would display this data, this feature is currently useless. Unless you want the data stored for some reason.
#But there's better plugins for this.
enable-basic-tracking: false

# The configuration of mysql.
users-table:

# Table name where basic user details are stored. This is for IPB 3.3. The tables might be named differently for you. You can google this or find it yourself. The [yourdata] marks the prefix.
  table: [yourdata]_members

# User name field. Since we are using a custom field for minecraft identification this is useless.
# To demostrate, you can set it to anything and it will still work.
  user-name-field: brbr

# This is a number.
  user-id-field: member_id

# This identifies the group members are in. In our case this translates into mnc ranks.
  groups-id-field: member_group_id

# Not important for IPB.
  secondary-groups-id-field: sub_group_ids
  banned-field: member_banned
  banned-users-group: 5

# The group which unregistered people (aka guests) are in. It's 2, but in case your forum config is messed up you can check in 'conf_global.php'.
  default-group: 2

# Here we will set the custom field you've checked in the start.
multi-table:

# The name of the SQL table containing the custom field. [yourdata] marks the prefix.
  table: [yourdata]_pfields_content

# member_id linking the column to the user.
  field-user-id-field: member_id

#unimportant for IPB.
  field-key-field: key_str
  field-key-value: mcusername

#The name of the field in which the mnc username custom field is stored. If unsure, you can check it like this:
#Fill the custom profile field for minecraft username with something and remember what you filled it with.
#Now open phpMyAdmin and open _pfields_content and look for the value you used in the forum.
  field-value-field: field_11

#s
profile-requirements:
  require-avatar: false
  require-avatar-message: This server requires players to upload an avatar to their profile.
  require-avatar-table: ipbog3profile_portal
  require-avatar-user-id-field: member_id
  require-avatar-field: pp_main_photo
  require-minposts: false
  require-minposts-message: This server requires players to have a minimum of 3 forum posts.
  require-minposts-count: 3
  require-minposts-table: ipbog3members
  require-minposts-user-id-field: member_id
  require-minposts-field: posts

# As said in the header: useless for now.
# However if you do want to track this, you'll need to create new fields in the table [yourdata]_pfields_content
# All the fields are int(16) and nullable. Define their names with for example. 'field-onlinestatus-field'
basic-tracking:
  table: ipb_pfields_content
  field-onlinestatus-enabled: true
  field-onlinestatus-valueonline: 1
  field-onlinestatus-valueoffline: 0
  field-onlinestatus-key-value: mconlinestatus
  field-onlinestatus-field: field_14
  field-lastonline-enabled: true
  field-lastonline-key-value: mclastonline
  field-lastonline-field: field_15
  field-gametime-enabled: true
  field-gametime-key-value: mcgametime
  field-gametime-field: field_16
  field-totalxp-enabled: true
  field-totalxp-key-value: mctotalxp
  field-totalxp-field: field_18
  field-currentxp-enabled: true
  field-currentxp-key-value: mccurrentxp
  field-currentxp-field: field_17
  field-level-enabled: true
  field-level-key-value: mclevel
  field-level-field: field_19
  field-health-enabled: true
  field-health-key-value: mchealth
  field-health-field: field_20
  field-lifeticks-enabled: true
  field-lifeticks-key-value: mclifeticks
  field-lifeticks-field: field_21
  field-wallet-enabled: false
  field-wallet-key-value: mcwallet
  field-wallet-field: field_23

# Groups you want this plugin to set for users according to the forum ranks. The number is the user group ID, and the name is the name of the group you set.
groups:
  '1': validating
  '2': Guest
  '3': Member
  '6': Moderator
  '4': Admin
  '5': banned
  '7': SuperAdmin
  '8': Member*