Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create gui/tooltips.lua: show info (f.e. job name) at units and/or mouse cursor #1365

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
23 changes: 23 additions & 0 deletions docs/gui/tooltips.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
gui/tooltips
============

.. dfhack-tool::
:summary: Show name and job tooltips near units on map.
:tags: fort inspection

**IMPORTANT NOTE**: the tooltips will show over any vanilla UI elements!


This script shows "tooltips" in two optional modes:

* following the mouse, when a unit is underneath the cursor;
* following units on the map.

Information shown includes happiness indicator, name, and current job.

Copy link
Member

@myk002 myk002 Jan 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Usage
-----

::

gui/tooltips
Loading
Loading