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

Command Reference

Anything you type starting with . is handled by VellumFE instead of being sent to the game. Command names are case-insensitive; Tab completes them. .help prints an abbreviated version of this list in-game. Unknown commands print a hint.

Everything else you type goes to the game unchanged. (Typing the game command quit also saves your settings on the way out.)

General

CommandAliasesDescription
.help.h, .?List all commands
.version.verShow VellumFE version
.quit.qExit VellumFE (saves settings)
.menuOpen the main menu
.settingsOpen the settings editor
.reload [what]Reload config from disk: highlights, keybinds, hotbars, settings, colors, layout, or everything
.roomShow how the current room resolved against the map database (stream ids, mapdb room/location, routable exits, tags) — for debugging the map and pathing
.mapdb [download|remove|repo <r>]Manage downloaded map data from any frontend (no args = status). On phones this is the way to fetch the map — there’s no Settings > Map panel there
.go2 <target>Native map travel: room id, uid (u7150105), tag (bank), saved name, or text search — see the Travel chapter
.go2 stop / .go2 statusCancel / show the active trip
.go2 save <name> [id]Save a travel target (.go2 targets lists them, .go2 back returns to the trip start)
.portal [n|word]Walk the room’s non-compass exit (go door, climb stair, …) from the map data (room objects as fallback). One candidate walks it; several open a picker menu (keyboard/pad navigable) — or pick by number or word. Controller d-pad left by default
.foreach ... in <bag>; cmd; cmdRun commands over matching container items (native ;foreach). No commands = dry-run list. See Inventory Tools
.sorter [on|off]Categorize “look in container” output by item type (native ;sorter). No arg toggles
.stopStop whatever automation is driving — a .go2 trip or a .foreach run
.data [status|reload]Inspect / refresh the shared item database used by .foreach and .sorter (Lich folder → local → bundled)

Windows & Layout

CommandAliasesDescription
.windowsList all windows
.addwindow [name type x y w [h]]Add a window (no args opens a picker)
.deletewindow <name>.delwindowHide a window (kept in the layout; in the GUI, Delete Window in the right-click menu’s Window ▸ Advanced removes it for real)
.editwindow [name].editwinEdit a window — TUI: opens its window editor; GUI: opens its right-click menu (no name: TUI picker / GUI Windows catalog)
.hidewindow [name].hidewinHide a window
.rename <window> <new title>Rename a window’s title
.border <window> <style> [color]Set border sides: all, none, top, bottom, left, right
.lockwindows.lockall, .unlockwindows, .unlockallToggle move/resize lock on all windows
.performance [dump].perfToggle the performance monitor; dump writes a diagnostic report file
.savelayout [name]Save the current layout under a name in the shared ~/.vellum-fe/layouts/ folder, loadable by any character (each frontend has its own format: TUI .toml grids, GUI .json checkpoints)
.loadlayout <name>Load a saved layout; in the GUI it applies live to the running session
.layoutsList saved layouts for this frontend
.resizeRefit layout to the current terminal size (TUI)
.nexttab / .prevtabSwitch tabs in a tabbed window
.gonew.nextunreadJump to the next tab with unread messages
.streamsOpen the stream routing editor: every known stream and where it goes (a window, main, or discard)

Sharing Your UI

CommandAliasesDescription
.packs.packeditorOpen the pack editor panel (TUI and GUI): pick parts with checkboxes, export to a folder of your choice, and import from ~/.vellum-fe/imports/ (a dropdown lists any .vellumpack you drop there) or a pasted path, with a preview and per-part install selection.
.uiexport <name> [parts...]Bundle the files that make your UI into ~/.vellum-fe/exports/<name>.vellumpack — a single shareable file. Parts: layout (TUI grid + the GUI’s live arrangement when exported from the GUI), highlights, keybinds, controller, hotbars, colors, macros, skin (the active skin’s whole folder), theme (the active theme, including its file for custom themes), sounds (the shared sound folder), quickbars, and settings (general settings: UI options, sound/TTS prefs, stream routes — never connection or account data). Default: all. Connection settings and passwords are never included.
.uiimport <name|file>Preview a pack: its parts, skin, theme, and file count. Names resolve from ~/.vellum-fe/imports/ and exports/.
.uiimport <name|file> apply [parts...]Install a pack (optionally only the listed parts): replaced files are backed up to ~/.vellum-fe/backups/, everything hot-reloads, and layouts land as named checkpoints (.loadlayout <packname>). Skins and themes activate; quickbars and settings merge into your config without touching connection data. Unknown or unsafe entries in a pack are skipped, never written.

