Configuration
Updated with v1.0.0
Default Config
Storage: engine: sqlite MySQL: user: root pass: '' port: 3306 db: minecraft host: localhost Settings: Currency: SingularName: Coin PluralName: Coins Accounts: StartingAmount: 0 ServerAccount: Server AddBalanceToServerAccountOnDelete: true Interest: Enabled: true Type: flat Flat: Rate: 0.1 SubtractFromServerAccount: true Bracket: SubtractFromServerAccount: true Factor: UseServerAverage: true High: Rate: 0.005 Minimum: 50000 Low: Rate: 0.1
Config Nodes Explained
Storage
- engine: Which storage to use, defaults to sqlite.
- Options: mysql or sqlite. (If you do not spell mysql correctly or use anything that isn't sqlite - it defaults to sqlite)
- MySQL - Everything in this section only applies if you are using a MySQL database for storage.
- user: Username for MySQL Database.
- pass: Password for MySQL Database.
- port: Port for MySQL Database.
- db: Name of MySQL database.
- host: Host of MySQL database.
Settings
- Currency
- SingularName
- Defaults to Coin. This is the name of the currency if the player has exactly 1 of whatever it is. IE: [Player] has 1 Coin.
- PluralName
- Defaults to Coins. This is the name of the currency if the player has any value other than 1 of whatever it is. IE: [Player] has 50 Coins.
- SingularName
- Accounts
- StartingAmount:
- Can be any decimal or integer. This is the amount an account has when it is created. Defaults to 0.
- ServerAccount
- The name of the official server account. This account is automatically created on startup.
- AddBalanceToServerAccountOnDelete
- If set to true, when an account is deleted their balance will be added to the server account.
- StartingAmount:
- Interest
- Enabled
- Whether or not the server has the interest system enabled.
- Type
- Can be flat or bracket. Flat taxes uses the same % for everyone, bracket taxes change based on how much money the player has.
- Flat
- Rate
- The rate everyone gains interest at when compounded. This is a percent formatted as a decimal. (.1 = 10%)
- SubtractFromServerAccount
- Whether or not the funds distributed via the interest system should be subtracted from the server account.
- Rate
- Bracket
- SubtractFromServerAccount
- Whether or not the funds distributed via the interest system should be subtracted from the server account.
- Factor
- UseServerAverage:
- Whether or not the server should use the average amount of currency per player when determining the amount of interest to give someone.
- The average is calculated from all accounts with any amount of currency that is NOT the server account. Accounts with 0 are skipped.
- Using this system, any player with more currency than average will be in the 'High' bracket, while any player with less will be in the 'Low' bracket.
- UseServerAverage:
- High
- Rate
- The rate to give the players in the high bracket. A % formatted as a decimal. (.005 = 0.5%)
- Minimum: 50000
- If UseServerAverage is false, any player above this threshold will be considered a member of the high bracket.
- Rate
- Low
- Rate
- The interest % formatted as a decimal that members in the low bracket will receive. (.01 = 1%)
- SubtractFromServerAccount
- Enabled
Comments