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

Widgets

Widgets are the visual building blocks of your layout. Each widget type displays specific game information.

Widget Types

TypePurpose
textScrollable game text
tabbedtextMultiple streams in tabs
progressHealth, mana, stamina bars
countdownRoundtime, cast time timers
compassAvailable exits
handItems in hands
indicatorStatus conditions
dashboardMulti-indicator panel
roomRoom name, description, exits
injury_dollBody part injuries
active_effectsBuffs and debuffs
targetsCreatures in room
playersPlayers in room
itemsItems on ground
inventoryCarried items
spellsKnown spells
containerContainer contents

Common Properties

All widgets share these properties:

[[windows]]
name = "my_widget"              # Unique identifier
widget_type = "text"            # Widget type
row = 0                         # Top position
col = 0                         # Left position
rows = 10                       # Height
cols = 40                       # Width
visible = true                  # Show/hide
show_border = true
border_style = "single"         # single, double, rounded, thick
border_color = "#808080"
title = "Custom Title"

Adding Widgets

  1. Via Menu: F1 → Windows → Add Window → [Category] → [Widget]
  2. Via Command: .addwindow widgetname
  3. Via Config: Edit layout.toml directly

Categories

Widgets are organized into categories in the Add Window menu:

CategoryWidgets
Text Windowstext, tabbedtext
Statusprogress, countdown, hand, indicator, dashboard
Navigationcompass, room
Entitytargets, players, items
Listsinventory, spells, container
Otherinjury_doll, active_effects