Config and Setup - Masstrix/Eternal-Nature GitHub Wiki

Configuration has been designed to be made easy to understand and handle with plenty of options to change and alter. Most settings are able to be changed in game with the settings menu that can be opened with /en settings.

General

check-for-updates If true the plugin will check to see if there is a newer version available.

notify-update-join If true players with the permission eternalnature.admnin or is op will receive a message if the current version is out of date.

Global Settings

These are the core settings that are applied for all worlds on the server.

global:
  falling-leaves:
    enabled: true
    range: 12
    fidelity: 3
    max-particles: 300
    scan-delay: 100
    spawn-chance: 0.005
    enabled: true
    range: 20
    scans: 2
  auto-plant:
    play-sound: true
    enabled: true
    replant-crops: true
    saplings: 0.6
    wheet: 1.0
    carrot: 1.0
    potato: 1.0
    melon: 0.8
    pumpkin: 0.8
    beetroot: 1.0
    sweet_berry: 1.0
    flowers: 0.2

randomly-spread-trees sets if trees will randomly drop saplings making forests slowly grow over time. To make saplings spawn more frequently increase the scans.

Falling Leaves

Falling leaf 'particles' are just armour stands as there is no way to create new particles server side. With this keep in mind that the higher you have it set the more entities there are being spawned which will impact server performance and could affect some players fps if to high.

enabled Sets if the falling leaf 'particles' are enabled.

range Sets the diameter of the scan area.

fidelity Sets the fidelity or quality of scanning done around the player. Higher this is the less blocks will be scanned per scan for nearby leave blocks. This can be used to reduce strain on the server if it is causing to much

max-particles Sets a hard cap on how many leaf 'particles' can be spawned at one time.

scan-delay

spawn-chance

Auto Plant

enabled sets if plants will attempt to automatically plant.

play-sound sets if a sound is played when they plant. This is the same sound as normally placing the item.

replant-crops if enabled will replant a crop when it's fully grown.

All other options from the auto-plant section are the random chance of that plant being automatically planted. To disable a plant from being planted set it to 0.0.

---

Hydration

hydration:
  enabled: true
  increase-from-activity: true
  damage-when-empty: true
  display:
    enabled: true
    style: BOSSBAR
    warning-flash: true
  drink_from_open_water: true
  thirst-effect:
    enabled: true
    dehydrate-by: 0.1
  consumables:
    water_bottle: 4
    potion: 3
    milk_bucket: 7

enabled Sets if hydration is enabled.

lose-from-activity If true players will slowly lose hydration from walking around.

damage-when-empty When enabled players will be damaged when they have run out of water.

drink_from_open_water If enabled players will be able to drink strait from open water.

Thirst Effect

enabled If enabled players can get the thirst effect from doing actions such as drinking from open water.

dehydrate-by Sets how much the player should dehydrate by each update tick. It's recommended to keep this low or hydration will become hard to manage at the start of games when you don't have a better source than open water.

Display

enabled If false the plugin will not display the players temperature to them. This may be useful if you are using another method to display it such as PlaceHolderAPI.

style set where the hydration is displayed. This is either BOSSBAR, ACTIONBAR or XP_BAR.

warning-flash flashes the hydration text when it's at a critical level.

Consumables

This is a list of items that when consumed will add some hydration to the player. The value of a full bar is the same as the players health of 20. The values will never go higher than this. You can set any material to have a consumable value, though it will only work for items the player can actually eat such as cooked_beef or water_bottle.

---

Temperature

temperature:
  enabled: true
  cause-damage: true
  increase-from-sprinting: true
  burn: true
  freeze: true
  sweat: true
  cold-damage: -5
  heat-damage: 90
  display:
    enabled: true
    style: BOSSBAR
    warning-flash: true
  advanced:
    use-blocks: false
    use-biomes: true
    use-envronment: true
    block-generate-method: chunk
    save-chunk-data: false
    thread-limit: 20
    chunk-pool-cap: 20

enabled Sets if temperature is enabled. If disabled chunks will also not be calculated reducing server load.

cause-damage If true players who are really hot or cold will be slowly damaged.

increase-from-sprinting If true players temperature will increase slightly when sprinting making them dehydrate slightly faster.

burn If enabled players who's temperature is above head-damage will start being hurt. The rate at which they are damaged will slowly increase as the temperature increases.

freeze If true players who are colder than cold-damage will start being hurt.

sweat If true players will randomly sweat, increasing in frequency the hotter they become.

display.enabled If false the plugin will not display the players temperature to them. This may be useful if you are using anothe method to display it such as PlaceHolderAPI.

style set where the temperature is displayed. This is either BOSSBAR or ACTIONBAR.

warning-flash flashes the temperature text when its nearing a harmful temperature.

Advanced

use-blocks If enabled every block will be scanned to create an accurate 3D temperature map on a chunk by chunk basis. This can heavily impact on performance and is not recommended for low end servers. It's recommended to have this disabled for the best performance. At the moment this feature is currently hard disabled for performance reasons.

use-biomes If enabled biomes will be included in the temperature calculations. This is light weight and is recommended to be used all the time for any server.

use-envronment If enabled environmental factors will be included in the temperature. This includes things such as weather, altitude and wind.

block-generate-method The method used for if use-blocks is enabled. Options are chunk, live or dynamic. This currently affects nothing.

save-chunk-data If true chunk data will be saved to disk. This will only work if use-blocks is enabled and the block-generate-method is set to be chunk.

thread-limit Limit of how many threads can be used at one time when generating chunks. Recommended to keep this lower on less performant machines.

chunk-pool-cap Sets how many chunks can be getting processed at one time. The higher this is the heaver of an impact generating chunks will be but increase the speed at which they can be done if the system can handle the extra load.