Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Mod configuration

The mod can be configured by editing the ui-tweaks.json file in your Vintage Story’s ModConfig folder.

Keep in mind that changing some of these options may require you to restart the game or reload the world for the changes to take effect.

Note: You need to start a game with this mod installed at least once for it to generate the default configuration file.

Configuration values

hud — Configuration for the heads-up display (HUD) features of the mod.
environmentWidget — Configuration for the environment widget.

  • enable: Whether to show the environment widget. Default: true.

  • dialogArea: The dialog area anchor for the widget. Default: RightTop.

  • height: Height of the widget in pixels. Default: 56.0.

  • width: Width of the widget in pixels. Default: 256.0.

  • centerText: Whether to center the widget text. Default: true.

  • offset: Offset of the widget from its default position.

  • x: Horizontal offset. Default: -8.0.

  • y: Vertical offset. Default: 272.0.

  • padding: Padding of the widget content.

  • top: Top padding. Default: 4.0.

  • right: Right padding. Default: 20.0.

  • bottom: Bottom padding. Default: 4.0.

  • left: Left padding. Default: 20.0.

  • hasBackground: Whether to show a background behind the widget. Default: true.

  • backgroundOpacity: Opacity of the background. Default: 0.25.

  • backgroundCornerRadius: Corner radius of the background. Default: 12.0.

  • format: Format of the widget text. Supports VTML and variable placeholders. Default: <font align=left>{world-date-time:HH:mm}</font><font align=right>{player-location-temperature-celsius}°C</font><br>X: {player-location-coordinates-x} Y: {player-location-coordinates-y} Z: {player-location-coordinates-z}.

  • extraElements: Additional lines of text to display in the widget. Supports the same format as format. Default: ["{world-date-time:d MMMM}, Year {world-date-time:%y}"].

  • fontSize: Font size of the widget text in pixels. Default: 14.0.

healthbarTooltip — Configuration for the health bar tooltip.

  • enable: Whether to show the healthbar tooltip. Default: true.

  • dialogArea: The dialog area anchor for the tooltip. Default: CenterBottom.

  • height: Height of the tooltip in pixels. Default: 25.0.

  • width: Width of the tooltip in pixels. Default: 144.0.

  • centerText: Whether to center the tooltip text. Default: false.

  • offset: Offset of the tooltip from its default position.

  • x: Horizontal offset. Default: -250.0.

  • y: Vertical offset. Default: -88.0.

  • padding: Padding of the tooltip content.

  • top: Top padding. Default: 0.0.

  • right: Right padding. Default: 9.0.

  • bottom: Bottom padding. Default: 0.0.

  • left: Left padding. Default: 9.0.

  • hasBackground: Whether to show a background behind the tooltip. Default: true.

  • backgroundOpacity: Opacity of the background. Default: 0.5.

  • backgroundCornerRadius: Corner radius of the background. Default: 12.0.

  • format: Format of the tooltip text. Supports VTML and variable placeholders. Default: <font align=left>{player-health-current} / {player-health-max}</font><font align=right>({player-health-percent}%)</font>.

  • extraElements: A collection of additional text strings displayed together with the main content. Each element follows the same format as format. This property is optional and omitted by default — you can add it manually if needed.

  • fontSize: Font size of the tooltip text in pixels. Default: 14.0.

satietyTooltip — Configuration for the satiety tooltip.

  • enable: Whether to show the satiety tooltip. Default: true.

  • dialogArea: The dialog area anchor for the tooltip. Default: CenterBottom.

  • height: Height of the tooltip in pixels. Default: 25.0.

  • width: Width of the tooltip in pixels. Default: 144.0.

  • centerText: Whether to center the tooltip text. Default: false.

  • offset: Offset of the tooltip from its default position.

  • x: Horizontal offset. Default: 250.0.

  • y: Vertical offset. Default: -88.0.

  • padding: Padding of the tooltip content.

  • top: Top padding. Default: 0.0.

  • right: Right padding. Default: 9.0.

  • bottom: Bottom padding. Default: 0.0.

  • left: Left padding. Default: 9.0.

  • hasBackground: Whether to show a background behind the tooltip. Default: true.

  • backgroundOpacity: Opacity of the background. Default: 0.5.

  • backgroundCornerRadius: Corner radius of the background. Default: 12.0.

  • format: Format of the tooltip text. Supports VTML and variable placeholders. Default: <font align=left>{player-satiety-current} / {player-satiety-max}</font><font align=right>({player-satiety-percent}%)</font>.

  • extraElements: A collection of additional text strings displayed together with the main content. Each string follows the same format as format. This property is optional and omitted by default — you can add it manually if needed.

  • fontSize: Font size of the tooltip text in pixels. Default: 14.0.

