config.yml reference
plugins/MachineEngine/config.yml is written on the first start, with a comment
above every setting.
- Updates add new settings with their defaults; your values and comments are kept.
- A wrong value is reported in the log and its default is used until you fix
it. Numbers with a range (
save-interval,load-timeout) are moved to the nearest allowed value instead. /machineengine reload configapplies changes without a restart, except the settings marked restart below. It also reloads the menu files.
limits
| Setting | Default | Effect |
|---|---|---|
max-machines-per-chunk | 256 | Most machines a single chunk may hold. Players with machineengine.admin are exempt. 0 = no limit. |
menus
Machine menus need zMenu; see Machine menus.
| Setting | Default | Effect |
|---|---|---|
default | machine | Menu file (in menus/, without .yml) used when nothing more specific exists. |
by-type | {} | Menu file per machine type, e.g. example:generator: machine. Wins over <namespace>_<value>.yml. |
events
| Setting | Default | Effect |
|---|---|---|
bukkit-bridge | true | Restart. Mirror machine events as Bukkit events for plugins that do not use the MachineEngine API. Unused events cost nothing. |
placeholders
| Setting | Default | Effect |
|---|---|---|
allow-breaking | false | Whether players without machineengine.admin.breakplaceholders may break placeholder machines (machines whose addon is missing). Breaking one destroys its data. |
players
Data addons keep per player (Mekanized's radiation dose, for instance) and the
settings players change with /machinesettings. See
Player data and settings.
| Setting | Default | Effect |
|---|---|---|
storage | machineengine:pdc | Restart. Where player data is saved: machineengine:pdc with the player's own data file, or machineengine:files in plugins/MachineEngine/players/ (admins can then edit offline players). Addons may add others. Switching does not move existing data. |
save-interval | 60 | Seconds between saves of changed data (5 – 3600). Data is also saved when a player leaves and when the server stops. |
load-timeout | 5 | Seconds a joining player waits for their data (1 – 60), for storages other than machineengine:pdc. When it takes longer, the player is refused rather than let in without it. |
setting-defaults | {} | Default value of a player setting for players who did not choose one, e.g. "mekanized:radiation_hud": false. |
locked-settings | [] | Settings players may not change: they keep the value of setting-defaults (or the built-in default). |
resources
The energy and fluids MachineEngine provides to every addon and definition. All of these need a restart.
| Setting | Default | Effect |
|---|---|---|
energy.unit | J | Unit shown after energy amounts. |
energy.scale | 0 | Decimal digits of energy amounts: with 3, 1500 is shown 1.500. |
fluid.unit | mB | Unit shown after fluid amounts. |
fluid.scale | 0 | Decimal digits of fluid amounts. |
fluid.bucket | 1000 | Amount of fluid in one bucket (and one source block). |
fluid.water-color | '#3F76E4' | Color of water in menus, "#RRGGBB" (quote it). |
fluid.lava-color | '#E0641A' | Color of lava in menus, "#RRGGBB" (quote it). |
The full default file
plugins/MachineEngine/config.yml
limits:
max-machines-per-chunk: 256
menus:
default: machine
by-type: {}
events:
bukkit-bridge: true
placeholders:
allow-breaking: false
players:
storage: machineengine:pdc
save-interval: 60
load-timeout: 5
setting-defaults: {}
locked-settings: []
resources:
energy:
unit: J
scale: 0
fluid:
unit: mB
scale: 0
bucket: 1000
water-color: '#3F76E4'
lava-color: '#E0641A'