Create gui/spectate by TimurKelman · Pull Request #1365 · DFHack/scripts

TimurKelman · 2025-01-04T16:31:12Z

Configuration UI for the spectate plugin

myk002 · 2025-01-06T03:23:04Z

I am intrigued and delighted : )

myk002 · 2025-01-06T09:08:27Z

Let me finish reviewing DFHack/dfhack#4959 so getUnitsInBox no longer returns inactive units

myk002 · 2025-01-06T08:58:49Z

@@ -0,0 +1,281 @@
+-- Show tooltips on units and/or mouse
+
+local RELOAD = false -- set to true when actively working on this script


FYI, devel/clear-script-env has the same effect:

multicmd devel/clear-script-env gui/tooltips; gui/tooltips

myk002 · 2025-01-06T09:27:21Z

+    :tags: fort inspection
+
+This script shows "tooltips" following units and/or mouse with job names.
+


needs disclaimer that tooltips will show over any vanilla UI elements:

The dig ascii overlays suffer from the same problem. I don't know of any good solution here. I'm not saying that any behavior needs to change -- just needs to be documented.

added an **IMPORTANT NOTE** at the beginning of the description text

myk002 · 2025-01-06T09:29:39Z

+    :summary: Show tooltips with useful info.
+    :tags: fort inspection
+
+This script shows "tooltips" following units and/or mouse with job names.


needs more description of the two options and their effects.

added a bit of clarification...
It's kind of hard to describe though

Co-authored-by: Myk <myk.taylor@gmail.com>

myk002 · 2025-01-06T19:00:09Z

Btw this PR has started some discussion on the Discord server where your input would be valuable: https://discord.com/channels/793331351645323264/807444515194798090/1325754489659195502

Also, simplify GetUnitJob

myk002

My feedback:

this would be better as a fullscreen overlay that could be toggled via a keybinding bound to dwarfmode/Default and dungeonmode/Default (file). It could also be toggleable from gui/tooltips (which becomes just the configuration interface instead of the rendering mechanism). I don't want to promote leaving a windowed DFHack tool on the screen indefinitely because of DFHack/dfhack#4183
the enabled state should be managed by the overlay framework. this means that whether the tooltips are displayed is a per-player global setting. The tooltip behavior/contents configuration would likewise be global, stored in dfhack-config/tooltips.json

There were some reservations about the name gui/tooltips -- I'll get more feedback from people about that on Discord.

not required for this PR but maybe consider as a future enhancement:

the configuration for which elements to display could be a matrix of checkboxes so players could choose any combination of information for the tooltip and the mouseover.

TimurKelman · 2025-01-12T12:29:29Z

the configuration for which elements to display could be a matrix of checkboxes so players could choose any combination of information for the tooltip and the mouseover.

is there a CheckBox control, or what should I use for this?

myk002 · 2025-01-15T01:03:45Z

There isn't a super convenient widget for that yet, largely because every place I've needed toggle checkboxes so far, they've been in a list (which doesn't take widgets). See gui/control-panel or maybe the prototype code in gui/manipulator for examples of the list-based approach. You could likely reuse the graphic assets and just slap them on a Label for a non-List option.

TimurKelman · 2025-01-18T22:51:41Z

Config UI with current defaults

myk002 · 2025-01-20T22:09:36Z

should probably ensure the mouseover panel renders over the other floating text:

myk002

as discussed on Discord, could you rename gui/tooltips to gui/spectate and move the overlay code to plugins/lua/spectate.lua? spectate itself will need a bit of an overhaul. I can do that or you can if you'd like to.

myk002 · 2025-01-20T22:12:42Z

+
+-- pens are the same as gui/control-panel.lua
+local textures = require('gui.textures')
+local function get_icon_pens()


this is ugly duplication, but we don't have a good widget API for it yet, so I don't think there's a better option. We can change this later once we have a better way to address this fairly common use case. I see orders.lua does some similar duplication for the workshop labor restrictions overlay.

TimurKelman · 2025-01-20T22:18:56Z

should probably ensure the mouseover panel renders over the other floating text

yeah, that might be a good idea :) But how?

myk002 · 2025-01-20T22:19:21Z

order of rendering in render()

TimurKelman · 2025-01-20T22:21:34Z

as discussed on Discord, could you rename gui/tooltips to gui/spectate and move the overlay code to plugins/lua/spectate.lua? spectate itself will need a bit of an overhaul. I can do that or you can if you'd like to.

I'll try to do that, just can't promise when.

myk002 · 2025-01-20T22:23:01Z

I can overhaul spectate in the 51.01-r2 release timeframe. that would give us about a month to get this all finalized and merged

Also, don't import ResizingPanel separately

TimurKelman · 2025-02-01T11:25:31Z

config UI is now a list:

TimurKelman · 2025-02-01T20:33:28Z

btw, in case anyone is wondering: I haven't forgotten about merging this with spectate, I'm just trying to finish the new stuff first.

myk002 · 2025-02-02T00:39:43Z

no worries! I haven't done my part on spectate yet anyway, so it's not quite ready for you

edit: spectate is ready for you now. I added stubs and empty files in preparation

TimurKelman · 2025-02-21T20:21:44Z

some things there might deserve to be moved to some more central location:

