Scorchful:Config File (Old): Difference between revisions

(3 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 149:

; 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 149: / Line 149: @@
 ; 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]]