Getting Started

The editor has three parts: screens, pages and widgets on the left, your screen in the middle, and settings for whatever is selected on the right.

Language

On first start, FrameDeck asks which language to use: English, 简体中文 or 繁體中文. Change it any time in Settings → Language. The editor, guides, display page and menus follow it; the text on your screens is whatever you type.

Screens

A screen is one physical display. Under Screens, click + Add and pick a size, or choose one of your connected displays to match it pixel for pixel. When you plug in a new monitor, FrameDeck offers to make a screen for it.

Each screen has a shape (rectangle or round), colors (full color, or a limited e-ink palette) and a block size, which sets how fine the grid is. Smaller blocks let you place widgets more precisely.

Pages

Each screen can rotate through several pages. Turn on Rotate through pages and set how long each page shows (Show for). Under Pages → + Add, choose a Preset page laid out for this screen, or a Custom blank page or copy. See Page Presets and Sharing.

Widgets

Click a widget to add it, or drag it onto the screen. Then:

Action	How
Move	Drag the widget
Resize	Drag the handles
Nudge	Arrow keys
Resize by one block	Shift + arrow keys
Delete	⌫ (Backspace)
Duplicate	⌘D / Ctrl+D
Undo / redo	⌘Z / Ctrl+Z, ⇧⌘Z

Select a widget to change its settings on the right. See Widgets for the full list, or Writing Widgets to make your own.

Look

Themes, colors, font, card style, corner roundness and spacing are under Look in the right panel when no widget is selected. E-ink screens only offer colors the panel can show. Some extra themes are a thank-you for supporters: see Supporting FrameDeck.

Showing a screen

Click Show on a display (top right):

• Fullscreen on any connected monitor. See Monitors.
• In a window, which keeps the screen's shape when resized.
• As a link for a browser on this computer or, with network sharing on, on other devices. See Tablets and Phones, NZXT Kraken LCD and Raspberry Pi and Kiosks.

In a display: ← → change page, Esc closes it, double-click toggles fullscreen. On touch screens, tap the left or right edge to change page.

Settings

• Share displays on my network: lets phones, tablets and other computers on your Wi-Fi open display links. The editor only ever opens on the computer FrameDeck runs on. See Network Sharing and Security.
• Open FrameDeck when I log in (Mac and Windows): displays that were showing when you quit open again automatically, so a spare monitor works like a picture frame.

Back up and share

Export layout (right panel) saves a screen as a .framedeck.json file you can back up or share, and Import layout brings one back. Your own widgets are included.