Skip to content
This repository was archived by the owner on May 27, 2024. It is now read-only.

Configuration

GamerCoder edited this page May 6, 2023 · 3 revisions

Novaconomy has multiple configuration files. This page will cover the main configuration file (config.yml located in the Plugin Folder), and how you can customize the Novaconomy Plugin.

Pages featuring configuration will show the name of the setting, as well as any other parent values, and will be set to their default value. They may also feature additional comments for explanatory purposes.

The following economies will be used in these examples:

  • Poundz (%) with a scale of 2
  • Dollarz ($) with a scale of 1
  • Gripees (&) with a scale of 0.5

General Settings

General Settings that do not fit into any specific category.

Notifications

Whether players should be notified of Plugin Events, such as Interest being called on their balances.

Notifications: true

Language

The language of messages, names of items in Graphical Interfaces, as well as any other wording displayed by the plugin.

More information about Languages can be found here.

Language: en

Natural Causes

Configuration Section relating to Natural Causes and their events, meaning for balances automatically increased based on specific actions. For example, a player can get a balance gain if they mine specific blocks.

All Economies created with has-natural-increase set to true will be used as a reward for the causes listed.

EnchantBonus

Whether an enchantment (when applicable) should have an influence in the increase of the balance. The increase will not take effect if there is a modifier active (when applicable).

NaturalCauses:

  EnchantBonus: true

MaxIncrease

The maximum amount of money that can be gained from any natural caused event. Set to -1 for no limit.

NaturalCauses:

  MaxIncrease: 1000

KillIncrease

Whether the player will gain money from directly killing entities.

Money is calculated based on the maximum health of the entity and what tools were used.

NaturalCauses:

  KillIncrease: true

KillIncreaseChance

The chance (out of 100) of a kill increase happening. Must be an integer.

NaturalCauses:

  KillIncreaseChance: 100

KillIncreaseIndirect

Whether indirect kills, such as attacks from pets and projectiles, should count as a Kill Increase.

NaturalCauses:

  KillIncreaseIndirect: true

FishingIncrease

Whether players gain money from fishing items.

Money is calculated based on the fishing rod, and what was retrieved.

NaturalCauses:

  FishingIncrease: true

FishingIncreaseChance

The chance (out of 100) for a player to gain money from fishing items. Must be an integer.

NaturalCauses:

  FishingIncreaseChance: 70

FarmingIncrease

Whether players gain money from farming/breaking crop-related blocks, such as wheat, pumpkins, and melons.

Money is calculated by the experience of the drop and what tool was used.

NaturalCauses:

  FarmingIncrease: true

FarmingIncreaseChance

The chance (out of 100) for players to gain money from farming/breaking crop-related blocks. Must be an integer.

NaturalCauses:

  FarmingIncreaseChance: 40

MiningIncrease

Whether players gain money from mining any block. This will not apply to farming-reated blocks.

Money is calculated by the experience dropped, what was broken, and the tool used.

NaturalCauses:

  MiningIncrease: true

MiningIncreaseChance

The chance (out of 100) for a player to gain money from mining any non-farming related blocks. Must be an integer.

NaturalCauses:

  MiningIncreaseChance: 30

DeathDecrease

Whether a player's balance(s) should be divided if they die.

NaturalCauses:

  DeathDecrease: true

DeathDivider

When a player dies, the balance will be divided by this number, then the result will be removed from the player's balance.

NaturalCauses:

  DeathDivider: 2

Natural Cause Modifiers

Modifiers for specific blocks, entities, and/or tags to have a flat value awarded. This section will list examples.

Pricing is defined by the Economy's unique symbol, either before or after the number. There cannot be any commas in the number. Examples: $10, 50%, 66&, $5500

As of v1.5.1, Novaconomy now supports Block Tags (the ones with Material in between the <>), and are only available in MC 1.13 and above. Additionally, we also support Entity Categories, and those are only available in MC 1.17 and above.

