add gui/biomes: a way to see where one biome ends and another begins #637

TymurGubayev · 2023-03-12T13:06:11Z

selected biome is highlighted on the map
the "tooltip" window under the legend is shown on mouse-hover

TymurGubayev · 2023-03-12T13:10:02Z

This is not quite finished (see tasks), but I'll need help with them.

I can't find a way to change the color of the text on the map. Is there one? I want to (subtly) highlight map tiles of the selected biome.
Is there a way to get the minimap coordinates? I want to place the legend under it. If not, I'll probably move it into the bottom right corner.

myk002 · 2023-03-12T19:18:09Z

long time no see! welcome back!

I have not figured out a way to change the color of text being applied to map tiles. It might be possible, but I think you'll be better off using the "on/off" icons that TaxiService provided us. run gui/pathable to see what they look like, and see plugins/pathable.cpp for how they're retrieved from the Textures module. Also see gui/control-panel.lua for an example of getting textures in Lua (though there they're applied to the UI grid and not the map grid). We might be able to provide more colors and shapes, but it might be enough to just have the "on" icon for the currently selected biome and the "off" icon for everything else.

the minimap is always in the upper right corner and is always the same size. You can just use a frame attached to the right edge at a constant offset from the top and you'll be fine. gui/quickfort, for example, has a frame like this to appear just below the minimap.

I've found in the past that overlaying the entire visible map from Lua can be slow. If performance is an issue here, feel free to extend pathable.cpp with another API endpoint for this tool. Much of the logic you need is already there.

gui/biomes.lua

myk002 · 2023-03-12T19:22:15Z

gui/biomes.lua

+
+local TITLE = "Biomes"
+
+BiomeVisualizerLegend = nil -- for debugging purposes


for clearing the script environment for debugging/dev purposes, consider using devel/clear-script-env

I probably don't understand this. Right now, if I make a change in the script, or more specifically in the BiomeVisualizerLegend-class, I execute gui/biomes, and the changes are immediately applied. How would I use devel/clear-script-env instead? Execute first the clear-sript-env and then gui/biomes?.. I don't remember, how can I chain commands in dfhack console?

you'd only need to use devel/clear-script-env if you had previously set a global in the script and an update removes the global. for example, if you had function MyClass:onInput(keys) but then you remove the function, it will still be defined and active until you run devel/clear-script-env (or reload the game). If you just change an existing function definition, then there's no problem.

well, then I have to think about whether I set a global or not, and since most of the time I do not, I'll definitely forget the one time I do.

gui/biomes.lua

myk002 · 2023-03-12T19:27:49Z

also, if you like the behavior of gui/pathable, you can copy its structure of having the highlighted biome follow the mouse instead of/in addition to having the list selection control which biome is highlighted.

myk002 · 2023-05-03T00:14:45Z

@TymurGubayev have you made any progress on this? I'd love to get it into the next beta!

TymurGubayev · 2023-05-05T20:00:01Z

@myk002 right, I need to finish this one. I'll try to do it this weekend.

Few other minor changes

Other minor tweaks and an attempt at slightly improving performance via caching biome region info

TymurGubayev · 2023-05-06T19:56:34Z

Updated version is almost done, there are few things to still do though.

UI: right now, mousewheel events are captured by the active legends window, preventing user from changing z-level. No idea how can I disable this. Ideally, it should "fall through" to the game if not handled by a widget.
I'd like to move and resize the tooltip window with the legend window. I have no idea how to do this.
Something very strange is happening with the label-widget inside the tooltip window. Line 300 is my workaround. Without it, only a single-line is visible.
Possible bug: There is something strange going on with biomes in the air, either I don't understand something or it's a bug (probably in DFHack, but maybe DF): there are biomes up there that don't exist on a ground level, but also there are square blocks of tiles where biome info is missing (at least if retrieved the way I do it).

myk002 · 2023-05-11T00:53:03Z

Possible bug: There is something strange going on with biomes in the air, either I don't understand something or it's a bug (probably in DFHack, but maybe DF): there are biomes up there that don't exist on a ground level, but also there are square blocks of tiles where biome info is missing (at least if retrieved the way I do it).

I'll respond to the others in the review, but this one I think is expected. At least I've run into it before and I think there's a mantis bug for it. Biomes in the air are the same as the region up and left from the current embark area (or something like that).

Are the blocks where biome info is missing also in the air?

myk002 · 2023-05-11T00:45:30Z

gui/biomes.lua

+
+--------------------------------------------------------------------------------
+
+if RELOAD then TooltipWindow = nil end


yeah, this is the kind of stuff you'd use gui/clear-script-env for

gui/biomes.lua

myk002 · 2023-05-11T01:00:08Z

gui/biomes.lua

+            view_id = 'label',
+            frame = {t = 0, h = 1000},
+            auto_height = false,
+            --wtf??? without this the label is always a single line


this means that updateLayout() calls are not getting to this widget. If you call the TooltipWindow's updateLayout() when the main panel's updateLayout() is called, then they should stay in sync. However, resizing from the line between the two "windows" is not a common UX style, and nothing else in DFHack does it that way. Maybe you could add the tooltip as a widget in BiomeVisualizerLegend, like how gui/control-panel does it? That would simplify the structure quite a bit. You can still specify an interior frame (gui.INTERIOR_FRAME) around the tooltip panel, if you wish.

I was trying to recreate how hotkeys look, i.e.

but also hiding the tooltip if not hovering. I'll give it another try :)

Note that the hotkeys panel is not resizable -- nor is the buildingplan panel, which also has that dual-frame look. For a resizable window, I think what you want is a single exterior frame with possibly a thinner interior frame around the tooltip. Otherwise it isn't obvious where the player should go to resize the window. You can still make the extended info disappear and the window shrink when it's not hovered, but I'd actually recommend leaving it. The player can always resize the window or dragging it around if it's in the way.

I can't figure out how to make the window shrink dynamically :(
I'll try a version just showing the info

I give up on the resizable version.
List is fix 5 rows, info is fix 15 rows.

docs/gui/biomes.rst

gui/biomes.lua

TymurGubayev · 2023-05-11T09:54:51Z

Are the blocks where biome info is missing also in the air?

yes they are

Co-authored-by: Myk <[email protected]>

myk002 · 2023-05-11T18:32:00Z

Are the blocks where biome info is missing also in the air?

yes they are

ok, then it's probably not worth worrying about. this is almost certainly a vanilla bug

docs/gui/biomes.rst

myk002 · 2023-05-11T18:53:37Z

I just realized -- you found an embark with 8 biomes? impressive.

TymurGubayev · 2023-05-11T19:50:18Z

I just realized -- you found an embark with 8 biomes? impressive.

:) It only actually has 3, other ones are in the air

