Configuration

Configuration

Basic

plugin:
    language:
        commands: English                            # Language you want to use for commands that matches a directory under translations.
        messages: English                            # Language you want to use for messages that matches a directory under translations.
    debugmode: false                                 # Enable/disable debugging mode and additional console output.
    usagestats: true                                 # Enable/disable usage stats reporting to CraftFire devs.
    logging: true                                    # Enable/disable logging to files.
    logformat: yyyy-MM-dd                            # Filename format of the AuthDB debug and error log files.
database:
    type: mysql                                      # Database type/driver to use. Current options are MySQL and eBean (Bukkit persistence).
    host: localhost                                  # MySQL server hostname, domain, IP, or localhost for local connections. MySQL only.
    port: 3306                                       # Port used for connecting to your MySQL server. This is usually 3306. MySQL only.
    username: root                                   # Username used to connect to your database. Only valid for MySQL.
    password: root                                   # Password used to connect to your database. MySQL only.
    name: forum                                      # Name of the database you are connecting to. MySQL only.
    keepalive: false                                 # Enable/disable keeping database connection alive. Do not use if your connection limit is low. MySQL only.
script:
    name: phpBB                                      # Name of the script you are using.
    version: 3.0.8                                   # Version of the script you are using.
    tableprefix: phpbb_                              # Database table prefix for the script, if you use one.

Advanced

customdb:
    enabled: false                                   # Enable/disable custom database support. Leave this disabled if using a script such as phpBB.
    autocreate: true                                 # Enable/disable automatic creation of the database tables and columns for a custom database.
    table: authdb_users                              # Table name to use for your custom database.
    userfield: username                              # Field/column name to use for storing user names.
    passfield: password                              # Field/column name to use for storing user passwords.
    emailfield: email                                # Field/column name to use for storing user email addresses. Leave blank to disable email requirement.
    emailrequired: false                             # Enable/disable registration email requirement.
    encryption: md5                                  # Encription type to use for password hashing. Options are MD5, SHA1, and SHA512.
join:
    restrict: true                                   # Only allow registered players to join and show custom message.
register:
    enabled: true                                    # Enable/disable allowing users to register.
    force: true                                      # Enable/disable forcing users to register.
    delay: 4 seconds                                 # Amount of time before register message is shown to player.
    timeout: 3 minutes                               # Amount of time a player has to register before the configured action is taken.
    limit: 3                                         # Amount of times an user can register from a specific IP.
login:
    method: prompt                                   # Login method to use. Options are normal and prompt.
    delay: 4 seconds                                 # Amount of time before login message is shown to player.
    timeout: 3 minutes                               # Amount of time a player has to login before the configured action is taken.
    tries: 3                                         # Number of allowed incorrect password tries.
    action: kick                                     # Action to perform when a maximum number of password tries is reached. Currently only option is kick.
link:
    enabled: true                                    # Enable/disable username linking.
    rename: true                                     # Enable/disable renaming users to linked name on link.
unlink:
    enabled: true                                    # Enable/disable username unlinking.
    rename: true                                     # Enable/disable renaming users to original name on unlink.
username:
    minimum: 3                                       # Minimum number of characters a username can be.
    maximum: 16                                      # Maximum number of characters a username can be.
password:
    minimum: 6                                       # Minimum number of characters a password can be.
    maximum: 16                                      # Maximum number of characters a password can be.
session:
    enabled: true                                    # Enable/disable player sessions. Ignored if online-mode: true in server.properties.
    start: login                                     # When to start the player's session. Options are login and logoff.
    length: 1 hour                                   # Length of the player's session. Can be any number of seconds, minutes, hours, or days.
    protect: true                                    # Enable/disable protecting player from being logged out from another location.
guest:
    commands: false                                  # Enable/disable guest commands.
    chat: false                                      # Enable/disable guest chat.
    building: false                                  # Enable/disable guest building.
    destruction: false                               # Enable/disable guest destruction.
    movement: false                                  # Enable/disable guest movement.
    interactions: false                              # Enable/disable guest interactions with objects.
    inventory: false                                 # Enable/disable guest inventory usage.
    drop: false                                      # Enable/disable guest being able to drop items.
    pickup: false                                    # Enable/disable guest being able to pickup items.
    health: false                                    # Enable/disable guest getting hurt.
    pvp: false                                       # Enable/disable guest hurting players.
    mobtargeting: false                              # Enable/disable mobs targeting guest.
    mobdamage: false                                 # Enable/disable mob damage from guest.
protection:
    freeze:
        enabled: true                                # Enable/disable freezing players on join to prevent movement.
        delay: 2 seconds                             # Amount of time before players are frozen and unable to move.
    notify:
        enabled: true                                # Enable/disable protection message being sent to player.
        delay: 3 seconds                             # Amount of time before protection message can be sent to player again.
filter:
    action: kick                                     # Action to perform when a username matches the filter. Options are kick and rename.
    username: "`~!@#$%^&*()-=+{[]}|\\:;\"<,>.?/ "    # Characters and symbols to check for in usernames. We recommend leaving this as is.
    password: "$&\\\""                               # Characters and symbols to check for in passwords. We recommend leaving this as is.
    whitelist: Contex,Wulfspider                     # Usernames to exclude from username and password filtering.