Immersive Overlays

This mod integrates a highly configurable coordinate overlay as an in-world mechanic, allowing it to only be visible as long as the player has a compass. In addition, it offers a similar overlay for clocks, showing the time of day. ## Coordinate Overlays Coordinate overlays for the player's X and Z coordinates are visible whenever the player has a compass in their inventory, including in a bundle. In 1.21.6 and above, the Player Locator Bar also requires a compass. This can be disabled in the config. When a player additionally has an item that displays depth, like a [Supplementaries](https://modrinth.com/mod/supplementaries) Altimeter or a Depth Gauge from mods like [Caverns & Chasms](https://modrinth.com/mod/caverns-and-chasms) or [Spelunkery](https://modrinth.com/mod/spelunkery), the Y coordinate value is shown as well. If no item is available, a compass item is sufficient to show the overlay. ## Time and Weather Overlays An overlay displaying the current time of day is displayed whenever the player has a clock in their inventory, including in a bundle. When a player additionally has an item that displays the weather, like a [Caverns & Chasms](https://modrinth.com/mod/caverns-and-chasms) Barometer, the weather is shown as well. If no item is available, a clock item is sufficient to show the overlay. ## Biome Overlays An overlay displaying the current biome is displayed whenever the player has a map in their inventory, including in a bundle. This feature supports all vanilla biomes, as well as some modded biomes. Mod support can be added via resource packs by adding a 16x16 sprite to `assets/modname/textures/immersiveoverlays/biomename.png`. ## Season Overlays An overlay displaying the current season is displayed whenever the player has a calendar in their inventory, including in a bundle. This requires a compatible seasons mod, with support for [Serene Seasons](https://modrinth.com/mod/serene-seasons), [Fabric Seasons](https://modrinth.com/mod/fabric-seasons), [Simple Seasons](https://modrinth.com/mod/simple-seasons), [TerraFirmaCraft](https://modrinth.com/mod/terrafirmacraft), and [Ecliptic Seasons](https://www.curseforge.com/minecraft/mc-mods/ecliptic-seasons). ## Temperature Overlays An overlay displaying the current temperature is displayed whenever the player has a thermometer in their inventory, including in a bundle. - In vanilla, this data is sourced from the biome's temperature. - With [Fabric API](https://modrinth.com/mod/fabric-api) or [Forgified Fabric API](https://modrinth.com/mod/forgified-fabric-api) installed, this data is sourced from the conventional biome tags. - With [Oreganized](https://modrinth.com/mod/oreganized) installed, this data is sourced from the Thermometer. - With [Tough as Nails](https://modrinth.com/mod/tough-as-nails) installed, this data is sourced from the player's temperature. - With [Cold Sweat](https://modrinth.com/mod/cold-sweat/) installed, this data is sourced from the player's temperature. - With [Legendary Survival Overhaul](https://www.curseforge.com/minecraft/mc-mods/legendary-survival-overhaul) installed, this data is sourced from the player's temperature. ## Speed Overlays An overlay displaying the current temperature is displayed whenever the player has a speedometer in their inventory, including in a bundle. - In vanilla, this data is sourced from the player's speed. - With [Oreganized](https://modrinth.com/mod/oreganized) installed, this data is sourced from the Speedometer. ## Wind Overlays An overlay displaying wind intensity and direction is displayed whenever the player has a gust gauge in their inventory, including in a bundle. - With [Breezy](https://modrinth.com/mod/breezy) installed, this data is sourced from the Gust Gauge. ## Mod Compatibility The mod has support for [Spelunkery](https://modrinth.com/mod/spelunkery), [Caverns & Chasms](https://modrinth.com/mod/caverns-and-chasms), and [Supplementaries](https://modrinth.com/mod/supplementaries) items out of the box. For other mods, items can be added to the mod's various config options. In addition, the following features are present when compatible mods are installed: - Items with overlays will work in accessory slots from the following mods: - [Accessories](https://modrinth.com/mod/accessories) - [Curios](https://modrinth.com/mod/curios) - [Trinkets (Updated)](https://modrinth.com/mod/trinkets-updated) - [Trinkets](https://modrinth.com/mod/trinkets) - Items with overlays will work in backpacks from (at least) the following mods: - [Traveler's Backpack](https://modrinth.com/mod/travelersbackpack/) - [Sophisticated Backpacks](https://modrinth.com/mod/sophisticated-backpacks/versions) - [Tiered Backpacks](https://modrinth.com/mod/tiered-backpacks) - [Backpacks for Dummies](https://modrinth.com/mod/backpacks-for-dummies) - The (backported) locator bar is now only displayed when the player has a compass. - [Player Locator Plus](https://modrinth.com/mod/player-locator-plus) - [Player Locator Plus Reforged](https://modrinth.com/mod/player-locator-plus-reforged) - [Better Player Locator Bar](https://modrinth.com/mod/bplb) - [Xaero's Minimap](https://modrinth.com/mod/xaeros-minimap): When a map item is set, it can be used inside a bundle. - [Xaero's World Map](https://modrinth.com/mod/xaeros-world-map): When a map item is set, it can be used inside a bundle. - [Accessorify](https://modrinth.com/mod/accessorify): This mod's overlays will replace the ones from Accessorify. ## FAQ - Will this mod be ported to other versions/loaders? - New updates will only support 1.20.1, 1.21.1, 1.21.11 and latest (26.1-snapshot-6). There is no plan to backport to older versions or any other loaders. - Can I request support for overlays for other mods? - You can, but if the mod is not present on at least 1.21.1 or newer, I'm highly unlikely to add them. ## Credits The concept for this mod came from a prototype by [nöelle](https://modrinth.com/user/noelledotjpg) for Raspberry Flavoured. I took this concept and iterated on it in my mod, [Raspberry Core](https://modrinth.com/mod/raspberry-core), before finalizing it here as Immersive Overlays. Textures and mod icon are also by [nöelle](https://modrinth.com/user/noelledotjpg). Textures for Temperature Overlays and Season Overlays by [ProbablyEkho](https://modrinth.com/user/ProbablyEkho). Textures for No Man's Land, Abundant Atmosphere, and New World biome overlays by [KevBo](https://github.com/kevBo2003).

useful