ToggleLabel is like ToggleHotkeyLabel, but uses icon instead of "On"/"Off" text. Maybe make it an option?
pairsByKeys is a trivial table iterator in key order (with an optional sorting function). I didn't find one; this one I had to write twice (here and in the plugins/spectate.lua)
rpad is just return string.format("%-"..i.."s", s)... which may be too trivial
append (which should maybe called concat) concats two sequences together (which is also trivial enough)

myk002 · 2025-02-22T08:28:16Z

I'll see what I can upstream, then I'll clean things up

first upstreamed change: DFHack/dfhack#5296

TimurKelman · 2025-02-22T15:08:22Z

that's a lot of red :)

TimurKelman added 2 commits January 4, 2025 16:51

Create tooltips.lua

1ed5e22

Create tooltips.rst

7abc355

myk002 reviewed Jan 6, 2025

View reviewed changes

TimurKelman and others added 2 commits January 6, 2025 11:16

Update docs/gui/tooltips.rst

66dce0d

Co-authored-by: Myk <myk.taylor@gmail.com>

Update gui/tooltips.lua

c27777a

Co-authored-by: Myk <myk.taylor@gmail.com>

TimurKelman added 3 commits January 7, 2025 23:27

enter emoticons

0ca5a9a

fix GetScreenCoordinates for ASCII mode

0f6aeba

Also, simplify GetUnitJob

tooltips.rst: add IMPORTANT NOTE as well as some clarifications

be5bccd

myk002 reviewed Jan 11, 2025

View reviewed changes

TimurKelman added 3 commits January 12, 2025 11:22

vieport.window_x -> .coord

9484f8e

use getUnitsInBox(pos1, pos2) overload

33dbe85

make this an overlay

8d345a7

TimurKelman added 2 commits January 18, 2025 23:44

make possible to show specific stress/happiness levels; add config UI

66d8d39

trim trailing whitespaces

e97201c

fix an ASCII mode exception

2e1cf87

myk002 reviewed Jan 20, 2025

View reviewed changes

Comment thread gui/tooltips.lua Outdated

myk002 reviewed Jan 20, 2025

View reviewed changes

TimurKelman added 2 commits February 1, 2025 11:16

render mouse tooltips over unit banners

7e53def

Also, don't import ResizingPanel separately

use list instead of labels in config UI

ec27b39

persist config (globally)

5ec1e54

This was referenced Feb 3, 2025

add stub gui/spectate #1392

Merged

initial rewrite of spectate DFHack/dfhack#5247

Merged

TimurKelman mentioned this pull request Feb 9, 2025

spectate.lua: implement unit banners and mouse tooltips DFHack/dfhack#5264

Merged

myk002 changed the title ~~Create gui/tooltips.lua: show info (f.e. job name) at units and/or mouse cursor~~ Create gui/spectate Feb 10, 2025

TimurKelman added 4 commits February 21, 2025 20:52

Merge branch 'master' into gui/tooltips/1

6c98c34

Delete docs/gui/tooltips.rst

7abd0f9

Delete gui/tooltips.lua

bb4972f

implement gui/spectate.lua

561eeab

adjust starting position

3c3fa05

myk002 added 2 commits February 22, 2025 02:43

Merge branch 'master' into HEAD

40f3913

refactor UI and use upstreamed functionality

46689c2

myk002 approved these changes Feb 22, 2025

View reviewed changes

myk002 merged commit bbf75a7 into DFHack:master Feb 22, 2025

		@@ -0,0 +1,281 @@
		-- Show tooltips on units and/or mouse

		local RELOAD = false -- set to true when actively working on this script

		:tags: fort inspection

		This script shows "tooltips" following units and/or mouse with job names.

Conversation

TimurKelman commented Jan 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

myk002 commented Jan 6, 2025

Uh oh!

myk002 commented Jan 6, 2025

Uh oh!

myk002 Jan 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

myk002 Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TimurKelman Jan 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

myk002 Jan 6, 2025

Choose a reason for hiding this comment

Uh oh!

TimurKelman Jan 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

myk002 commented Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

myk002 left a comment

Choose a reason for hiding this comment

Uh oh!

TimurKelman commented Jan 12, 2025

Uh oh!

myk002 commented Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TimurKelman commented Jan 18, 2025

Uh oh!

Uh oh!

myk002 commented Jan 20, 2025

Uh oh!

myk002 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

myk002 Jan 20, 2025

Choose a reason for hiding this comment

Uh oh!

TimurKelman commented Jan 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

myk002 commented Jan 20, 2025

Uh oh!

TimurKelman commented Jan 20, 2025

Uh oh!

myk002 commented Jan 20, 2025

Uh oh!

TimurKelman commented Feb 1, 2025

Uh oh!

TimurKelman commented Feb 1, 2025

Uh oh!

myk002 commented Feb 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TimurKelman commented Feb 21, 2025

Uh oh!

myk002 commented Feb 22, 2025

Uh oh!

TimurKelman commented Feb 22, 2025

Uh oh!

Reviewers

Assignees

Labels

TimurKelman commented Jan 4, 2025 •

edited

Loading

myk002 Jan 6, 2025 •

edited

Loading

TimurKelman Jan 7, 2025 •

edited

Loading

myk002 commented Jan 6, 2025 •

edited

Loading

myk002 commented Jan 15, 2025 •

edited

Loading

TimurKelman commented Jan 20, 2025 •

edited

Loading

myk002 commented Feb 2, 2025 •

edited

Loading