Ludeon Forums

RimWorld => Mods => Releases => Topic started by: falconne on June 16, 2017, 07:01:31 AM

Title: [1.2] Heat Map: Togglable temperature based colour gradient over your base
Post by: falconne on June 16, 2017, 07:01:31 AM
Heat Map
Adds a toggle button to show a live temperature based colour gradient over indoor areas in your base. The gradient uses the familiar colour scheme of green being the midpoint for human comfort (in the game that's 22C / 71.6F), becoming deeper blue or red for colder and hotter rooms respectively.

By default, each room's temperature is also shown in small text over the room when overlay is active (this can be turned off in mod settings).

Download from Steam Workshop (http://steamcommunity.com/sharedfiles/filedetails/?id=947972722)
Direct Download: Github (https://github.com/Falconne/HeatMap/releases)
Source: Github (https://github.com/Falconne/HeatMap)


(https://steamuserimages-a.akamaihd.net/ugc/859473551898616117/0419FC0DAB39ADE23D935895274288997D1C9437/)

By default, the green range is compressed more than usual, to make it easier to see when rooms are on the edge of comfort. The deepest blue and red are not mapped to the coldest and hottest possible map temperatures, as that would be useless inside a base where temperatures aren't that extreme. Instead they are bound from -12C to 56C (10.4F to 132.8F), so that you can tell from the colours what the temperature is.

You can set a different custom range in the mod settings for extreme maps. When using a custom range, there is no green compression.

The overlay is toggled with a button in the lower right. It can also be toggled with a keyboard shortcut; the default keybinding is \ (backslash) and can be changed in the 'Keyboard configuration' menu in Options, under a new Heat Map section.

When the overlay is turned on, it will update as the game runs. The overlay opacity and update speed can be configured in Mod Settings dialog.

The mod also adds a thermometer widget to the top right hand corner of the UI, displaying the current outdoor temperature (shaded with the same colour scheme as the overlay). This can be disabled in Mod Settings. Clicking this widget also toggles the heat map overlay.

Translation credits (GitHub usernames):
* Japanese by @Proxyer
* Spanish by @53N4


License
GPLv3 (free to do what you like, just give me credit).
Title: Re: [A17] Heat Map: Togglable temperature based colour gradient over your base
Post by: kaptain_kavern on June 16, 2017, 10:05:41 AM
Sweet !

Thank you
Title: Re: [A17] Heat Map: Togglable temperature based colour gradient over your base
Post by: SpaceDorf on June 16, 2017, 04:41:22 PM
Quote from: kaptain_kavern on June 16, 2017, 10:05:41 AM
Sweet !

Thank you

What he said ... thank you so very much for this ..
Title: Re: [A17] Heat Map: Togglable temperature based colour gradient over your base
Post by: stigma on July 17, 2017, 05:39:44 PM
AWESOME mod - so simple, but so useful.
Yet another "this should have been in vanilla" type of mod with no downsides to speak of.

I do however have one thing I'd really like to see - and hopefully it is not too hard to implement:

Problem: I'd like to play with heatmap on all the time to be able to tell that something is going on before it becomes bad (like all my compost getting ruined because I forgot to build more passive coolers as tribals). heatmap is great for seing the problem - but usually it is too late by the time you check it. Unfortunately the effect is very strong - and it makes it hard/uncomfortable to look at the details in your rooms.

Solution: Add a copy of this effect that is the same but with maybe 25% to 50% (hard to guess without seeing it) opacity so that you get some rough indication of the heat level to warn of trouble, but not so much that you can't just comfortably keep it on always.

Suggestions on how to implement (in order of what I think would be the ideal implementation):
- Make the button a 3-toggle, so it just cycles the 3 states, off, normal, "light". Unless a 3-toggle is hard to make in this framework this seems like the obvious solution.
- Make the button pop out a menu you can select the state from like "cleaning area" mod does. You can probably just rip the relevant code from that project (with the authors permission obviously) to use here if it is non-trivial to implement. Not quite AS intuitive as a 3-toggle, but still easy to use, and then you could even include a few different opacity levels so users can adjust to taste - so this is a definite boon worth considering.
- Make a toggle in in-game mod menu. Cumbersome, but workable. At least doesn't need a restart.
- Make it an editable value or switch in some XML file. If all else fails...
- Make a "light" version of the mod. The nuclear option - but probably the simplest of all in terms of changes since I'm guessing it's changing a couple of values in the dll and recompiling (I'd be happy even with just this though :) )

-Stigma
Title: Re: [A17] Heat Map: Togglable temperature based colour gradient over your base
Post by: falconne on July 17, 2017, 07:17:22 PM
Yep, the next update is going to have configurable opacity as well as update frequency.

I'll be doing it either with a setting in the mod config menu (from options) or a right click menu on the button itself. The latter is nicer but the former is faster to implement so probably end up going with that.
Title: Re: [A17] Heat Map: Togglable temperature based colour gradient over your base
Post by: stigma on July 18, 2017, 12:18:15 AM
Quote from: falconne on July 17, 2017, 07:17:22 PM
Yep, the next update is going to have configurable opacity as well as update frequency.

I'll be doing it either with a setting in the mod config menu (from options) or a right click menu on the button itself. The latter is nicer but the former is faster to implement so probably end up going with that.

Awesome! Yea, I don't see any issue with that implementation. You won't be changing opacity that often anyway. Not sexy - but functional. Very Rimworld ;)

-Stigma
Title: Re: [A17] Heat Map: Togglable temperature based colour gradient over your base
Post by: Adalah217 on July 18, 2017, 01:26:24 AM
Just want to give a shout out and let you know this mod is fantastic! Wish I could the heatmap on all the time, but as others have said, opacity is an issue.
Title: Re: [A17] Heat Map: Togglable temperature based colour gradient over your base
Post by: falconne on July 26, 2017, 06:52:22 AM
Just uploaded a new version.

The mod now lets you configure the opacity and update speed from the Mod Setting menu.
Title: Re: [A17] Heat Map: Togglable temperature based colour gradient over your base
Post by: SpaceDorf on July 26, 2017, 07:27:16 AM
Thank you again.

And since inside temperatures are covered now .. and you included a Mod Menu,
I have a long standing wish for the gui.

Could you add a Display for the outside temperature that is actually visible instead of hidden and may even look nice ?

I attached a pictured of an old rpg I used to play. It has quite the modding community, too :)

[attachment deleted by admin due to age]
Title: Re: [A17] Heat Map: Togglable temperature based colour gradient over your base
Post by: falconne on October 11, 2017, 03:52:34 PM
I've just made a quick update to add a keyboard shortcut to toggle the overlay. The default keybinding is \ (backslash) and can be changed in the 'Keyboard configuration' menu in Options, under a new Heat Map section.

Quote from: SpaceDorf on July 26, 2017, 07:27:16 AM
Could you add a Display for the outside temperature that is actually visible instead of hidden and may even look nice ?

I will look into that in a future update.
Title: Re: [A17] Heat Map: Togglable temperature based colour gradient over your base
Post by: SpaceDorf on October 13, 2017, 01:04:28 PM
Thank you  :)
Title: Re: [A17] Heat Map: Togglable temperature based colour gradient over your base
Post by: Rock5 on November 20, 2017, 09:40:44 PM
I'd love to see this updated for B18.
Title: Re: [A17] Heat Map: Togglable temperature based colour gradient over your base
Post by: falconne on November 20, 2017, 10:36:04 PM
Yes all my mods will be updated to B18 soonish. Just a bit busy at the moment.
Title: Re: [B18] Heat Map: Togglable temperature based colour gradient over your base
Post by: falconne on November 23, 2017, 03:29:02 AM
Update to B18 done
Title: Re: [B18] Heat Map: Togglable temperature based colour gradient over your base
Post by: Layd on November 29, 2017, 12:00:15 PM
A good mod but there are no language files. People themselves translate but do at least English.
Title: Re: [B18] Heat Map: Togglable temperature based colour gradient over your base
Post by: Harry_Dicks on February 24, 2018, 09:58:53 PM
This mod has become a must have for me. Thank you so much for this!
Title: Re: [B18] Heat Map: Togglable temperature based colour gradient over your base
Post by: Ruisuki on March 01, 2018, 02:45:45 AM
At first I thought this was a part of Centralized Climate Controls overlay. Good Stuff
Title: Re: [B18] Heat Map: Togglable temperature based colour gradient over your base
Post by: falconne on March 15, 2018, 05:57:43 AM
Have published a new version:

A thermometer widget has been added to the top right hand corner of the UI, displaying the current outdoor temperature (shaded with the same color scheme as the overlay). This can be disabled in Mod Settings. Clicking this widget also toggles the heat map overlay.

Also I've made the UI strings translatable now; if anyone can help out translating please make a pull request on Github.
Title: Re: [B18] Heat Map: Togglable temperature based colour gradient over your base
Post by: falconne on March 16, 2018, 08:10:17 PM
Just released an update with a fix for a memory leak with the outdoor thermometer. Please update if you were downloading manually.
Title: Re: [B18] Heat Map: Togglable temperature based colour gradient over your base
Post by: Jackalvin on March 20, 2018, 10:07:07 AM
Hello. I used this mod yesterday and I have to say I really enjoyed it. I was able to see how my airlock was letting out cold, and in a cold biome this was a important issue. Quick question though, can we get a one for beauty and the like, I'd greatly appreciate it.
Title: Re: [B18] Heat Map: Togglable temperature based colour gradient over your base
Post by: falconne on March 20, 2018, 03:34:31 PM
I'd been considering something similar for room info, maybe showing a bit more detail than just colour. I will look into it.
Title: Re: [B18] Heat Map: Togglable temperature based colour gradient over your base
Post by: falconne on April 07, 2018, 08:56:11 AM
Quote from: Jackalvin on March 20, 2018, 10:07:07 AM
Hello. I used this mod yesterday and I have to say I really enjoyed it. I was able to see how my airlock was letting out cold, and in a cold biome this was a important issue. Quick question though, can we get a one for beauty and the like, I'd greatly appreciate it.

I've made this now: https://ludeon.com/forums/index.php?topic=40824.0 I'd appreciate any play testing from folks with the time.
Title: Re: [B19] Heat Map: Togglable temperature based colour gradient over your base
Post by: falconne on August 29, 2018, 06:57:46 AM
Updated to B19
Title: Re: [B19] Heat Map: Togglable temperature based colour gradient over your base
Post by: Rulin on September 15, 2018, 04:30:10 PM
Looks like other mods can overwrite the UI toggle button. Using the current mod with the newest 1.0.2026 version atm.
I think it might have something to do with this one: https://steamcommunity.com/sharedfiles/filedetails/?id=1339135272
It adds three new overlay toggles to the game.
I just tried loading Heat Map before the TD Enhancement Pack, didn't work.
Hmmm... I am also using the Cleaning Area mod which has a toggle. So it might have something to do with this one...

Edit: No, I just loaded Heat Map without any other mods. For some reson the toggle button is not showing up.
I noticed there is a new button in my game version. "Automatic rebuild of destroyed structures in home area". So maybe this is blocking the button? I don't know...

Also allow me a small suggestion: A "back to default/vanilla settings"-button in the mod options menu would be nice to have.

Btw, what values do I have to change so my fridge is not heating up that fast due to door opening and other things? I tried adjusting the numbers but the temperature doesn't really change. 28°C Outdoors, 0°C Indoors -9 target. It is not a big room and I am using 2 ACs.

Title: Re: [B19] Heat Map: Togglable temperature based colour gradient over your base
Post by: falconne on September 15, 2018, 06:03:03 PM
Quote from: Rulin on September 15, 2018, 04:30:10 PM
Looks like other mods can overwrite the UI toggle button. Using the current mod with the newest 1.0.2026 version atm.
I think it might have something to do with this one: https://steamcommunity.com/sharedfiles/filedetails/?id=1339135272

I've checked with TD Enhancement mod enabled and both seem to work together ok. Is the Heat Map mod enabled in your mod list? You said you are on a 1.0 version; you should be on a 0.19 version. This mod won't work without the latest 0.19 version.

Quote from: Rulin on September 15, 2018, 04:30:10 PM
Btw, what values do I have to change so my fridge is not heating up that fast due to door opening and other things? I tried adjusting the numbers but the temperature doesn't really change. 28°C Outdoors, 0°C Indoors -9 target. It is not a big room and I am using 2 ACs.

You probably want to make a post in General or the Rimworld Discord with screenshots. Folks can give you suggestions.
Title: Re: [1.0] Heat Map: Togglable temperature based colour gradient over your base
Post by: falconne on October 19, 2018, 04:05:16 AM
Updated for 1.0
Title: Re: [1.0] Heat Map: Togglable temperature based colour gradient over your base
Post by: Reyghel on December 08, 2018, 08:39:40 AM
Many thanks dear modder for making this mod, it greatly facilitates the task of knowing the temperature and comfort of my settlers. And not having to be selecting it individually for each room or hallway. I just hope it works in the version of the game that I have that is 1.0.20.96. Greetings from Uruguay.
Title: Re: [1.0] Heat Map: Togglable temperature based colour gradient over your base
Post by: JT on December 08, 2018, 04:43:43 PM
1.0.2059 and 1.0.2096 are both "1.0" and both work fine.
Title: Re: [1.0] Heat Map: Togglable temperature based colour gradient over your base
Post by: ambivalence on December 26, 2018, 08:47:19 AM
As it was mentioned in Steam, it would be really great to have a custom scale for really cold maps. Sometimes even -20 is fine, when it's -200 outside.
Title: Re: [1.0] Heat Map: Togglable temperature based colour gradient over your base
Post by: falconne on February 14, 2019, 02:33:12 AM
New update now lets you set custom scales for the gradient.

Also, when overlay is on, each room's temperature is now shown over the room. This can be disabled in the mod settings.
Title: Re: [1.1] Heat Map: Togglable temperature based colour gradient over your base
Post by: falconne on February 27, 2020, 03:19:51 AM
Updated to 1.1
Title: Re: [1.2] Heat Map: Togglable temperature based colour gradient over your base
Post by: falconne on August 22, 2020, 06:27:34 PM
Updated to v1.2