Post packs in the community Discord — favorites can become shipped default layouts.

Highlights

CommandAliasesDescription
.highlights.hlBrowse highlights
.addhighlight.addhlCreate a highlight
.edithighlight [name].edithlEdit a highlight
.testline <text>Inject a fake game line to test patterns
.savehighlights [name].savehlSave highlights as a named profile
.loadhighlights [name].loadhlLoad a highlight profile
.highlightprofiles.hlprofilesList highlight profiles

Keybinds

CommandAliasesDescription
.keybinds.kbBrowse keybinds (press f to cycle the scope filter: all / global / character)
.controllerEdit gamepad button bindings (GUI; see Controllers)
.addkeybind.addkeyCreate a keybind
.savekeybinds [name].savekbSave keybinds as a named profile
.loadkeybinds <name>.loadkbLoad a keybind profile
.keybindprofiles.kbprofilesList keybind profiles

Hotbars

CommandAliasesDescription
.hotbars.hotbarOpen the hotbar editor (bars of command buttons; see Hotbars)

Colors & Themes

CommandAliasesDescription
.themesBrowse and apply themes
.settheme <name>.themeSwitch theme by name
.editthemeEdit the current theme
.skinsList installed GUI skins
.setskin <name>.skinApply a skin (.setskin none disables; GUI only)
.makeskin <name>Create a starter skin to edit
.reloadskinForce-reload the active skin (after editing images)
.colors.colorpaletteBrowse the color palette
.addcolor.createcolorAdd a palette color
.uicolorsEdit UI element colors
.spellcolorsEdit spell-circle colors
.addspellcolor.newspellcolorAdd a spell color entry
.setpaletteLoad palette into terminal slots (TUI, 256-color mode)
.resetpaletteReset the terminal palette (TUI)
.harmony [scheme]Generate the game-text preset colors from the active theme (.harmony schemes lists the schemes; the GUI Colors editor’s Generate tab adds seed swatches, pins, and a live preview)
.harmony skin <name>Write a matching skin — panel backgrounds and nine-slice frames rendered from the same harmony — to global/skins/<name>/; activate with .setskin <name> (GUI)

Text-to-Speech

.tts with no subcommand shows status. Settings changes save immediately. The GUI has the same controls in Settings > Speech; per-window speech is the “speak new lines” checkbox in the window’s right-click menu (tts_speak in layout.toml).

CommandDescription
.tts on / .tts offEnable / disable text-to-speech
.tts muteToggle mute without turning TTS off
.tts rate <0.5-3.0>Speech rate (1.0 = normal)
.tts volume <0.0-1.0>Speech volume
.tts voice <name|default>Pick a voice by name, or return to the engine default
.tts voicesList available voices
.tts testSpeak a sample line
.tts clearClear the pending speech queue
.tts statusShow enabled/muted state, rate, volume, voice, and queue depth

Misc

CommandAliasesDescription
.transparentToggle transparent window backgrounds (TUI)
.hidecontainers [title]Close container windows (all, or one by title)
.reloadmacrosReload macros.toml and push to connected phones
.webinfoShow the phone pairing URL / app link and open their QR codes
.webui [page|off]Lich WebUI panels (GUI, Lich 5.18+): no args picks from Lich’s registered pages, a name opens that page, off disconnects