Skip to content

Commit 495f725

Browse files
TheDeathlyCowTheDeathlyCow
authoredMar 13, 2025··
New MkDocs Config Wiki (#160)
* setup config wiki * config file * tags page * add removed config option section * components page * add publish workflow file * document new environment config options * document applyEnvironmentPenaltyWhenWet
·
2.2+1.21.32.2-beta.1
1 parent 1d42279 commit 495f725

File tree

11 files changed

+676
-0
lines changed

11 files changed

+676
-0
lines changed
 

‎.github/workflows/publish_docs.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Publish Docs
2+
on: [workflow_dispatch]
3+
4+
permissions:
5+
contents: write
6+
7+
jobs:
8+
deploy:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v4
12+
- name: Configure Git Credentials
13+
run: |
14+
git config user.name github-actions[bot]
15+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
16+
- uses: actions/setup-python@v5
17+
with:
18+
python-version: 3.x
19+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
20+
- uses: actions/cache@v4
21+
with:
22+
key: mkdocs-material-${{ env.cache_id }}
23+
path: .cache
24+
restore-keys: |
25+
mkdocs-material-
26+
- run: pip install mkdocs-material
27+
- run: mkdocs gh-deploy --force --config-file ./wiki/mkdocs.yml

‎wiki/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
site/

‎wiki/docs/CNAME

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
frostiful.thedeathlycow.com

‎wiki/docs/assets/favicon.svg

+206
Loading

‎wiki/docs/assets/logo.png

2.08 KB
Loading

‎wiki/docs/assets/styles.css

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
.md-header__button.md-logo img, .md-header__button.md-logo svg {
2+
width: auto;
3+
height: 2rem;
4+
}
5+
6+
.md-header__button.md-logo {
7+
padding: 0;
8+
}
9+
10+
:root {
11+
--md-primary-fg-color: #967bb6;
12+
--md-primary-fg-color--light: #967bb6;
13+
--md-primary-fg-color--dark: #967bb6;
14+
}
15+
16+
.md-header {
17+
color: rgba(0,0,0,1);
18+
}

‎wiki/docs/components.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: 📦 Component Types
3+
---
4+
5+
# Component Types
6+
7+
This page documents the various component types added by Frostiful.
8+
9+
## Item Components
10+
11+
This is a new component type added for items. For the full format in Vanilla,
12+
see: [https://minecraft.wiki/w/Data_component_format](https://minecraft.wiki/w/Data_component_format)
13+
14+
### Frost Resistance
15+
16+
This component adds Frost Resistance and Environment Frost Resistance attribute modifiers to items. This does not modify
17+
the underlying `minecraft:attribute_modifiers` component, it only applies modifiers when the item is equipped or
18+
displayed in a tooltip.
19+
20+
The attributes are documented on the [Thermoo Wiki](https://thermoo.thedeathlycow.com/entity_attributes/).
21+
22+
- `{}` **components**: Parent tag.
23+
- `{}` **frostiful:frost_resistance**: A compound component.
24+
- `D` **frost_resistance_multiplier**: Multiplies the base frost resistance of the armor type to get the final
25+
modifier value.
26+
- `D` **environment_frost_resistance_multiplier**: Multiplies the base environment frost resistance of the armor
27+
type to get the final modifier value.
28+
29+
The final attribute modifiers are applied as an `add_value` modifier for the `thermoo:generic.frost_resistance`
30+
and `thermoo:generic.environment_frost_resistance` attributes with modifier IDs
31+
of `frostiful:base_frost_resistance/${slot_id}` and `frostiful:base_environment_frost_resistance/${slot_id}`,
32+
respectively.
33+
34+
The base values for the different armor types are as follows:
35+
36+
| Armor Type | Base Frost Resistance | Base Environment Frost Resistance |
37+
|------------|-----------------------|-----------------------------------|
38+
| Helmet | 1.5 | 0.25 |
39+
| Chestplate | 2.0 | 0.5 |
40+
| Leggings | 1.0 | 0.125 |
41+
| Boots | 0.5 | 0.125 |
42+
| Body | 4.0 | 1.0 |
43+
44+
!!! tip
45+
These base values are not currently configurable. If you wish to have more fine-grained control over the item attribute modifier values, you will need to use another mod like [Default Components](https://modrinth.com/mod/default-components) to set the default multiplier value to `0` in this component, and then add a regular attribute modifier to the underlying `minecraft:attribute_modifiers` component using a mod like [CIA](https://modrinth.com/mod/cia) or Default Components.

‎wiki/docs/config.md

+136
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
---
2+
title: ⚙️ Config File
3+
---
4+
# Config File
5+
Frostiful is highly configurable. However, not all of the values in the config are properly bounded and so adjusting them to weird values may result in undefined behaviour. Adjust the config at your own risk!
6+
7+
!!! tip
8+
Items that are most relevant to mod pack authors have been marked with :star:
9+
10+
!!! warning
11+
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 Frostiful. Starting from Frostiful 2.2, removed options will be documented in [Removed Config Options](#removed-config-options).
12+
13+
This documents the various global config options found in `[minecraft]/config/frostiful.json`.
14+
15+
## [IMPORTANT] Update Config
16+
17+
The update config controls the automatic updating of config values.
18+
19+
* :star: Enable config auto updates `enableConfigUpdates` Enables/disables automatic config updates. **If you are tinkering with the config, this should probably be turned off**.
20+
* `currentConfigVersion`: The current config version. Does not show in the GUI and should be left alone.
21+
22+
## Client Config
23+
24+
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.
25+
26+
* Frost overlay start percent (0-1) `frostOverlayStart`: Double between 0 and 1 that determines at what negative temperature scale the vanilla powder snow border overlay should start rendering at
27+
* Do cold heart overlay `doColdHeartOverlay`: Whether to render the cold heart overlay or not
28+
* Render water drip particles when wet `renderDripParticles`: Whether to render water dripping particles on wet players (does nothing if Scorchful is installed)
29+
* Disable frost overlay when wearing Cloak of Frostology `disableFrostOverlayWhenWearingFrostologyCloak`: Whether to disable the frost overlay (powder snow border) from showing when wearing the Cloak of Frostology
30+
* :star: Shake hand when shivering `shakeHandWhenShivering`: Whether to shake the player's hand in first person when [shivering](./Temperature-System).
31+
* Hand shake intensity `handShakeIntensity`: How intense the hand shaking should be when shivering.
32+
33+
## Combat config
34+
35+
This config contains anything related to combat.
36+
37+
* :star: Do chillager patrols `doChillagerPatrols`: Whether Chillagers should replace Pillagers in patrols in snowy biomes
38+
* Strays carry frost arrows `straysCarryFrostArrows`: Whether Strays will carry Glacial Arrows.
39+
* Max frost spell distance `maxFrostSpellDistance`: The maximum distance the spell cast by the [Frost Wand](./Frost-Wand) should be able to go before exploding.
40+
* Frost Wand cool down (ticks) `frostWandCooldown`: The cooldown time (in ticks) of the Frost Wand after casting a spell.
41+
* Frost Wand root time (ticks) `frostWandRootTime`: The time (in ticks) that the Frozen Rooted effect of the Frost Wand should last.
42+
* Frostologer heat drain per tick `frostologerHeatDrainPerTick`: How much heat the [Frostologer](./Frostologer) should drain from nearby targets per tick when using its freezing attack.
43+
* Packed snowball freeze amount `packedSnowballFreezeAmount`: The amount of temperature that the [Packed Snowball](./Packed-Snow) should remove when thrown at an entity.
44+
* Packed snowball damage `packedSnowballDamage`: The amount of Damage that the [Packed Snowball](./Packed-Snow) should apply when thrown at an entity.
45+
* Packed snowball vulnerable types damage `packedSnowballVulnerableTypesDamage`: The amount of Damage that the [Packed Snowball](./Packed-Snow) should apply when thrown at an entity that belongs to the tag `#minecraft:freeze_hurts_entity_types`.
46+
* Max Frost Bite Max Amplifier (inclusive) `biterFrostBiteMaxAmplifier`: The maximum level of Frost Bite to apply to players frozen by the Frost Wand when attacked by a Biter (inclusive)
47+
* Chillager fire damage multiplier `chillagerFireDamageMultiplier`: Increases damage Chillagers take from fire
48+
* Frostologer fire damage multiplier `frostologerFireDamageMultiplier`: Increases damage Frostologers take from fire
49+
* Ice Skate upgrade generate chance in Igloos (0-1) `skateUpgradeTemplateIglooGenerateChance`: Chance of an Ice Skate upgrade template appearing in an Igloo chest
50+
51+
## Freezing Config
52+
53+
This config contains all of the values associated with freezing.
54+
55+
* :star: Do passive freezing `doPassiveFreezing`: Global toggle on whether passive freezing should be enabled. Both this config option and the gamerule `frostiful.doPassiveFreezing` must be true for passive freezing to take effect!
56+
* :star: Do wind spawning `doWindSpawning`: Whether [Freezing Wind](./Weather) should spawn
57+
* :star: Wind spawn strategy `windSpawnStrategy`: The strategy to be used when spawning freezing wind. One of `NONE`, `POINT`, or `ENTITY`. Defaults to `ENTITY`. See the [alternate strategies](./Weather) page on the Weather page for more information.
58+
* Do wind spawning in air `spawnWindInAir`: Whether [Freezing Wind](./Weather) should spawn in the air
59+
* :star: Wind destroys torches `windDestroysTorches`: Whether [Freezing Wind](./Weather) can destroy open flames.
60+
* Do snow packing from heavy entities `doSnowPacking`: Whether heavy entities should turn snow layers they step on into packed snow.
61+
* :star: Passive freezing tick interval `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.
62+
* Wind spawn cap per second `windSpawnCapPerSecond`: The maximum number of Freezing Wind events allowed to spawn per second
63+
* Wind spawn rarity `windSpawnRarity`: Controls the chance of wind spawning when snowing. Higher values mean less wind.
64+
* Wind spawn rarity `windSpawnRarityThunder`: Controls the chance of wind spawning in a thunder storm. Higher values mean less wind.
65+
* :star: Max passive freezing percent (0-1) `maxPassiveFreezingPercent`: The minimum temperature scale at which passive freezing should apply (higher values = you can freeze more)
66+
* Soak percent from splash water bottle (0-1) `soakPercentFromWaterPotion`: A 0-1 percentage of how wet splash water bottles should make a player.
67+
* Sun Lichen heat per level `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).
68+
* Sun Lichen burn time `sunLichenBurnTime`: How long Sun Lichen should set entities on fire when overheating, in ticks.
69+
* Campfire warmth search size `campfireWarmthSearchRadius`: How far away Campfires can warm players when a log is added.
70+
* Campfire warmth time `campfireWarmthTime`: The amount of time in ticks that Warmth granted by campfires should last
71+
* Freezing wind frost (per 5 ticks) `freezingWindFrost`: The amount of temperature to remove from players when colliding with wind
72+
* Conduit Power warmth per tick `conduitPowerWarmthPerTick`: The amount of temperature gained from having the Conduit Power status effect whilst submerged in water.
73+
* Heat from hot floor (magma block, campfire) `heatFromHotFloor`: How much heat to apply per tick to entites standing on hot floor blocks, such as magma blocks
74+
* Start shivering when below temp `shiverBelow`: The temperature scale below which to have entities start shivering. Scale from -1 to +1.
75+
* :star: Shivering warmth per tick `shiverWarmth`: How much warmth shivering should apply per tick.
76+
* Stop shivering warmth below food level `stopShiverWarmingBelowFoodLevel`: The food level below which shivering should not apply heat.
77+
* Warming food and drink Warmth duration (ticks) `warmFoodWarmthTime`: How many ticks Warmth should be applied for when consuming Warming foods. That is, food with the item tag `#frostiful:warm_foods`. This tag is mainly used for integration with warming food and drinks from mods like Farmer's Delight.
78+
79+
## Icicle Config
80+
81+
This config contains values associated with [icicles](./Icicle).
82+
83+
* :star: Icicles form in weather `iciclesFormInWeather`: Whether Icicles should form during weather events.
84+
* Become unstable chance `becomeUnstableChance`: The chance of an icicle block attempting to become unstable on random tick.
85+
* Grow chance `growChance`: The chance of an icicle block attempting to grow on random tick.
86+
* Grow chance during rain `growChanceDuringRain`: The chance of an icicle block attempting to grow on random tick when its raining.
87+
* Grow chance during thunder `growChanceDuringThunder`: The chance of an icicle block attempting to grow on random tick when its thundering.
88+
* Frost arrow freeze amount `frostArrowFreezeAmount`: The amount of temperature to remove from victims of a [Glacial Arrow](https://github.com/TheDeathlyCow/frostiful/wiki/Glacial-Arrow).
89+
* Thrown icicle freeze amount `thrownIcicleFreezeAmount`: The amount of temperature to remove to from entities when they have an icicle thrown at them.
90+
* Icicle collision freeze amount `icicleCollisionFreezeAmount`: The amount of temperature to remove from entities that hurt themselves on an icicle.
91+
* Maximum light level to form (exclusive) `maxLightLevelToForm`: The maximum (block) light level that icicles are allowed to form at, exclusive upper bound.
92+
* Minimum sky light level to form (inclusive) `minSkylightLevelToForm`: The minimum amount of sky light that icicles require to form.
93+
* Thrown icicle damage `thrownIcicleDamage`: The amount of damage to apply to victims when they have an icicle thrown at them.
94+
* Thrown icicle hurts extra damage `thrownIcicleExtraDamage`: The amount of damage to apply to entities belonging to the tag `#minecraft:freeze_hurts_extra_types`. Note: this is not additive with `thrownIcicleDamage`!
95+
* Thrown icicle cooldown `thrownIcicleCooldown`: The cooldown in ticks between icicle throws.
96+
97+
98+
## Environment Config
99+
100+
This config contains all of the values associated with environmental temperature changes and effects.
101+
102+
* Max temperature for cold (in °C) `maxTemperatureForColdC`: Cutoff temperature for freezing in Celsius. Biomes at or below this temperature will apply environment freezing to players. May not exceed 15°C.
103+
* Degrees per temperature level decrease (in °C/°K) `degreesCPerTemperatureDecrease`: 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.
104+
* Apply Environment Frost Resistance penalty when wet `applyEnvironmentPenaltyWhenWet`: When true, entities will have their Environment Frost Resistance attribute set to 0 when wet.
105+
* Rain wetness increase per tick `rainWetnessIncrease`: How many points to increase wetness by each tick when in the rain.
106+
* Touching water wetness increase per tick `touchingWaterWetnessIncrease`: How many points to increase wetness by each tick when touching, but not submerged in, water.
107+
* On fire dry rate `onFireDryDate`: How many points of wetness to remove each tick when on fire.
108+
* On fire warm rate `onFireWarmRate`: The amount of temperature per tick that should be added from entities that are on fire.
109+
* Powder snow freeze rate `powderSnowFreezeRate`: The per-tick temperature reduction of entities submerged in Powder Snow.
110+
* Warmth per light level `warmthPerLightLevel`: How much temperature per tick is added to entities in an area per light level.
111+
* Minimum block light level for warmth `minLightForWarmth`: The minimum light level needed to an area to be warm.
112+
* Ultrawarm dimension warm rate `ultrawarmWarmRate`: The amount of warmth to apply in Ultrawarm dimensions like The Nether (does nothing if Scorchful is installed).
113+
* Maximum snow accumulation ticks `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.
114+
115+
## Removed Config Options
116+
117+
These reflect the removed config options from Frostiful, and their replacements (starting from Frostiful 2.2).
118+
119+
* Passive freezing wetness scale multiplier `passiveFreezingWetnessScaleMultiplier`: Increases passive freezing when wet
120+
- Replaced with `environmentConfig/environmentFreezingSoakedMultiplier`
121+
* Very protective Frost Resistance multiplier `veryProtectiveFrostResistanceMultiplier`: Multiplies the base frost resistance of very protective armour materials
122+
- Replaced with the [Frost Resistance Item Component](./components.md#frost-resistance)
123+
* Protective Frost Resistance multiplier `protectiveFrostResistanceMultiplier`: Multiplies the base frost resistance of protective armour materials
124+
- Replaced with the [Frost Resistance Item Component](./components.md#frost-resistance)
125+
* Do dry biome night freezing `doDryBiomeNightFreezing`: Whether dry biomes, like deserts, should be cold at night.
126+
- Feature is now defined by [Scorchful](https://github.com/TheDeathlyCow/scorchful)'s `scorchful:set_humidity/arid_climate` [environment provider](https://thermoo.thedeathlycow.com/datapacks/environment_provider_definition/)
127+
* Cold biome base temperature change `coldBiomeTemperatureChange`: The base ambient temperature change per tick of snowy biomes that are not freezing. See [Temperature System](https://github.com/TheDeathlyCow/frostiful/wiki/Temperature-System).
128+
- Replaced by the `frostiful:cold_climate` [environment](https://thermoo.thedeathlycow.com/datapacks/environment_definition/).
129+
* Freezing biome base temperature change `freezingBiomeTemperatureChange`: The base ambient temperature change per tick of freezing biomes. See [Temperature System](https://github.com/TheDeathlyCow/frostiful/wiki/Temperature-System).
130+
- Replaced by the `frostiful:freezing_climate` [environment](https://thermoo.thedeathlycow.com/datapacks/environment_definition/).
131+
* Night time temperature shift `nightTemperatureShift`: Ambient temperature per tick shift in dark areas of cold or cool biomes. *This will also apply in dark places during the day.*
132+
- Replaced by the `frostiful:modifier/sun_light` [environment provider](https://thermoo.thedeathlycow.com/datapacks/environment_provider_definition/).
133+
* Dry rate `dryRate`: How many points of wetness to remove each tick when not touching water in any way.
134+
- No replacement, hardcoded to be handled by Thermoo directly.
135+
* Enable seasons integration `enableSeasonsIntegration`: Allows the passive temperature of biomes to change depending on the Season. Requires a Seasons mod like Fabric Seasons or Serene Seasons and [Thermoo Patches](https://modrinth.com/mod/thermoo-patches) to have any effect. If disabled, then the Season will always be treated as being like Spring.
136+
- Replaced by the `thermoo:seasonal/temperate` [environment provider types](https://thermoo.thedeathlycow.com/datapacks/environment_provider_definition/#temperate-seasonal), and used in the `frostiful:temperate_climate`, `frostiful:cool_climate`, `frostiful:cold_climate`, and `frostiful:freezing_climate` [environments](https://thermoo.thedeathlycow.com/datapacks/environment_definition/).

‎wiki/docs/index.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: 🏠 Homepage
3+
---
4+
# Frostiful Config Wiki
5+
6+
Welcome to the Frostiful Config Wiki! This is a technical wiki specifically meant for addon and modpack developers who wish to configure Frostiful. For information about the content of Frostiful (blocks, items, mobs, etc) see: [https://github.com/TheDeathlyCow/frostiful/wiki](https://github.com/TheDeathlyCow/frostiful/wiki).
7+
8+
!!! warning
9+
Some links to content within Frostiful on this wiki are currently broken. These links will be fixed when Frostiful gets a new content wiki in the near future.
10+
11+
## 🌡️🐮 Thermoo Documentation
12+
13+
Frostiful uses [Thermoo](https://github.com/TheDeathlyCow/thermoo) for its internal temperature and environment system. Mod pack authors may find its documentation useful. You can find the Thermoo Developer Wiki here: [https://thermoo.thedeathlycow.com/](https://thermoo.thedeathlycow.com/). This wiki is written with the assumption of general understanding of Thermoo.
14+
15+
## 🧭 Navigation
16+
17+
- [Config File](./config.md)
18+
- [Datapack Tags](./tags.md)
19+
- [Component Types](./components.md)
20+
21+
## 🖥️ Mod Integrations
22+
23+
* [Tips](https://modrinth.com/mod/tips): Added some Frostiful-specific tips
24+
* [Enchantment Descriptions](https://modrinth.com/mod/enchantment-descriptions): Descriptions are provided for Frostiful's enchantments
25+
* [Trinkets](https://modrinth.com/mod/trinkets): The Cloak of Frostology can be equipped in the Cape slot
26+
27+
Some modded warm foods will provide [Warmth](./Status-Effects). This can be configured with the [item tag](./Tags#items) `#frostiful:warm_foods`.
28+
29+
* [Farmer's Delight](https://modrinth.com/mod/farmers-delight-fabric): Hot Cocoa provides the Warmth effect
30+
* [Farmer's Respite](https://www.curseforge.com/minecraft/mc-mods/farmers-respite): Teas and warm foods provide the Warmth effect
31+
* [Festive Delight](https://www.curseforge.com/minecraft/mc-mods/festive-delight): Christmas Tea provides the Warmth effect
32+
* [Frozen Up](https://www.curseforge.com/minecraft/mc-mods/frozen-up): Truffle Hot Chocolate provides the Warmth effect
33+
* [Spectrum](https://modrinth.com/mod/spectrum): Hot Chocolate, Demon Tea, Restoration Tea, and Glistering Jelly Tea provide the Warmth effect
34+
35+
# Compatibility
36+
37+
While this mod is designed to be as compatible as possible with other mods, it is inevitable that issues will arise. Specific incompatibilities will be documented here as they become known.
38+
39+
* [Hephaestus / Tinker's Construct](https://github.com/Alpha-s-Stuff/TinkersConstruct): Temperature bar not showing up. **FIX:** set `extraHeartRenderer` to `false` in the `mantle-client.toml` config.
40+
* [Iris Shaders](https://github.com/IrisShaders/Iris): Frostiful Armor Trim Patterns not showing up consistently. Currently no fix. **HELP WANTED**
41+
42+
## Other Temperature Mods
43+
44+
Most other temperature mods do not work with Frostiful's temperature system and likely never will. Running Frostiful with these mods is redundant as they also add their own temperature system in addition to Frostiful. These mods may technically run together, however if you want to have a warm temperature system with Frostiful I would recommend using [Scorchful](https://modrinth.com/mod/scorchful) instead, as it was made to work together with Frostiful.
45+
46+
All of the following temperature mods should not be used with Frostiful (note that this list is not exhaustive, these are just the ones I've heard of):
47+
* PyroFrost
48+
* EnvironmentZ
49+
* Thermite
50+
* Tough as Nails
51+
* Cold Sweat
52+
* Homeostatic
53+
* Metabolism
54+
55+
For the mods that add thirst - [Dehydration](https://modrinth.com/mod/dehydration) works with Frostiful and does not add a temperature system.

‎wiki/docs/tags.md

+137
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
---
2+
title: 📋 Datapack Tags
3+
---
4+
5+
# Datapack Tags
6+
7+
This page describes the various datapack tags used by Frostiful. It includes both new tags added by Frostiful, and tags
8+
from Thermoo that Frostiful appends to.
9+
10+
!!! tip
11+
Items that are most relevant to mod pack authors have been marked with :star:
12+
13+
!!! warning
14+
This page reflects the latest set of tags available for Minecraft 1.21.1. 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 Tags](#removed-tags).
15+
16+
## Armor Materials (deprecated)
17+
18+
Location: `data/frostiful/tags/armor_material`.
19+
20+
| Tag ID | Description | Default values (summarized) |
21+
|-----------------------------------|------------------------------------------------------|------------------------------|
22+
| `#thermoo:resistant_to_cold` | Armour materials that are somewhat resistant to cold | Netherite |
23+
| `#thermoo:very_resistant_to_cold` | Armour materials that are very resistant to cold | Fur and Fur Padded Chainmail |
24+
25+
These tags are defined in Thermoo, which you may want to read more
26+
about [here](https://thermoo.thedeathlycow.com/mods/armor_materials/).
27+
28+
These tags will apply a [`frostiful:frost_resistance`](./components.md#frost-resistance) component to any new stacks created with these tags that does not already have this component. Editing these tags and reloading will not update existing stacks.
29+
30+
!!! warning
31+
These tags are deprecated, it is preferred that you use a the [`frostiful:frost_resistance`](./components.md#frost-resistance) component to modify attributes of custom armours instead.
32+
33+
## Banner Patterns
34+
35+
Location: `data/frostiful/tags/banner_pattern`.
36+
37+
| Tag ID | Description | Default values (summarized) |
38+
|--------------------------------------|--------------------------------------------------------------|-----------------------------|
39+
| `#frostiful:pattern_item/icicle` | Can be chosen in the loom with the icicle banner pattern | Icicle |
40+
| `#frostiful:pattern_item/snowflake` | Can be chosen in the loom with the snowflake banner pattern | Snowflake |
41+
| `#frostiful:pattern_item/frostology` | Can be chosen in the loom with the frostology banner pattern | Frostology |
42+
43+
## Blocks
44+
45+
Location: `data/frostiful/tags/block`.
46+
47+
| Tag ID | Description | Default values (summarized) |
48+
|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------|
49+
| `#frostiful:icicle_growable` | The root of an icicle will not fall from these blocks once placed, allowing for infinite growth | Ice |
50+
| `#frostiful:icicle_replaceable_blocks` | Blocks that an icicle can replace when growing | Ice |
51+
| `#frostiful:is_open_flame` | Fire blocks that will be replaced with air when blown out by [Freezing Wind](./Weather) | Fire, Soul Fire |
52+
| `#frostiful:has_open_flame` | Light blocks with a boolean `lit` property that will be set to false when blown out by [Freezing Wind](./Weather) | Campfires, Candles, Candle Cakes |
53+
| `#frostiful:frostologer_cannot_freeze` | Blocks that the Frostologer cannot freeze with their destroy heat sources spell | Portals, Beacons, Vaults, Spawners |
54+
| `#frostiful:hot_floor` | Provide heat when stood on | Magma blocks |
55+
| `#frostiful:frozen_torches` | The frozen torch blocks. Exists for purely technical reasons | Frozen Torch and Frozen Wall Torch |
56+
| `#frostiful:covered_rocks_cannot_replace` | Blocks that covered rocks cant replace with cobble stone during generation | Logs, leaves, and other blocks features cannot replace |
57+
| `#frostiful:covered_rock_covering_replaceable` | Blocks that the sun lichen generated on covered rocks can replace | Sun lichen, glow lichen, snow |
58+
59+
## Biomes
60+
61+
Location: `data/frostiful/tags/worldgen/biome`.
62+
63+
| Tag ID | Description | Default values (summarized) |
64+
|--------------------------------------------------|-------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
65+
| `#frostiful:has_feature/sun_lichen_covered_rock` | Biomes that sun lichen covered rocks generate in | Snowy, icy, and taiga biomes |
66+
| `#frostiful:has_feature/icicle_cluster` | Biomes that icicle clusters generate in | Snowy and icy biomes |
67+
| `#frostiful:has_feature/brittle_ice` | Biomes that brittle ice sheets generate in | Frozen ocean |
68+
| `#frostiful:has_structure/chillager_outpost` | Biomes that the [Chillager Outpost](./chillager-outpost) generates in | Snowy plains, ice spikes |
69+
| `#frostiful:has_structure/frostologer_castle` | Biomes that the [Frostologer Castle](./frostologer-castle) generates in | Snowy plains, ice spikes |
70+
| `#frostiful:dry_biomes` | Biomes that are cold at night | Desert, savanna, badlands |
71+
| :star: `#frostiful:freezing_blacklist_biomes` | Biomes that can never be cold | Nether and End biomes |
72+
| `#frostiful:freezing_wind_always_spawns` | Biomes where freezing wind will always appear on the ground | Mountains and windswept biomes |
73+
| `#frostiful:freezing_wind_spawns_in_storms` | Biomes where freezing wind will appear on the ground in storms | Snowy and hilly biomes |
74+
| `#frostiful:freezing_wind_never_spawns` | Biomes that freezing wind will never spawn in | Nether and End biomes |
75+
| Seasonal temperature tags | Categorizes biome temperature based on season | See the [Temperature System page](https://github.com/TheDeathlyCow/frostiful/wiki/Temperature-System#seasonal-temperature-tags) |
76+
77+
## Damage Types
78+
79+
Location: `data/frostiful/tags/worldgen/damage_type`.
80+
81+
| Tag ID | Description | Default values (summarized) |
82+
|----------------------------------|-----------------------------------------------------------------------|-----------------------------|
83+
| `#frostiful:does_not_break_root` | Damage types that do not breaking the freezing root of the Frost Wand | Freezing damage, broken ice |
84+
| `#frostiful:is_icicle` | Damage types from being impaled by/falling on an icicle | Icicle, falling icicle |
85+
86+
## Enchantments
87+
88+
Location: `data/frostiful/tags/enchantment`.
89+
90+
| Tag ID | Description | Default values (summarized) |
91+
|---------------------------------------|------------------------------------------------------------------------------------------------------|-----------------------------------|
92+
| `#frostiful:exclusive_set/heat_drain` | Heat-drain like enchantments that can't both be put on the same item at the same time. | Enervation, Curse of Frozen Touch |
93+
| `#frostiful:is_frosty` | If the player's boots are enchanted with this enchantment, then they gain no heat from magma blocks. | Frost Walker |
94+
95+
## Entity Types
96+
97+
Location: `data/frostiful/tags/entity_type`.
98+
99+
| Tag ID | Description | Default values (summarized) |
100+
|--------------------------------------------|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
101+
| `#frostiful:benefits_from_cold` | Mobs that benefit from freezing, like the Frostologer. | Frostologer, Snow Golem |
102+
| `#frostiful:heavy_entity_types` | Mobs that pack snow when walking on it. | Iron Golem, Ravager, Warden |
103+
| `#frostiful:root_immune` | Mobs that are immune to the freezing root effect of the [Frost Wand](./Frost-Wand). | Cold Immune, Frostologer |
104+
| `#frostiful:is_brushable` | Animals that can be brushed for [fur tufts](./Fur-Tufts) | All entities in the brushing tags below |
105+
| `#frostiful:advancement/creepers` | Which mobs count for the [Stop Right There advancement](./Advancements) | Creepers + Conventional creepers |
106+
| `#frostiful:brushing/drops_ocelot_fur` | Which animals drop Ocelot Fur Tufts when brushed | Ocelot + Conventional ocelots |
107+
| `#frostiful:brushing/drops_wolf_fur` | Which animals drop Wolf Fur Tufts when brushed | Wolf + Conventional wolves |
108+
| `#frostiful:brushing/drops_polar_bear_fur` | Which animals drop Polar Bear Fur Tufts when brushed | Polar Bear + Conventional polar bears |
109+
| `#thermoo:benefits_from_cold` | Mobs that benefit from freezing, like the Frostologer. | Entities in the benefits from cold tag above |
110+
| :star: `#thermoo:cold_immune` | Entites that are immune to freezing in all forms | Bosses, vanilla freeze immune entities, [Biters](./Biter), and [Chillagers](./Chillager) |
111+
112+
## Items
113+
114+
Location: `data/frostiful/tags/entity_type`.
115+
116+
| Tag ID | Description | Default values (summarized) |
117+
|-------------------------------------|--------------------------------------------------------------------------------------------|-------------------------------------------------------------------|
118+
| `#frostiful:frostology_cloaks` | Items that make the [Frostology Cloak](./frostology-cloak) appear when worn | Cloak of Frostology, Inert Cloak of Frostology |
119+
| `#frostiful:fur_armor` | Items that trigger the craft fur armor [advancement](./advancement) | All fur armour items |
120+
| `#frostiful:fur_boots` | Items that are [fur boots](./fur-armor) | Fur boots items |
121+
| `#frostiful:ice_skates` | Items that allow you to skate on ice | Ice Skates, Armored Ice Skates |
122+
| `#frostiful:icicles` | Items that are [Icicles](./icicle) for crafting purposes | Icicles and Icicles from Immersive Weathering |
123+
| `#frostiful:powder_snow_walkable` | Items that will let you walk on powder snow when worn in the feet or body slot | Leather, fur, fur padded chainmail boots and leather horse armour |
124+
| `#frostiful:sun_lichens` | The [sun lichen](./sun-lichen) block items | All variants of sun lichen |
125+
| `#frostiful:supports_heat_drain` | Items that support the [Enervation and Curse of Frozen Touch](./Enchantments) enchantments | Swords, axes, spears, and the Frost Wand |
126+
| :star: `#frostiful:warming_foods` | Items that provide the Warmth status effect when consumed | Various modded drinks, like teas, coffees, and hot chocolate |
127+
| `#frostiful:enchantable/frost_wand` | Items that can receive the Frost Wand's enchantments in the Enchanting Table | Frost Wand |
128+
129+
## Trim Patterns
130+
131+
Location: `data/frostiful/tags/trim_pattern`.
132+
133+
| Tag ID | Description | Default values (summarized) |
134+
|------------------------------|------------------------------------------------------|-----------------------------|
135+
| `#frostiful:custom_patterns` | The custom patterns of Frostiful, used for rendering | Glacial, snow man, frosty |
136+
137+
## Removed Tags

‎wiki/mkdocs.yml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
site_name: Frostiful Config Wiki
2+
3+
repo_url: https://github.com/TheDeathlyCow/frostiful
4+
repo_name: TheDeathlyCow/frostiful
5+
6+
nav:
7+
- index.md
8+
- config.md
9+
- tags.md
10+
- components.md
11+
- "🌡️ Thermoo API ↗": https://thermoo.thedeathlycow.com/
12+
13+
theme:
14+
name: material
15+
logo: assets/logo.png
16+
favicon: assets/favicon.svg
17+
18+
palette:
19+
- scheme: slate
20+
primary: custom
21+
features:
22+
- navigation.expand
23+
toggle:
24+
icon: material/weather-sunny
25+
name: Switch to light mode
26+
- scheme: default
27+
primary: custom
28+
features:
29+
- navigation.expand
30+
toggle:
31+
icon: material/weather-night
32+
name: Switch to dark mode
33+
34+
extra_css:
35+
- assets/styles.css
36+
37+
markdown_extensions:
38+
- attr_list
39+
- meta
40+
- admonition
41+
- pymdownx.details
42+
- pymdownx.superfences
43+
- pymdownx.tabbed:
44+
alternate_style: true
45+
- pymdownx.emoji:
46+
emoji_index: !!python/name:material.extensions.emoji.twemoji
47+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
48+
options:
49+
custom_icons:
50+
- assets/.icons

0 commit comments

Comments
 (0)
Please sign in to comment.