Skip to content

Commit

Permalink
update readme with integrations and title image, and added yeoxuhang …
Browse files Browse the repository at this point in the history
…credit
  • Loading branch information
TheDeathlyCow committed Dec 8, 2023
1 parent c5455f2 commit 0fa5c3a
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 12 deletions.
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
<p align="center">
<img src="./src/main/resources/assets/frostiful/frostiful.png" alt="Frostiful title">
A Frosty Vanilla+ Survival Experience
</p>

# Download Pages

CurseForge: https://www.curseforge.com/minecraft/mc-mods/frostiful
Expand All @@ -10,18 +15,18 @@ The above download pages are the ONLY source of this mod, DO NOT TRUST ANY OTHER

Basically everything about this mod is documented extensively on the [wiki](https://github.com/TheDeathlyCow/frostiful/wiki/).

# Compatibility

Known compatibility issues and potential workarounds/fixes will be listed here as they become known. If you find a compatibility issue, feel free to raise an [issue](https://github.com/TheDeathlyCow/frostiful/issues) or tell me about it on my [Discord](https://discord.gg/aqASuWebRU) and I will add it here.
# Mod Integrations

| Mod Name | Problem | Versions | Fix or Workaround |
|----------------------|-------------------------------------------------------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------|
| Lithium | Mixin error | Frostiful 0.1.0-0.2.1 | Add the line `mixin.entity.fast_powder_snow_check=false` to Lithium's config in `lithium.properties`. |
| Origins | Merling Origin freezes to death very quickly in water | Frostiful 0.1.0-0.2.1 | Frostiful 0.2.2+ now natively works with the Merling Origin appropriately |
| EnvironmentZ | Both mods add a temperatue bar | All | The mods don't seem to immediately crash when used together, however you should turn off passive freezing for Frostiful in the config. |
| Immersive Weathering | Freezing Water is applied twice | All | In Immersive Weathering's Common Config, set `water_increment` to 0. |
| Health Overlay | Cold hearts not rendering | Frostiful 0.1.0-0.2.6 | Frostiful 0.2.7+ now has native compatibility with Health Overlay |
* [Colorful Hearts](https://modrinth.com/mod/colorful-hearts) & [Overflowing Bars](https://modrinth.com/mod/overflowing-bars): Cold Hearts render on top of the new hearts from these mods
* [Tips](https://modrinth.com/mod/tips): Added some Frostiful-specific tips
* [Enchantment Descriptions](https://modrinth.com/mod/enchantment-descriptions): Descriptions are provided for Frostiful's enchantments
* [Farmer's Delight](https://modrinth.com/mod/farmers-delight-fabric): Hot Cocoa provides the Warmth effect
* [Farmer's Respite](https://www.curseforge.com/minecraft/mc-mods/farmers-respite): Teas and warm foods provide the Warmth effect
* [Festive Delight](https://www.curseforge.com/minecraft/mc-mods/festive-delight): Christmas Tea provides the Warmth effect
* [Frozen Up](https://www.curseforge.com/minecraft/mc-mods/frozen-up): Truffle Hot Chocolate provides the Warmth effect
* [Fabric Seasons](https://modrinth.com/mod/fabric-seasons): Winters in snowy and freezing biomes are *even colder* than normal

# Additional Credits

[NerjalNosk](https://github.com/NerjalNosk) - Health Overlay compatibility.
[NerjalNosk](https://github.com/NerjalNosk) - Health Overlay compatibility.
[YeoXuHang](https://github.com/YeoXuHang) - Assistance with the Frost Wand 3D model redesign
Binary file added src/main/resources/assets/frostiful/frostiful.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion src/main/resources/fabric.mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"TheDeathlyCow"
],
"contributors": [
"NerjalNosk (Various compatibility patches)"
"NerjalNosk (Various compatibility patches)",
"YeoXuHang (Assistance with the Frost Wand 3D model redesign)"
],
"contact": {
"homepage": "https://github.com/TheDeathlyCow/frostiful/wiki",
Expand Down

0 comments on commit 0fa5c3a

Please sign in to comment.