hungerTooltip — Configuration for the hunger rate tooltip. Disabled by default.

  • enable: Whether to show the hunger tooltip. Default: false.

  • dialogArea: The dialog area anchor for the tooltip. Default: CenterBottom.

  • height: Height of the tooltip in pixels. Default: 25.0.

  • width: Width of the tooltip in pixels. Default: 56.0.

  • centerText: Whether to center the tooltip text. Default: true.

  • offset: Offset of the tooltip from its default position.

  • x: Horizontal offset. Default: 356.0.

  • y: Vertical offset. Default: -88.0.

  • padding: Padding of the tooltip content.

  • top: Top padding. Default: 0.0.

  • right: Right padding. Default: 9.0.

  • bottom: Bottom padding. Default: 0.0.

  • left: Left padding. Default: 9.0.

  • hasBackground: Whether to show a background behind the tooltip. Default: true.

  • backgroundOpacity: Opacity of the background. Default: 0.5.

  • backgroundCornerRadius: Corner radius of the background. Default: 12.0.

  • format: Format of the tooltip text. Supports VTML and variable placeholders. Default: {player-satiety-hunger}%.

  • extraElements: A collection of additional text strings displayed together with the main content. Each string follows the same format as format. This property is optional and omitted by default — you can add it manually if needed.

  • fontSize: Font size of the tooltip text in pixels. Default: 14.0.

temporalStabilityTooltip — Configuration for the temporal stability tooltip. Disabled by default.

  • enable: Whether to show the temporal stability tooltip. Default: false.

  • dialogArea: The dialog area anchor for the tooltip. Default: CenterBottom.

  • height: Height of the tooltip in pixels. Default: 25.0.

  • width: Width of the tooltip in pixels. Default: 120.0.

  • centerText: Whether to center the tooltip text. Default: false.

  • offset: Offset of the tooltip from its default position.

  • x: Horizontal offset. Default: 0.0.

  • y: Vertical offset. Default: -60.0.

  • padding: Padding of the tooltip content.

  • top: Top padding. Default: 0.0.

  • right: Right padding. Default: 9.0.

  • bottom: Bottom padding. Default: 0.0.

  • left: Left padding. Default: 9.0.

  • hasBackground: Whether to show a background behind the tooltip. Default: true.

  • backgroundOpacity: Opacity of the background. Default: 0.85.

  • backgroundCornerRadius: Corner radius of the background. Default: 12.0.

  • format: Format of the tooltip text. Supports VTML and variable placeholders. Default: <font align=left>{player-temporal-stability}%</font><font align=right>({player-location-temporal-stability}%)</font>.

  • extraElements: A collection of additional text strings displayed together with the main content. Each string follows the same format as format. This property is optional and omitted by default — you can add it manually if needed.

  • fontSize: Font size of the tooltip text in pixels. Default: 14.0.

customTooltips — An array of custom tooltip configurations.

Each entry supports the same properties as the built-in tooltips above. Default: [].

quickSearch — Configuration for the quick search feature.

  • enable: Whether to enable the quick search feature. Default: true.

  • resultListHeight: The height of the quick search result list in pixels. Default: 200.

Variable placeholders

These placeholders can be used in any tooltip format string.

Placeholders also support .NET format strings, specified after a colon (e.g. {world-date-time:HH:mm}).

Player Status
Health

  • {player-health-current} - Player’s current health.

  • {player-health-max} - Player’s maximum health.

  • {player-health-percent} - Player’s current health as a percentage of maximum health.

Satiety

  • {player-satiety-current} - Player’s current satiety.

  • {player-satiety-max} - Player’s maximum satiety.

  • {player-satiety-percent} - Player’s current satiety as a percentage of maximum satiety.

  • {player-satiety-hunger} - Player’s current hunger rate.

Temporal stability
  • {player-temporal-stability} - Player’s current temporal stability level.
Player Location

  • {player-location-coordinates} - Player’s current coordinates (X, Y, Z).

  • {player-location-coordinates-x} - Player’s current X coordinate.

  • {player-location-coordinates-y} - Player’s current Y coordinate.

  • {player-location-coordinates-z} - Player’s current Z coordinate.

Temperature

  • {player-location-temperature-celsius} - Current temperature at the player’s location in Celsius.

  • {player-location-temperature-fahrenheit} - Current temperature at the player’s location in Fahrenheit.

Average conditions

  • {player-location-average-yearly-temperature-celsius} - Average yearly temperature at the player’s location in Celsius.

  • {player-location-average-yearly-temperature-fahrenheit} - Average yearly temperature at the player’s location in Fahrenheit.

  • {player-location-average-precipitation-precent} - Average precipitation at the player’s location.

  • {player-location-average-forestation-percent} - Average forestation at the player’s location.

  • {player-location-average-shrubbery-percent} - Average shrubbery at the player’s location.

Temporal stability
  • {player-location-temporal-stability} - Temporal stability at the player’s location.
World Status
Current time
  • {world-date-time} - Current in-game world date and time.