All Entity Types can be found here.

All Materials can be found here.

All Death (Damage) Causes can be found here.

Mining Modifiers

Modifiers used for the MiningIncrease Natural Cause.

NaturalCauses:

  Modifiers:
    
    Mining:
      # Material Names are NOT case sensitive
      DIAMOND_ORE: 10$
      stone: %5
      oak_LOG: [8&, %5] # Put Multiple Prices in an array / list, cannot repeat
      dirt:
        - 5%
        - $15 
        - 99&
      red_bed: 60$ # Material will override the tag below
      beds: 50$
      

Killing Modifiers

Modifiers used in the KillIncrease Natural Cause.

NaturalCauses:
  
  Modifiers:

    Killing:
      zombie: [&100, 150$] # The Entity type will override the category below
      undead: 50$
      BLAZE: %200

Fishing Modifiers

Modifiers used in the FishingIncrease Natural Cause. These both support entities AND items because they can both be caught.

NaturalCauses:

  Modifiers:

    Fishing:
      cod: [50%, &15]

Farming Modifiers

Modifiers used in the FarmingIncrease Natural Cause. These are similar to how MiningIncrease works.

NaturalCauses:

  Modifiers:

    Farming:
      wheat: 5$
      pumpkin: &15

Death Modifiers

Modifiers used in the DeathDecrease Natural Cause. These will change the divider based on the Death (Damage) cause.

NaturalCauses:

  Modifiers:

    Death:
      fall: 3 # Divide by 3 when death was caused by fall damage
      LAVA: 6 # Divide by 6 when death was caused by lava

Ignored Elements

A type of modifier, as a list, of entities, blocks, categories, tags, and any other supported elements that should be ignored entirely from Natural Causes.

NaturalCauses:

  Ignore:
    - oak_log
    - ZOMBIE
    - stone
    - GRASS_block

Interest

Configuration Section dedicated to the management of interest on player balances.

Interest Enabled

Whether interest is currently enabled.

Interest:

  Enabled: true

Interest Interval

How often, in ticks (1/20 of a second) interest should take place.

Interest:

  IntervalTicks: 1728000 # A 24h Day, in ticks

ValueMultiplier

What a player balance will be multiplied by when running interest.

Interest:

  ValueMultiplier: 1.03 # 3% increase

Novaconomy Taxes/Banking

Configuration Section for Taxes, money that goes into Novaconomy Banks. This also includes Banking details.

Online Taxes

Whether players have to be online in order for taxes to affect them

Taxes:

  Online: false

Maximum Withdraw

The maximum amount a player can withdraw from the bank every 24 hours.

You can add you economy's full name (case sensitive) for their amount, or it will default to the Global amount.

You can also specify those that are immune to the MaxWithdraw. This supports OPS or NONOPS, Vault Groups, Permissions, and Player Names.

Taxes:

  MaxWithdraw:
   
    Global: 100 # Default if no economy is inputted
    Poundz: 50

    Bypass:
      - OPS # Operators can bypass
      - richguy95
      - my.custom.permission.bypasswithdraw
      - VaultUnlimitedWithraw

Taxes Ignore

A list of player names, permissions, and/or Vault Groups that are exempt from taxes.

Taxes:

  Ignore:
    - OPS
    - thenoopadmin_
    - my.custom.permission.notaxes
    - VaultIgnoreTaxes

Automatic Taxes

Configuration Section for taxes to be automatically taken.

Automatic Taxes Enabled

Whether Automatic Taxes are currently enabled.

Taxes:

  Automatic:

    Enabled: false

Automatic Interval

The interval, in ticks, for taxes to be withdrawn from a player's balance.

Taxes:

  Automatic:

    Interval: 1728000 # A 24h day, in ticks

Ignore Economies

A list of Economy Names that will not be automatically taxed.

Taxes:

  Automatic:

    Ignore: [Gripeez, Dollarz, MyCustomEconomy]

