View source for Frostiful:Config File

The [[Mod:Frostiful|Frostiful]] '''config file''' is a bit of a beast, but this guide will help walk you through what each of the options do. Items in ''italics'' are the important options that are fairly straightforward and are the ones you most likely will want to adjust.

{{Message box|text=This page reflects the latest version of the config for Minecraft 1.21.x. Items documented here may not necessarily reflect what appears in an older version of Frostiful. Starting from Frostiful 2.2, removed options will be documented in [[#Removed Config Options]].}}

=== Update Config ===

The update config is used to enable or disable automatic config updates when significant changes are made to the default config values.

; Current config version {{code|currentConfigVersion}}: This just saves the current version of the config, '''you should not touch this.'''

; ''Enable config auto updates {{code|enableConfigUpdates}}'': Whether to allow the config to reset itself whenever the config is out of date. For most modpacks, I'd recommend turning this off.

=== Client Config ===
These are a set of client-side settings that contain options for things like accessibility, rendering, and the HUD. Changing these on a dedicated server will do nothing.

; Frost overlay start percent (0-1) {{code|frostOverlayStart}}: Double between 0 and 1 that determines at what negative temperature scale the vanilla powder snow border overlay should start rendering at
; Do cold heart overlay {{code|doColdHeartOverlay}}: Whether to render the cold heart overlay or not
;  Render water drip particles when wet {{code|renderDripParticles}}: Whether to render water dripping particles on wet players (does nothing if Scorchful is installed)
; Disable frost overlay when wearing Cloak of Frostology {{code|disableFrostOverlayWhenWearingFrostologyCloak}}: Whether to disable the frost overlay (powder snow border) from showing when wearing the Cloak of Frostology
; ''Shake hand when shivering'' {{code|shakeHandWhenShivering}}: Whether to shake the player's hand in first person when [shivering](./Temperature-System).
; Hand shake intensity {{code|handShakeIntensity}}: How intense the hand shaking should be when shivering.

=== Combat config ===

This config contains anything related to combat.

; ''Do chillager patrols'' {{code|doChillagerPatrols}}: Whether Chillagers should replace Pillagers in patrols in snowy biomes
; Strays carry frost arrows {{code|straysCarryFrostArrows}}: Whether Strays will carry Glacial Arrows.
; Max frost spell distance {{code|maxFrostSpellDistance}}: The maximum distance the spell cast by the Frost Wand should be able to go before exploding.
; Frost Wand cool down (ticks) {{code|frostWandCooldown}}: The cooldown time (in ticks) of the Frost Wand after casting a spell.
; Frost Wand root time (ticks) {{code|frostWandRootTime}}: The time (in ticks) that the Frozen Rooted effect of the Frost Wand should last.
; Frostologer heat drain per tick {{code|frostologerHeatDrainPerTick}}: How much heat the Frostologer should drain from nearby targets per tick when using its freezing attack.
; Packed snowball freeze amount {{code|packedSnowballFreezeAmount}}: The amount of temperature that the Packed Snowball should remove when thrown at an entity.
; Packed snowball damage {{code|packedSnowballDamage}}: The amount of Damage that the Packed Snowball should apply when thrown at an entity.
; Packed snowball vulnerable types damage {{code|packedSnowballVulnerableTypesDamage}}: The amount of Damage that the Packed Snowball should apply when thrown at an entity that belongs to the tag {{code|#minecraft:freeze_hurts_entity_types}}.
; Max Frost Bite Max Amplifier (inclusive) {{code|biterFrostBiteMaxAmplifier}}: The maximum level of the Frost Bite effect to apply to players frozen by the Frost Wand when attacked by a Biter (inclusive)
; Chillager fire damage multiplier {{code|chillagerFireDamageMultiplier}}: Increases damage Chillagers take from fire
; Frostologer fire damage multiplier {{code|frostologerFireDamageMultiplier}}: Increases damage Frostologers take from fire
; Ice Skate upgrade generate chance in Igloos (0-1) {{code|skateUpgradeTemplateIglooGenerateChance}}: Chance of an Ice Skate upgrade template appearing in an Igloo chest

=== Freezing Config ===

This config contains all of the values associated with freezing.

; ''Do passive freezing'' {{code|doPassiveFreezing}}: Global toggle on whether passive freezing should be enabled. Both this config option and the gamerule {{code|frostiful.doPassiveFreezing}} must be true for passive freezing to take effect!
; ''Do wind spawning'' {{code|doWindSpawning}}: Whether Freezing Wind should spawn
; ''Wind spawn strategy'' {{code|windSpawnStrategy}}: The strategy to be used when spawning freezing wind. One of {{code|NONE}}, {{code|POINT}}, or {{code|ENTITY}}. Defaults to {{code|ENTITY}}. See the alternate strategies page on the Weather page for more information.
; Do wind spawning in air {{code|spawnWindInAir}}: Whether Freezing Wind should spawn in the air
; ''Wind destroys torches'' {{code|windDestroysTorches}}: Whether Freezing Wind can destroy open flames.
; Do snow packing from heavy entities {{code|doSnowPacking}}: Whether heavy entities should turn snow layers they step on into packed snow.
; ''Passive freezing tick interval'' {{code|passiveFreezingTickInterval}}: How many ticks occur between applying passive freezing. This is intended to be used to allow configuring passive freezing to work slower than it does by default. Setting less then or equal to 1 makes passive freezing occur every tick.
; Wind spawn cap per second {{code|windSpawnCapPerSecond}}: The maximum number of Freezing Wind events allowed to spawn per second
; Wind spawn rarity {{code|windSpawnRarity}}: Controls the chance of wind spawning when snowing. Higher values mean less wind.
; Wind spawn rarity {{code|windSpawnRarityThunder}}: Controls the chance of wind spawning in a thunder storm. Higher values mean less wind.
; ''Max passive freezing percent (0-1)'' {{code|maxPassiveFreezingPercent}}: The minimum temperature scale at which passive freezing should apply (higher values = you can freeze more)
; Soak percent from splash water bottle (0-1) {{code|soakPercentFromWaterPotion}}: A 0-1 percentage of how wet splash water bottles should make a player.
; Sun Lichen heat per level {{code|sunLichenHeatPerLevel}}: The amount of temperature that Sun Lichen adds to entities per level of warmth (The levels are cold=0, cool=1, warm=2, hot=3).
; Sun Lichen burn time {{code|sunLichenBurnTime}}: How long Sun Lichen should set entities on fire when overheating, in ticks.
; Campfire warmth search size {{code|campfireWarmthSearchRadius}}: How far away Campfires can warm players when a log is added.
; Campfire warmth time {{code|campfireWarmthTime}}: The amount of time in ticks that Warmth granted by campfires should last
; Freezing wind frost (per 5 ticks) {{code|freezingWindFrost}}: The amount of temperature to remove from players when colliding with wind
; Conduit Power warmth per tick {{code|conduitPowerWarmthPerTick}}: The amount of temperature gained from having the Conduit Power status effect whilst submerged in water.
; Heat from hot floor (magma block, campfire) {{code|heatFromHotFloor}}: How much heat to apply per tick to entites standing on hot floor blocks, such as magma blocks
; Start shivering when below temp {{code|shiverBelow}}: The temperature scale below which to have entities start shivering. Scale from -1 to +1.
; ''Shivering warmth per tick'' {{code|shiverWarmth}}: How much warmth shivering should apply per tick.
; Stop shivering warmth below food level {{code|stopShiverWarmingBelowFoodLevel}}: The food level below which shivering should not apply heat.
; Warming food and drink Warmth duration (ticks) {{code|warmFoodWarmthTime}}: How many ticks Warmth should be applied for when consuming Warming foods. That is, food with the item tag {{code|#frostiful:warm_foods}}. This tag is mainly used for integration with warming food and drinks from mods like Farmer's Delight.

=== Icicle Config ===

This config contains values associated with icicles.

; ''Icicles form in weather'' {{code|iciclesFormInWeather}}: Whether Icicles should form during weather events.
; Become unstable chance {{code|becomeUnstableChance}}: The chance of an icicle block attempting to become unstable on random tick.
; Grow chance {{code|growChance}}: The chance of an icicle block attempting to grow on random tick.
; Grow chance during rain {{code|growChanceDuringRain}}: The chance of an icicle block attempting to grow on random tick when its raining.
; Grow chance during thunder {{code|growChanceDuringThunder}}: The chance of an icicle block attempting to grow on random tick when its thundering.
; Frost arrow freeze amount {{code|frostArrowFreezeAmount}}: The amount of temperature to remove from victims of a Glacial Arrow.
; Thrown icicle freeze amount {{code|thrownIcicleFreezeAmount}}: The amount of temperature to remove to from entities when they have an icicle thrown at them.
; Icicle collision freeze amount {{code|icicleCollisionFreezeAmount}}: The amount of temperature to remove from entities that hurt themselves on an icicle.
; Maximum light level to form (exclusive) {{code|maxLightLevelToForm}}: The maximum (block) light level that icicles are allowed to form at, exclusive upper bound.
; Minimum sky light level to form (inclusive) {{code|minSkylightLevelToForm}}: The minimum amount of sky light that icicles require to form.
; Thrown icicle damage {{code|thrownIcicleDamage}}: The amount of damage to apply to victims when they have an icicle thrown at them.
; Thrown icicle hurts extra damage {{code|thrownIcicleExtraDamage}}: The amount of damage to apply to entities belonging to the tag {{code|#minecraft:freeze_hurts_extra_types}}. Note: this is not additive with {{code|thrownIcicleDamage}}!
; Thrown icicle cooldown {{code|thrownIcicleCooldown}}: The cooldown in ticks between icicle throws.

=== Environment Config ===

This config contains all of the values associated with environmental temperature changes and effects.

; ''Max temperature for cold (in °C)'' {{code|maxTemperatureForColdC}}<ref name="env_temp_formula">
The final value of the environment temperature change is calculated using the formula below. You can find a graphical representation on [https://www.desmos.com/calculator/01nd0aidxh Desmos].<br/>
<math>
    B(T) = \frac{T - maxTemp - degreesPerTempDec}{degreesPerTempDec}
</math><br/><math>
    TemperatureChange(T) = \operatorname{max}(0, \operatorname{ceil}(multiplier * B(T))
</math>
</ref>: Cutoff temperature for freezing in Celsius. Biomes at or below this temperature will apply environment freezing to players. May not exceed 15°C.
; ''Degrees per temperature level decrease (in °C/°K)'' {{code|degreesCPerTemperatureDecrease}} <ref name="env_temp_formula"/>: Specifies the number of Celsius/Kelvin degrees the temperature must fall below the maximum cold threshold for each one-point decrease in player temperature per tick. Must be positive and non-zero.
; ''Environment temperature multiplier'' {{code|environmentTemperatureMultiplier}} <ref name="env_temp_formula"/>: Multiplies the final temperature point change of an environment temperature change.
; Apply Environment Frost Resistance penalty when wet {{code|applyEnvironmentPenaltyWhenWet}}: When true, entities will have their Environment Frost Resistance attribute set to 0 when wet.
; Rain wetness increase per tick {{code|rainWetnessIncrease}}: How many points to increase wetness by each tick when in the rain.
; Touching water wetness increase per tick {{code|touchingWaterWetnessIncrease}}: How many points to increase wetness by each tick when touching, but not submerged in, water.
; On fire dry rate {{code|onFireDryDate}}: How many points of wetness to remove each tick when on fire.
; On fire warm rate {{code|onFireWarmRate}}: The amount of temperature per tick that should be added from entities that are on fire.
; Powder snow freeze rate {{code|powderSnowFreezeRate}}: The per-tick temperature reduction of entities submerged in Powder Snow.
; Warmth per light level {{code|warmthPerLightLevel}}: How much temperature per tick is added to entities in an area per light level.
; Minimum block light level for warmth {{code|minLightForWarmth}}: The minimum light level needed to an area to be warm.
; Ultrawarm dimension warm rate {{code|ultrawarmWarmRate}}: The amount of warmth to apply in Ultrawarm dimensions like The Nether (does nothing if Scorchful is installed).
; Maximum snow accumulation ticks {{code|maxSnowAccumulationTicks}}: Controls how much many ticks of snow can be accumulated on entities that will melt off them when they go inside or enter a warm area. Set to 0 to disable this feature.

=== Removed Config Options ===
These reflect the removed config options from Frostiful, and their replacements (starting from Frostiful 2.2).

; Passive freezing wetness scale multiplier {{code|passiveFreezingWetnessScaleMultiplier}}: Increases passive freezing when wet
: Removed in 2.2
: Replaced with {{code|environmentConfig/environmentFreezingSoakedMultiplier}}

; Very protective Frost Resistance multiplier {{code|veryProtectiveFrostResistanceMultiplier}}: Multiplies the base frost resistance of very protective armour materials
: Removed in 2.2
: Replaced with the [./components.md#frost-resistance Frost Resistance Item Component]

; Protective Frost Resistance multiplier {{code|protectiveFrostResistanceMultiplier}}: Multiplies the base frost resistance of protective armour materials
: Removed in 2.2
: Replaced with the [./components.md#frost-resistance Frost Resistance Item Component]

; Do dry biome night freezing {{code|doDryBiomeNightFreezing}}: Whether dry biomes, like deserts, should be cold at night.
: Removed in 2.2
: Feature is now defined by [https://github.com/TheDeathlyCow/scorchful Scorchful]'s {{code|scorchful:set_humidity/arid_climate}} [https://thermoo.thedeathlycow.com/datapacks/environment_provider_definition/ environment provider]

; Cold biome base temperature change {{code|coldBiomeTemperatureChange}}: The base ambient temperature change per tick of snowy biomes that are not freezing. See Temperature System.
: Removed in 2.2
: Replaced by the {{code|frostiful:cold_climate}} [https://thermoo.thedeathlycow.com/datapacks/environment_definition/ environment]

; Freezing biome base temperature change {{code|freezingBiomeTemperatureChange}}: The base ambient temperature change per tick of freezing biomes. See Temperature System.
: Removed in 2.2
: Replaced by the {{code|frostiful:freezing_climate}} [https://thermoo.thedeathlycow.com/datapacks/environment_definition/ environment]

; Night time temperature shift {{code|nightTemperatureShift}}: Ambient temperature per tick shift in dark areas of cold or cool biomes. *This will also apply in dark places during the day.*
: Removed in 2.2
: Replaced by the {{code|frostiful:modifier/sun_light}} [https://thermoo.thedeathlycow.com/datapacks/environment_provider_definition/ environment provider]

; Dry rate {{code|dryRate}}: How many points of wetness to remove each tick when not touching water in any way.
: Removed in 2.2
: No replacement, hardcoded to be handled by Thermoo directly.

; Enable seasons integration {{code|enableSeasonsIntegration}}: Allows the passive temperature of biomes to change depending on the Season. Requires a Seasons mod like Fabric Seasons or Serene Seasons and [https://modrinth.com/mod/thermoo-patches Thermoo Patches] to have any effect. If disabled, then the Season will always be treated as being like Spring.
: Removed in 2.2
: Replaced by the {{code|thermoo:seasonal/temperate}} [https://thermoo.thedeathlycow.com/datapacks/environment_provider_definition/#temperate-seasonal environment provider types], and used in the {{code|frostiful:temperate_climate}}, {{code|frostiful:cool_climate}}, {{code|frostiful:cold_climate}}, and {{code|frostiful:freezing_climate}} [https://thermoo.thedeathlycow.com/datapacks/environment_definition/ environments]


=== Notes ===
<references />

[[Category:Frostiful|Developer Docs]]