Config - NickImpact/Bidoof-Unleashed GitHub Wiki

The configuration files for Bidoof Unleashed can be located as follows:

Specifications File Location
Base Settings /config/bu3/bidoof-unleashed.conf
Lang Settings /config/bu3/lang/{{locale}}.conf

Bidoof Unleashed will attempt to add new configuration options if they are missing from the file, but do note that this can have side effects, causing your once beautiful file to lose its comments and organization.

Index

General

Gyms

Team Pools

Storage

Descriptions

leaders

The leader section specifies settings to handle for plugin defined leaders. There are two options: login-msg and open-on-login.

  • login-msg - Specifies whether a login message should be displayed for plugin defined leaders.
  • open-on-login - Specifies whether we should open the gyms the leader is apart of. (Note that this will open every single one)
Example
"leaders": {
    "login-msg": true,
    "open-on-login": true
}

defaults

Specifies default settings a gym receives when it is created.

  • cooldown - Specifies the default cooldown period (in minutes) for a player after they lose to a gym.
Example
"defaults": {
    "cooldown": 60
}

teleport

Specifies settings relating to how a gym will manage teleporting.

  • wait - How long should players wait (in seconds) before they are teleported to an accepted challenge.
Example
"teleport": {
    "wait": 10
}

save-on-delete

Specifies whether or not a gym's Pokemon pool will be deleted along with it.

Example
"save-on-delete": true

storage-method

Declares the type of data holder we should use to preserve our data.

Accepts: h2, mysql, flatfile, json

Example
"storage-method": "h2"

sql-table-prefix

Declares the prefix for table entries from this plugin.

Example
"sql-table-prefix": "bu3_"

data

This section details the specification of credentials to connect to a database.

Note: This should only apply currently to MySQL databases.

  • address - The host to be used for the database. Uses the standard DB engine port by default. If you have a non-default port, specify it here using host:port
  • database - The name of the database to use
  • username - The username we should use to connect to the database
  • password - The password we should use to connect to the database
Example
"data": {
    "address": "localhost",
    "database": "database",
    "username": "user",
    "password": "pass"
}