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

Room Window

Displays current room information: name, description, objects, players, and exits.

Basic Usage

[[windows]]
name = "room"
widget_type = "room"
row = 0
col = 0
rows = 10
cols = 50

Properties

PropertyTypeDefaultDescription
show_namebooltrueShow room name
show_descbooltrueShow description
show_objsbooltrueShow objects/creatures
show_playersbooltrueShow other players
show_exitsbooltrueShow obvious exits

Examples

Full Room Display

[[windows]]
name = "room"
widget_type = "room"
rows = 12
cols = 60
show_name = true
show_desc = true
show_objs = true
show_players = true
show_exits = true

Compact (Name + Exits Only)

[[windows]]
name = "room"
widget_type = "room"
rows = 3
cols = 40
show_name = true
show_desc = false
show_objs = false
show_players = false
show_exits = true

Description Only

[[windows]]
name = "room"
widget_type = "room"
rows = 8
cols = 50
show_name = true
show_desc = true
show_objs = false
show_players = false
show_exits = false

Display

┌─ Town Square ─────────────────────────┐
│ The center of town bustles with       │
│ activity. A large fountain dominates  │
│ the square.                           │
│                                       │
│ You also see a town guard.            │
│ Also here: Adventurer, Merchant       │
│ Obvious exits: north, east, south     │
└───────────────────────────────────────┘

Interaction

  • Click creature/player names to interact
  • Right-click for context menu