Deposit Minimums

The minimum amount that must be deposited into a bank/taxed on a player's balance.

Taxes:

  Minimums:

    Global: 0 # Defaults to this if an economy isn't specified
    Dollarz: 10

Tax Events

Custom Tax Events, callable by the /taxevent command.

Tax Events Enabled:

Whether Custom Tax Events are currently enabled.

Taxes:

  Events:

    Enabled: true

Creating custom Tax Events

Creating custom tax events in the configuration.

Taxes:

  Events:

      EnvironmentTaxes:
        name: "Environment Taxes"
        permission: novaconomy.admin.tax_event # Default Permission
        message: "&cYou have been taxed by the environment." # Message Broadcasted
        amount: [30D, $50]
        online: true # Whether the player must be online to be taxed
        use_ignore: true # Whether to include the Ignore list above
        ignore: [coolbro77, VaultEnvironemtalists, my.custom.permission] # List of Player Names, Vault Groups, or Permissions to exempt from taxes.
        deposit: true # Whether this event will deposit taken taxes into the bank

Bounties

Configuration Section dedicated to Novaconomy Bounties.

Bounties Enabled

Whether Novaconomy Bounties are currently enabled.

Bounties:

  Enabled: true

Broadcasting Bounties

Whether the completion of bounties should be broadcasted across the server.

Bounties:

  Broadcast: true

Businesses

Configuration Section dedicated to the management of all Novaconomy Businesses.

Business Advertising

Section related to business advertising.

Business Advertising Enabled

Whether business advertising is currently enabled.

Business:

  Advertising:

    Enabled: true

Business Advertising ClickReward

How much host businesses will be rewarded for having a click on their advertisement. The Economy is randomly selected (if has-clickable-reward set to true), and this value is multiplied by its conversion scale.

Business:

  Advertising:

    ClickReward: 5

Market

Configuration for the Novaconomy Market.

Enable the Novaconomy Market here:

Market:
  # Set to true to enable
  Enabled: true

Price Override

Override the price for an item in the Novaconomy Market. Economy Conversion Rates will automatically be applied when purchasing.

Market:
  # Item Names are case insensitive
  # Must be available in the Novaconomy Market
  PriceOverride:
    DIAMOND: 500
    dirt_block: 12
    Grass_Block: 24

Bank Deposit

Enables whether the money that was used to purchase on the Novaconomy Market will automatically deposit into the Novaconomy Bank.

Market:
  # Set to true to enable
  Deposit: true

Selling Market

Activated by /market sell, you can sell items on the Novaconomy market for a similar price back.

Sell Percentage

The percentage multiplied to the original price of an item, which is what you will receive upon selling the item. Defaults to 75% or 0.75.

Market:
  # Supports decimals and integers
  SellPercentage: 0.75

Sell Stock

Whether items that players sell to the market will add to the item's stock on the Novaconomy Market. For example, if a player sells 5 apples, then 5 apples will be added to the market's stock.

Market:
  # Set to 'true' to enable
  SellStock: true

Market Restock

Manage how items sold on the Market will be resock.

Market:
  Restock:
    # Set to true to enable automatic restock
    Enabled: true

Restock Amount

How much stock should be added to all items on a restock event.

Market:
  Restock:
    # Default is 1,000, supports integers only
    Amount: 1000

Restock IntervalTicks

How often the market should automatically restock, in ticks (1/20 of a second)

Market:
  Restock:
    # Default is 24h in ticks
    IntervalTicks: 1728000

Market Membership

How much players should pay to gain access to the Novaconomy Market. Enabled by default.

Market:
  Membership:
    # Set to 'true' to enable
    Enabled: true

Membership Cost

How much a membership costs by default. Economy conversion rates will automatically be applied.

Market:
  Membership:
    # Supports decimals and integers
    Amount: 1000.0

Clone this wiki locally