#
# Main configuration file
#
# You can find a list of available tags here: https://alessiodp.com/wiki/parties/placeholders
#

# / = = = = = = = = = = = = = = = = \
# |        PARTIES  SETTINGS        |
# \ = = = = = = = = = = = = = = = = /
parties:
  updates:
    # Check for updates, recommended. Parties will check for updates when the server finish to load
    check: true
    # Send a message to admins if an update is available
    warn: true
  # Message upon login and logout of partymates
  join-leave-messages: false


# / = = = = = = = = = = = = = = = = \
# |        STORAGE  SETTINGS        |
# \ = = = = = = = = = = = = = = = = /
storage:
  # What type of storage Parties should use?
  # Available types:
  # none = Parties data is saved into memory (A reload reset everything, disable log if used on it)
  # File based:
  # * txt = Output to file (ONLY LOG)
  # * yaml = Save all data into a YAML file (ONLY DATABASE)
  # SQL based:
  # * mysql = Save all data into a MySQL database
  # * sqlite = Save all data into a SQLite database
  log-storage-type: none
  database-storage-type: yaml
  log-settings:
    # Log format
    # %date% = Date as yyyy-MM-dd
    # %time% = Time as HH:mm:ss
    # %position% = Debug purpose, show caller class (USE IT TO REPORT BUGS)
    # %level% = Mode of the message
    # %message% = Message
    format: "%date% [%time%] (%level%) {%position%} %message%\n"
    # Log chat of parties
    chat: true
    # Print messages on the console
    print-console: true
    # Levels:
    # 1: Basic log level
    # 2: Log all events that interacts with the database
    # 3: Debug level (Log a lot of events)
    log-level: 1

  migrate-settings:
    # Used to initialize an unused database to make it migratable
    initialize-storage:
      yaml: false
      mysql: false
      sqlite: false
    # Command migrate can be used only via console
    migrate-only-console: true
    # Rename old data.yml (Empty to overwrite)
    migration-suffix: "_backup"

  storage-settings:
    file-based:
      # File based DBs: YAML
      txt:
        log-name: "log.txt"
      yaml:
        database-name: "data.yml"

    sql-based:
      # SQL based DBs: MySQL, SQLite
      general-settings:
        varchar-size: 255
        upgrade:
          save-old-table: true
          old-table-suffix: "_backup"
        tables:
          parties: "parties_parties"
          players: "parties_players"
          log: "parties_log"
          versions: "parties_versions"
      mysql:
        address: "localhost"
        port: "3306"
        database: "database"
        username: "username"
        password: "password"
        # Size of the connection pool
        pool-size: 10
        # Lifetime of each connection, in milliseconds (Default: 30 minutes = 1800000ms)
        connection-lifetime: 1800000
        # Property used to alert when the connection is not using a valid SSL certificate
        use-ssl: false
        # Charset used by tables
        charset: "utf8"
      sqlite:
        # SQLite is a SQL database that store data into a file
        database-name: "database.db"

    none:
      disband-on-leader-left: true
      # Delete empty parties after tot seconds
      delay-delete-party: 600


# / = = = = = = = = = = = = = = = = \
# |       ADDITIONAL SETTINGS       |
# \ = = = = = = = = = = = = = = = = /
additional:
  auto-command:
    # All partymates will use the same command that the leader uses (Rank permission: party.autocommand)
    # You can configure the leader with rank permissions
    enable: false
    # Important: Blacklist/whitelist your commands to prevent exploits (Pay for example)
    # Blacklist/whitelist your commands with a "start-with" check (Block /pay to prevent commands like "/pay bla bla", "/paymember bla", "/payment")
    # If you whitelist a command, you will bypass it (if it is blacklisted)
    # You can insert '*' for all commands
    blacklist:
    - "/pay"
    - "/money"
    whitelist: []

  censor-system:
    # This censor system is used when a player create a party or set description/motd/etc..
    enable: false
    case-sensitive: false
    contains: []
    starts-with: []
    ends-with: []
    regexes: []

  follow-party:
    # When a player join a server, the entire party will follow him
    enable: true
    perform-commands:
      enable: true
      delay: 2000
      commands: []
    # List of servers allowed to join into (Regexes allowed)
    blocked-servers:

  mute:
    # Enable mute command
    # If an user use mute command, it will stop to receive every notification
    enable: false
    block:
      invite: true

  placeholders:
    # This options are used to customize Parties placeholders
    # You can customize every external placeholder
    # Use classic placeholders inside the option!
    color-name: "%color_name%"
    color-code: "%color_code%"
    color-command: "%color_command%"
    desc: "%desc%"
    kills: "%kills%"
    motd: "%motd%"
    party: "%party%"
    rank-name: "%rank_name%"
    rank-chat: "%rank_chat%"
    customs:
      example1: "[%color_code%%party%] "
      example2: "[%rank_chat% %party%] "


# / = = = = = = = = = = = = = = = = \
# |        COMMANDS SETTINGS        |
# \ = = = = = = = = = = = = = = = = /
commands:
  help-pages:
    commands-per-page: 9
  main-commands:
    help: "help"
    party: "party"
    p: "p"
    accept: "accept"
    chat: "chat"
    color: "color"
    create: "create"
    delete: "delete"
    deny: "deny"
    desc: "desc"
    ignore: "ignore"
    info: "info"
    invite: "invite"
    join: "join"
    kick: "kick"
    leave: "leave"
    list: "list"
    migrate: "migrate"
    motd: "motd"
    mute: "mute"
    password: "password"
    rank: "rank"
    reload: "reload"
    rename: "rename"
    spy: "spy"
    teleport: "teleport"
  sub-commands:
    on: "on"
    off: "off"
    silent: "silent"
    # Sub-command of "/party create <partyname> fixed" (if enabled)
    fixed: "fixed"
    # Sub-command used to remove something (desc, motd, etc..)
    remove: "remove"
  order:
  - help
  - create
  - accept
  - deny
  - join
  - ignore
  - mute
  - p
  - leave
  - invite
  - info
  - list
  - chat
  - desc
  - motd
  - color
  - teleport
  - password
  - rank
  - rename
  - kick
  - spy
  - delete
  - reload
  - migrate

# End of configuration file
dont-edit-this:
  version: 3