# settlementPerksConf.yml
The `settlementPerksConf.yml` allows configuring the available settlement perks and their prices.

Each perk can have the following options:

## icon
The icon that should be shown in the GUI. ([Material](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html)) If it's a potion (the default value is a lingering one) and an effect is defined then it will just use a potion of the configured effect.

## repeat
The amount of times this upgrade can be repeated. This allows to make re-purchasable upgrades to trigger effects.

Default if not specified is `0` so no repeatings are allowed.

## cooldown
How long one has to wait (in seconds) between unlocks if amount is above 1. If it's 0 then there is no cooldown.

## state
The settlement state that is required for this perk to be available. Possible states are `village` and `kingdom`

## level
The settlement level in the previously specified state which is required to unlock the perk.

## effects
The effects (in a map list) that members of the settlement get applied when the perk is active.

Effects can have the following options:

### type
The [potion effect type](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionEffectType.html).

### strength
The strength of the potion effect

### length
The length of the potion effect after applying it in seconds.

Don't specify it or set it to -1 to make it indefinite.

### ambient
Whether or not particles should be more translucent. If not specified it defaults to `true`

### particles
Whether to show potion particles or not. If not specified it defaults to not showing it (`false`)

### icon
Whether or not to show the icon of the effect. If not specified it defaults to `true`

### apply
This section allows to specify where and to whom the potion effect should apply.

#### in

Where the effect should happen. Possible options are:

- `plot` - Only for the owner of a plot on the plot
- `plot-friends` - Like plot just for friends of the owner too
- `own-settlement` - Effect only in own settlement (**default** if not set)
- `allied-settlement` - Effect in own and all allied settlements
- `enemy-settlement` - Effect only while in enemy settlement
- `unclaimed` - only in unclaimed chunks
- `everywhere`  - everywhere

#### to

Who should get the effect. Possible options are:

- `members` - all members of the settlement (**default**)
- `allies` - applies to all allies
- `trusted` - applies to all members of the same empire
- `enemies` - applies to all enemies
- `free` - applies to everyone without a settlement
- `all` - applies to everyone

<box teal>Note that embassy plot owners are treated like they are residents of the settlement they own a plot in but only on their plot.</box>

## bonus
The claim adds bonus claims or outpost counts. This way a settlement can purchase those if this is repeatable.

### claims
The amount of bonus claims the perk grants

### outposts
The amount of bonus outposts the perk grants

## run-command
A list to run arbitrary console commands for all members of the settlement.

Possible placeholders in commands: `{player}`, `{playerid}`, `{settlement}`, `{state}`, `{level}`, `{perk}`

## cost
A map of the costs of this perk. Can include `cash` to pay with the settlement's bank or any [Material](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html) to pay from the Vault.

If the cost is empty then the perk will be instantly granted when the state and level requirements are reached.

Example:

<code yaml>
  cost:
    unlock:
      cash: 1000
      stone: 100
    # If the amount is higher than 1 then this is the cost that needs to be paid to trigger it again
    repeating:
      cash: 100
</code>

### unlock
How much it costs to unlock this perk

### repeating
How much it costs to repeat the perk if it is repeatable