Scorchful:Config File (Old): Difference between revisions

(5 intermediate revisions by the same user not shown)

Line 1:

The [[Mod:Scorchful|Scorchful]] '''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.1. Items documented here may not necessarily reflect what appears in an older version of ~~Scorchful. Starting from Scorchful 0.15~~, removed options ~~will be~~ documented in [[#Removed Config Options]].}}

{{Message box|text='''As of Scorchful 0.16, this page is no longer updated.''' This page reflects the state of the Scorchful config for mod versions 0.15.x (corresponding to most Minecraft 1.21.x versions). From Scorchful 0.16 onwards, a more robust config system with comments and descriptions has been implemented which should provide a much more accurate description of the config file for each version. Items documented here may not also necessarily reflect what appears in an older version of Minecraft, however some removed options are documented in [[#Removed Config Options]]. This page is kept up to be able to provide a resource for those still using older Scorchful versions.}}

=== Update Config ===

Line 62:

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/42rvcpnxwx Desmos].<br/>

<math>

B(T) = (T - minTemp + degreesPerTempInc~~) /~~ degreesPerTempInc

B(T) = \frac{T - minTemp + degreesPerTempInc}{degreesPerTempInc}

</math><br/><math>

TemperatureChange(T) = \operatorname{max}(0, \operatorname{floor}(multiplier * B(T))

Line 93:

; Temperature from cooling food {{code|temperatureFromCoolingFood}}: Temperature change to apply to players after eating items with the [[Minecraft:Tags|tag]] {{code|#scorchful:is_cooling_food}}

=== Thirst Config ===

Server-side options for thirst and wetness.

; ''Temperature from Wetness {{code|temperatureFromWetness}}'': How much temperature to remove from wet entities, each tick

; Water from Refreshing food {{code|waterFromRefreshingFood}}: The amount of body water provided by consuming Refreshing food and drink

; Water from Sustaining food {{code|waterFromSustainingFood}}: The amount of body water provided by consuming Sustaining food and drink

; Water from Hydrating food {{code|waterFromHydratingFood}}: The amount of body water provided by consuming Hydrating food and drink

; Water from Parching food {{code|waterFromParchingFood}}: The amount of body water removed by consuming Parching food and drink

; Rehydration drink size {{code|rehydrationDrinkSize}}: The threshold for how much body water needs to be collected before Rehydration will automatically rehydrate the player

; Soaking from Splash Potions {{code|soakingFromSplashPotions}}: How much soaking is applied when an entity is hit with any Splash Potion

; Touching water or rain wetness increase per tick {{code|touchingWaterWetnessIncrease}}: How much to increase wetness by when touching water or rain each tick. Note that submerging yourself in water will fully soak you, regardless of what this is set to.

; On fire dry rate {{code|onFireDryDate}}: How many wetness points to remove each tick when on fire

; ''Humid biome sweating efficiency {{code|humidBiomeSweatEfficiency}}'': A multiplier for {{code|temperatureFromWetness}} when the humidity is in the range {{code|[65%, 80%)}}. This applies to rainy climates like Jungles, Swamps, etc.

; ''Extra Humid biome sweating efficiency {{code|extraHumidBiomeSweatEfficiency}}'': A multiplier for {{code|temperatureFromWetness}} when the humidity is at or above 80%. This applies to rainy climates like Jungles, Swamps during the Wet Season; to cave biomes; and to all non-arid biomes when it rains.

; ''Arid biome sweating efficiency {{code|aridBiomeSweatEfficiency}}'': A multiplier for {{code|temperatureFromWetness}} when the humidity is at or below 20%. This applies to arid climates like Deserts, Badlands, and Savannas, as well as The Nether.

; Maximum Rehydration Enchantment efficiency {{code|maxRehydrationEfficiency}}: Multiplier for {{code|rehydrationDrinkSize}} that controls the maximum amount of body water provided by a full suit of Rehydration armor

=== Combat Config ===

Server-side options for combat features in Scorchful.

; ''Fire Charge thrown type {{code|fireBallThrownType}}'': One of {{code|SMALL}}, {{code|LARGE}}, or {{code|DISABLED}}. Controls what type of fireball is creating when throwing a fire charge. Small is just like firing from a Dispener and creates a fire on impact. Large is more like a Ghast and creates an explosion, and disabled disables this feature.

; ''Enable Desert Visions {{code|enableDesertVisions}}'': Enable/disable [Heat Visions](./Heat-Visions)

; Fear detection range multiplier {{code|fearDetectionRangeMultiplier}}: How much to multiply an entity's (including players) hostile mob detection range by.

; Impaling damage per level {{code|impalingDamagePerLevel}}: How much damage the Impaling enchantment should do to wet entities, per level of Impaling

; Fire Protection heat resistance per level {{code|fireProtectionHeatResistancePerLevel}}: How much Heat Resistance the Fire Protection enchantment should give, per level of Fire Protection.

=== Weather Config ===

Server-side options for weather effects in Scorchful.

; ''Do Sand Pile accumulation {{code|doSandPileAccumulation}}'': Enable/disable sand piles accumulating on the ground during sandstorms

; Sand Pile accumulation height {{code|sandPileAccumulationHeight}}: Sets the maximum height of sand piles that can accumulate during sand storms. Maximum value is 8.

; Sandstorm Slowness amount (percent from -1 to +1) {{code|sandstormSlownessAmountPercent}}: How much to multiply the total speed of entities on the surface by during Sandstorms. Negative values provide slowness, positive values provide speed.

; Sandstorm Follow Range reduction amount (percent from -1 to +1) {{code|sandstormFollowRangeReductionPercent}}: How much to multiply the total follow range of entities on the surface by during Sandstorms. Negative values decrease follow range, positive values increase it.

=== Mod Integration Config ===

Options for mod integrations in Scorchful.

==== Dehydration Config ====

Options for integration with [https://modrinth.com/mod/dehydration Dehydration].

; ''Minimum water level required for sweating {{code|minWaterLevelForSweat}}'': The minimum number of water points needed to be able to sweat (similar to how much hunger you need to heal)

=== Removed Config Options ===

These reflect the removed config options from Scorchful, and their replacements (starting from Scorchful 0.15).

==== Combat Config ====

; Default armor piece heat resistance {{code|defaultArmorHeatResistance}}: The default Heat Resistance to apply to all armor pieces that are not explicitly overridden

: Removed in 0.15

: Replaced with the item component [[Scorchful:Data Component Types#scorchful:heat_resistance|scorchful:heat_resistance]]

; Very warm armor piece heat resistance {{code|veryHarmfulArmorHeatResistance}}: The amount of Heat Resistance to apply to very warm armor pieces (such as Fur Armor in Frostiful)

: Removed in 0.15

: Replaced with the item component [[Scorchful:Data Component Types#scorchful:heat_resistance|scorchful:heat_resistance]]

; Thermally protective armor piece heat resistance {{code|protectiveArmorHeatResistance}}: The amount of Heat Resistance to apply to protective armors, such as Netherite

: Removed in 0.15

: Replaced with the item component [[Scorchful:Data Component Types#scorchful:heat_resistance|scorchful:heat_resistance]]

; Very thermally protective armor piece heat resistance {{code|veryProtectiveArmorHeatResistance}}: The amount of Heat Resistance to apply to very protective armors, such as Turtle

: Removed in 0.15

: Replaced with the item component [[Scorchful:Data Component Types#scorchful:heat_resistance|scorchful:heat_resistance]]

==== Heating Config ====

; Minimum sky light level for heat {{code|minSkyLightLevelForHeat}}: The minimum ''sky light;; level that will start to apply environmental heating

: Removed in 0.15

: Replaced with the [https://thermoo.thedeathlycow.com/datapacks/environment_provider_definition/ environment provider] {{code|scorchful:modifier/apply_shade_for_time}}.

; Heat from the Sun {{code|heatFromSun}}: How much environmental heating to apply from the Sun every tick

: Removed in 0.15

: Replaced with the [https://thermoo.thedeathlycow.com/datapacks/environment_definition/ environments] {{code|scorchful:temperature/scorching_climate}}, {{code|scorchful:temperature/warm_climate}}, and {{code|scorchful:temperature/temperate_climate}}.

; Sun Hat shade temperature change `sunHatShadeTemperatureChange`: The temperature change to apply to players wearing a Sun Hat in Scorching Biomes each tick

: Removed in 0.15

: Replaced with an [https://thermoo.thedeathlycow.com/entity_attributes/ Environment Heat Resistance] attribute modifier.

; Light level per heat increase (in The Nether) {{code|lightLevelPerHeatInNether}}: How many light levels correspond to a +1 increase in passive temperature, in The Nether

: Removed in 0.15

: Replaced with the [https://thermoo.thedeathlycow.com/datapacks/environment_definition/ environment] {{code|scorchful:hell}}.

; Minimum light level for heat (in The Nether) {{code|minLightLevelForHeatInNether}}: The minimum light level to begin facing heat, in The Nether

: Removed in 0.15

: Replaced with the [https://thermoo.thedeathlycow.com/datapacks/environment_definition/ environment] {{code|scorchful:hell}}.

; Blocks above Lava Ocean per heat increase (in The Nether) {{code|blocksAboveLavaOceanPerHeatInNether}}: How many blocks above the lava ocean correspond to a +1 increase in passive temperature, in The Nether

: Removed in 0.15

: Replaced with the [https://thermoo.thedeathlycow.com/datapacks/environment_definition/ environment] {{code|scorchful:hell}}.

; Maximum heat from Lava Ocean (in The Nether) {{code|maxHeatFromLavaOceanInNether}}: The maximum passive heat that the Lava Ocean can create, in The Nether

: Removed in 0.15

: Replaced with the [https://thermoo.thedeathlycow.com/datapacks/environment_definition/ environment] {{code|scorchful:hell}}.

==== Thirst Config ====

; Dry rate {{code|dryRate}}: How many wetness points to remove each tick when not in contact with water

: No replacement, hardcoded to be handled by Thermoo directly.

==== Mod Integration Config ====

===== Seasons Config =====

; Enable seasons integration {{code|enableSeasonsIntegration}}: Toggles seasons integration. If set to false, Scorchful will treat all biomes as if it were Spring.

: Removed in 0.15

: Replaced with the {{code|thermoo:seasonal/temperate}} and {{code|thermoo:seasonal/tropical}} [https://thermoo.thedeathlycow.com/datapacks/environment_provider_definition/ environment provider].

; Wet Season humid biome sweat efficiency {{code|wetSeasonHumidBiomeSweatEfficiency}}: How efficient [[Scorchful:Temperature System#Sweating|sweating]] is during the Wet Season in humid tropical biomes. This feature is exclusive to Serene Seasons.

: Removed in 0.15

: Replaced with {{code|thirstConfig/extraHumidBiomeSweatEfficiency}}

; Dry Season humid biome sweat efficiency {{code|drySeasonHumidBiomeSweatEfficiency}}: How efficient [[Scorchful:Temperature System#Sweating|sweating]] is during the Dry Season in humid tropical biomes. This feature is exclusive to Serene Seasons.

: Removed in 0.15

: Replaced with `thirstConfig/aridBiomeSweatEfficiency`

=== Notes ===

[[Category:Scorchful|Developer Docs]]

@@ Line 1: / Line 1: @@
 The [[Mod:Scorchful|Scorchful]] '''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.1. Items documented here may not necessarily reflect what appears in an older version of Scorchful. Starting from Scorchful 0.15, removed options will be documented in [[#Removed Config Options]].}}
+{{Message box|text='''As of Scorchful 0.16, this page is no longer updated.''' This page reflects the state of the Scorchful config for mod versions 0.15.x (corresponding to most Minecraft 1.21.x versions). From Scorchful 0.16 onwards, a more robust config system with comments and descriptions has been implemented which should provide a much more accurate description of the config file for each version. Items documented here may not also necessarily reflect what appears in an older version of Minecraft, however some removed options are documented in [[#Removed Config Options]]. This page is kept up to be able to provide a resource for those still using older Scorchful versions.}}
 === Update Config ===
@@ Line 62: / Line 62: @@
 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/42rvcpnxwx Desmos].<br/>
 <math>
-         B(T) = (T - minTemp + degreesPerTempInc) / degreesPerTempInc
+         B(T) = \frac{T - minTemp + degreesPerTempInc}{degreesPerTempInc}
 </math><br/><math>
          TemperatureChange(T) = \operatorname{max}(0, \operatorname{floor}(multiplier * B(T))
@@ Line 93: / Line 93: @@
 ; Temperature from cooling food {{code|temperatureFromCoolingFood}}: Temperature change to apply to players after eating items with the [[Minecraft:Tags|tag]] {{code|#scorchful:is_cooling_food}}
+=== Thirst Config ===
+Server-side options for thirst and wetness.
+; ''Temperature from Wetness {{code|temperatureFromWetness}}'': How much temperature to remove from wet entities, each tick
+; Water from Refreshing food {{code|waterFromRefreshingFood}}: The amount of body water provided by consuming Refreshing food and drink
+; Water from Sustaining food {{code|waterFromSustainingFood}}: The amount of body water provided by consuming Sustaining food and drink
+; Water from Hydrating food {{code|waterFromHydratingFood}}: The amount of body water provided by consuming Hydrating food and drink
+; Water from Parching food {{code|waterFromParchingFood}}: The amount of body water removed by consuming Parching food and drink
+; Rehydration drink size {{code|rehydrationDrinkSize}}: The threshold for how much body water needs to be collected before Rehydration will automatically rehydrate the player
+; Soaking from Splash Potions {{code|soakingFromSplashPotions}}: How much soaking is applied when an entity is hit with any Splash Potion
+; Touching water or rain wetness increase per tick {{code|touchingWaterWetnessIncrease}}: How much to increase wetness by when touching water or rain each tick. Note that submerging yourself in water will fully soak you, regardless of what this is set to.
+; On fire dry rate {{code|onFireDryDate}}: How many wetness points to remove each tick when on fire
+; ''Humid biome sweating efficiency {{code|humidBiomeSweatEfficiency}}'': A multiplier for {{code|temperatureFromWetness}} when the humidity is in the range {{code|[65%, 80%)}}. This applies to rainy climates like Jungles, Swamps, etc.
+; ''Extra Humid biome sweating efficiency {{code|extraHumidBiomeSweatEfficiency}}'': A multiplier for {{code|temperatureFromWetness}} when the humidity is at or above 80%. This applies to rainy climates like Jungles, Swamps during the Wet Season; to cave biomes; and to all non-arid biomes when it rains.
+; ''Arid biome sweating efficiency {{code|aridBiomeSweatEfficiency}}'': A multiplier for {{code|temperatureFromWetness}} when the humidity is at or below 20%. This applies to arid climates like Deserts, Badlands, and Savannas, as well as The Nether.
+; Maximum Rehydration Enchantment efficiency {{code|maxRehydrationEfficiency}}: Multiplier for {{code|rehydrationDrinkSize}} that controls the maximum amount of body water provided by a full suit of Rehydration armor
+=== Combat Config ===
+Server-side options for combat features in Scorchful.
+; ''Fire Charge thrown type {{code|fireBallThrownType}}'': One of {{code|SMALL}}, {{code|LARGE}}, or {{code|DISABLED}}. Controls what type of fireball is creating when throwing a fire charge. Small is just like firing from a Dispener and creates a fire on impact. Large is more like a Ghast and creates an explosion, and disabled disables this feature.
+; ''Enable Desert Visions {{code|enableDesertVisions}}'': Enable/disable [Heat Visions](./Heat-Visions)
+; Fear detection range multiplier {{code|fearDetectionRangeMultiplier}}: How much to multiply an entity's (including players) hostile mob detection range by.
+; Impaling damage per level {{code|impalingDamagePerLevel}}: How much damage the Impaling enchantment should do to wet entities, per level of Impaling
+; Fire Protection heat resistance per level {{code|fireProtectionHeatResistancePerLevel}}: How much Heat Resistance the Fire Protection enchantment should give, per level of Fire Protection.
+=== Weather Config ===
+Server-side options for weather effects in Scorchful.
+; ''Do Sand Pile accumulation {{code|doSandPileAccumulation}}'': Enable/disable sand piles accumulating on the ground during sandstorms
+; Sand Pile accumulation height {{code|sandPileAccumulationHeight}}: Sets the maximum height of sand piles that can accumulate during sand storms. Maximum value is 8.
+; Sandstorm Slowness amount (percent from -1 to +1) {{code|sandstormSlownessAmountPercent}}: How much to multiply the total speed of entities on the surface by during Sandstorms. Negative values provide slowness, positive values provide speed.
+; Sandstorm Follow Range reduction amount (percent from -1 to +1) {{code|sandstormFollowRangeReductionPercent}}: How much to multiply the total follow range of entities on the surface by during Sandstorms. Negative values decrease follow range, positive values increase it.
+=== Mod Integration Config ===
+Options for mod integrations in Scorchful.
+==== Dehydration Config ====
+Options for integration with [https://modrinth.com/mod/dehydration Dehydration].
+; ''Minimum water level required for sweating {{code|minWaterLevelForSweat}}'': The minimum number of water points needed to be able to sweat (similar to how much hunger you need to heal)
+=== Removed Config Options ===
+These reflect the removed config options from Scorchful, and their replacements (starting from Scorchful 0.15).
+==== Combat Config ====
+; Default armor piece heat resistance {{code|defaultArmorHeatResistance}}: The default Heat Resistance to apply to all armor pieces that are not explicitly overridden
+: Removed in 0.15
+: Replaced with the item component [[Scorchful:Data Component Types#scorchful:heat_resistance|scorchful:heat_resistance]]
+; Very warm armor piece heat resistance {{code|veryHarmfulArmorHeatResistance}}: The amount of Heat Resistance to apply to very warm armor pieces (such as Fur Armor in Frostiful)
+: Removed in 0.15
+: Replaced with the item component [[Scorchful:Data Component Types#scorchful:heat_resistance|scorchful:heat_resistance]]
+; Thermally protective armor piece heat resistance {{code|protectiveArmorHeatResistance}}: The amount of Heat Resistance to apply to protective armors, such as Netherite
+: Removed in 0.15
+: Replaced with the item component [[Scorchful:Data Component Types#scorchful:heat_resistance|scorchful:heat_resistance]]
+; Very thermally protective armor piece heat resistance {{code|veryProtectiveArmorHeatResistance}}: The amount of Heat Resistance to apply to very protective armors, such as Turtle
+: Removed in 0.15
+: Replaced with the item component [[Scorchful:Data Component Types#scorchful:heat_resistance|scorchful:heat_resistance]]
+==== Heating Config ====
+; Minimum sky light level for heat {{code|minSkyLightLevelForHeat}}: The minimum ''sky light;; level that will start to apply environmental heating
+: Removed in 0.15
+: Replaced with the [https://thermoo.thedeathlycow.com/datapacks/environment_provider_definition/ environment provider] {{code|scorchful:modifier/apply_shade_for_time}}.
+; Heat from the Sun {{code|heatFromSun}}: How much environmental heating to apply from the Sun every tick
+: Removed in 0.15
+: Replaced with the [https://thermoo.thedeathlycow.com/datapacks/environment_definition/ environments] {{code|scorchful:temperature/scorching_climate}}, {{code|scorchful:temperature/warm_climate}}, and {{code|scorchful:temperature/temperate_climate}}.
+; Sun Hat shade temperature change `sunHatShadeTemperatureChange`: The temperature change to apply to players wearing a Sun Hat in Scorching Biomes each tick
+: Removed in 0.15
+: Replaced with an [https://thermoo.thedeathlycow.com/entity_attributes/ Environment Heat Resistance] attribute modifier.
+; Light level per heat increase (in The Nether) {{code|lightLevelPerHeatInNether}}: How many light levels correspond to a +1 increase in passive temperature, in The Nether
+: Removed in 0.15
+: Replaced with the [https://thermoo.thedeathlycow.com/datapacks/environment_definition/ environment] {{code|scorchful:hell}}.
+; Minimum light level for heat (in The Nether) {{code|minLightLevelForHeatInNether}}: The minimum light level to begin facing heat, in The Nether
+: Removed in 0.15
+: Replaced with the [https://thermoo.thedeathlycow.com/datapacks/environment_definition/ environment] {{code|scorchful:hell}}.
+; Blocks above Lava Ocean per heat increase (in The Nether) {{code|blocksAboveLavaOceanPerHeatInNether}}: How many blocks above the lava ocean correspond to a +1 increase in passive temperature, in The Nether
+: Removed in 0.15
+: Replaced with the [https://thermoo.thedeathlycow.com/datapacks/environment_definition/ environment] {{code|scorchful:hell}}.
+; Maximum heat from Lava Ocean (in The Nether) {{code|maxHeatFromLavaOceanInNether}}: The maximum passive heat that the Lava Ocean can create, in The Nether
+: Removed in 0.15
+: Replaced with the [https://thermoo.thedeathlycow.com/datapacks/environment_definition/ environment] {{code|scorchful:hell}}.
+==== Thirst Config ====
+; Dry rate {{code|dryRate}}: How many wetness points to remove each tick when not in contact with water
+: No replacement, hardcoded to be handled by Thermoo directly.
+==== Mod Integration Config ====
+===== Seasons Config =====
+; Enable seasons integration {{code|enableSeasonsIntegration}}: Toggles seasons integration. If set to false, Scorchful will treat all biomes as if it were Spring.
+: Removed in 0.15
+: Replaced with the {{code|thermoo:seasonal/temperate}} and {{code|thermoo:seasonal/tropical}} [https://thermoo.thedeathlycow.com/datapacks/environment_provider_definition/ environment provider].
+; Wet Season humid biome sweat efficiency {{code|wetSeasonHumidBiomeSweatEfficiency}}: How efficient [[Scorchful:Temperature System#Sweating|sweating]] is during the Wet Season in humid tropical biomes. This feature is exclusive to Serene Seasons.
+: Removed in 0.15
+: Replaced with {{code|thirstConfig/extraHumidBiomeSweatEfficiency}}
+; Dry Season humid biome sweat efficiency {{code|drySeasonHumidBiomeSweatEfficiency}}: How efficient [[Scorchful:Temperature System#Sweating|sweating]] is during the Dry Season in humid tropical biomes. This feature is exclusive to Serene Seasons.
+: Removed in 0.15
+: Replaced with `thirstConfig/aridBiomeSweatEfficiency`
 === Notes ===
 <references />
+[[Category:Scorchful|Developer Docs]]