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

Compass

Displays available room exits with directional arrows.

Basic Usage

[[windows]]
name = "compass"
widget_type = "compass"
row = 0
col = 0
rows = 3
cols = 7

Properties

PropertyTypeDefaultDescription
stylestring"arrows"Display style

Size Requirements

  • Minimum: 3 rows × 7 columns
  • Recommended: 3×7 or 5×9

Display

  N
W ◆ E
  S
  • Available exits shown with arrows
  • Unavailable directions dimmed
  • Supports all 10 directions: N, S, E, W, NE, NW, SE, SW, Up, Down, Out

Example

[[windows]]
name = "compass"
widget_type = "compass"
row = 0
col = 0
rows = 3
cols = 7
show_border = true
border_style = "rounded"