myk002 · 2023-05-11T20:22:47Z

I just realized -- you found an embark with 8 biomes? impressive.

:) It only actually has 3, other ones are in the air

Are you on Discord? figuring out what to do with those phantom biomes might be a good topic for discussion. Should they be hidden in the list? Optionally hidden, with a message saying that they are likely to be buggy? Showing them as identical to the "real" biomes might be confusing.

TymurGubayev · 2023-05-11T20:38:15Z

Are you on Discord? figuring out what to do with those phantom biomes might be a good topic for discussion. Should they be hidden in the list? Optionally hidden, with a message saying that they are likely to be buggy? Showing them as identical to the "real" biomes might be confusing.

I was for a bit on Discord, but I'm not sure I like it there, especially for discussions such as this one.

I think how to show the phantom biomes should depend on what happens if you manage to create a farm up there.
If it works as a farm in any other biome, then IMO there shouldn't be any difference in how they are shown.
If it doesn't, I could show them red, assuming the correct biomes are those at z = 0.

I'm most curious about the missing biomes: will the game explode or will it treat them like ice?

I'm not any good at such science experiments.

gui/biomes.lua

myk002 · 2023-05-15T21:51:20Z

gui/biomes.lua

+
+    local z = z or df.global.window_z
+
+    --for z = 0, maxZ do


no longer used? also the corresponding --end

yes, it was too slow. I'd like to leave it there for future reference though.

gui/biomes.lua

Other minor changes Co-authored-by: Myk <[email protected]>

TymurGubayev · 2023-12-30T19:32:01Z

dfhack.textures.getOnOffTexposStart() doesn't exist anymore. What do I replace it with?

ab9rf · 2023-12-30T19:50:19Z

dfhack.textures.getOnOffTexposStart() doesn't exist anymore. What do I replace it with?

dfhack/dfhack commit fe8bd4fa786369f7a95ae7925fc992095cc1fb2d may be informative (part of DFHack/dfhack#3663)

myk002 · 2023-12-31T00:33:58Z

unsuspend might be a good model to follow for the new textures api:
https://github.com/DFHack/scripts/blob/master/unsuspend.lua#L15

myk002 · 2023-12-31T17:37:57Z

could you rebase onto current master and add a changelog entry for the new tool?

myk002 · 2023-12-31T17:45:22Z

It looks like the used texture needs to change. Since the switch to SDL2, textures are stretched to cover the entire map tile:

gui/pathable switched to cursor textures:

TymurGubayev · 2024-01-01T10:03:04Z

It looks like the used texture needs to change. Since the switch to SDL2, textures are stretched to cover the entire map tile:
gui/pathable switched to cursor textures:

well, I have an idea about that actually:

this happens if I cut the 8x12 "on" indicator and place it in the top left corner on a different 32x32 png image with a transparent background.
This is done easily, the next question is, what to do with all the letters. I see the following possibilities.

Leave it as is, as the letters naturally have a lot of transparent pixels in them, so it isn't too ugly; in which case I'll probably switch to the cursor texture because otherwise, the mix of indicators in a corner and letters over whole tiles looks a bit weird.
Get or create a texture with letters in the corner of a 32x32 (haven't looked too hard for it), which would be some work involved and we'd end up with a somewhat big texture file.
Create required textures on the fly, including the indicator one.

I'd much prefer the 3rd approach, especially since we already have half of the required API: createTile/createTileset. The missing half is something to get the pixels from a loaded texture, or maybe some method to resize textures, etc.

myk002 · 2024-01-06T01:34:56Z

I tried (1) for the unsuspend overlay (displaying if a building is suspended or planned), but it just did not look good. I ended up designing new textures (rather, I asked someone more artistic than myself to design them): https://github.com/DFHack/dfhack/blob/develop/data/art/unsuspend.png

Adding another texture map to our art directory wouldn't be onerous. It's 5k for 5 unsuspend images, so 26 letters would be about 25k.

If you'd like to finish up the dynamic texture API, that would be cool, but I'm not sure if we should wait for that for this PR -- I'd rather get this released sooner rather than later.

myk002 · 2024-01-06T01:39:19Z

docs/gui/biomes.rst

+    :tags: fort inspection map
+
+This script shows the boundaries of the biome regions on the map.
+Hover over a biome entry in the list to get detailed info about it.


How about also allowing the player to hover the mouse cursor over the map to select the region in the list? If the keyboard cursors are used and the mouse hasn't moved, then that can take precedence to move the list cursor. Then when the mouse moves, it can be the selector again.

implemented... Now that I re-read your comment, probably not exactly what you had in mind, but hopefully close enough

gui/biomes.lua

TymurGubayev · 2024-01-06T15:25:03Z

where do I put art assets for scripts?

I'd like to add the following two.

Then it looks like this (mouse over a "b" tile)

myk002 · 2024-01-06T20:49:35Z

where do I put art assets for scripts?

all assets should go in the dfhack repo in the data/art/ directory.

myk002

love it. Great job!

TymurGubayev · 2024-01-13T09:23:13Z

yay!

add biomes.lua

5e7d81c

myk002 reviewed Mar 12, 2023

View reviewed changes

TymurGubayev added 3 commits May 6, 2023 13:50

position legend widget under minimap

4464035

Few other minor changes

update biome info when changing z-levels

6c451f7

Other minor tweaks and an attempt at slightly improving performance via caching biome region info

add "tooltip"

689cc5c

TymurGubayev added 5 commits May 7, 2023 15:31

add selected icon, improve text mode experience

012eff8

remove whitespaces

1602ee8

Create biomes.rst

44bf199

move biomes.rst to the correct folder

fc4ea45

use linux line endings

8543bd8

myk002 reviewed May 11, 2023

View reviewed changes

TymurGubayev and others added 4 commits May 11, 2023 11:56

Update docs/gui/biomes.rst

85c695b

Co-authored-by: Myk <[email protected]>

Update docs/gui/biomes.rst

03f071e

Co-authored-by: Myk <[email protected]>

Update docs/gui/biomes.rst

36fb331

Co-authored-by: Myk <[email protected]>

minor changes

ee5151c

myk002 reviewed May 11, 2023

View reviewed changes

docs/gui/biomes.rst Show resolved Hide resolved

always gather biome info at the very bottom first

cc3b803

no longer resizable, tooltip inside the panel

cd63ded

clarify a comment

b03ae09

myk002 reviewed May 11, 2023

View reviewed changes

gui/biomes.lua Outdated Show resolved Hide resolved

gui/biomes.lua Outdated Show resolved Hide resolved

gui/biomes.lua Outdated Show resolved Hide resolved

make resizable again, other small changes

1065275

myk002 reviewed May 15, 2023

View reviewed changes

make the map overlay blink in text mode

fc38f83

Other minor changes Co-authored-by: Myk <[email protected]>

myk002 mentioned this pull request Jun 1, 2023

Map annotation tiles for SDL2 DFHack/dfhack#3438

Closed

use new textures API

0b37a9a

Merge branch 'DFHack:master' into patch-6

00a7ed5

myk002 reviewed Jan 6, 2024

View reviewed changes

TymurGubayev added 3 commits January 6, 2024 16:16

Merge branch 'DFHack:master' into patch-6

af3cec7

use special textures for map overlay tiles

7885ac3

adjust tooltip based on map tile hovered over

746aacf

TymurGubayev added 2 commits January 6, 2024 16:28

remove trailing whitespace

9481147

add changelog entry

bea7f70

TymurGubayev mentioned this pull request Jan 6, 2024

add small letters and on-off textures in top-left corners of 32x32 tiles DFHack/dfhack#4144

Merged

TymurGubayev added 2 commits January 7, 2024 12:23

adjust tileset file names

f963104

Merge branch 'master' into patch-6

b10edca

myk002 approved these changes Jan 13, 2024

View reviewed changes

myk002 merged commit 874929d into DFHack:master Jan 13, 2024
10 checks passed


		local TITLE = "Biomes"

		BiomeVisualizerLegend = nil -- for debugging purposes


		--------------------------------------------------------------------------------

		if RELOAD then TooltipWindow = nil end

add gui/biomes: a way to see where one biome ends and another begins #637

add gui/biomes: a way to see where one biome ends and another begins #637

Conversation

TymurGubayev commented Mar 12, 2023 • edited Loading

TymurGubayev commented Mar 12, 2023

myk002 commented Mar 12, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

myk002 May 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

myk002 commented Mar 12, 2023

myk002 commented May 3, 2023

TymurGubayev commented May 5, 2023

TymurGubayev commented May 6, 2023

myk002 commented May 11, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TymurGubayev commented May 11, 2023

myk002 commented May 11, 2023

myk002 commented May 11, 2023

TymurGubayev commented May 11, 2023

myk002 commented May 11, 2023

TymurGubayev commented May 11, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TymurGubayev commented Dec 30, 2023

ab9rf commented Dec 30, 2023 • edited Loading

myk002 commented Dec 31, 2023

myk002 commented Dec 31, 2023

myk002 commented Dec 31, 2023

TymurGubayev commented Jan 1, 2024

myk002 commented Jan 6, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TymurGubayev commented Jan 6, 2024

myk002 commented Jan 6, 2024

myk002 left a comment

Choose a reason for hiding this comment

TymurGubayev commented Jan 13, 2024

TymurGubayev commented Mar 12, 2023 •

edited

Loading

myk002 May 11, 2023 •

edited

Loading

ab9rf commented Dec 30, 2023 •

edited

Loading