Appearance
Getting started
Install and launch
Planar is a Tauri desktop app with a Vue frontend and Rust backend. If you want to build the app from source, you will need:
- Node.js 22 or newer.
- Rust 1.77.2 or newer, including
cargo(the recommended installation method is rustup). - CMake 3.14 or newer, required to build the bundled stable-diffusion.cpp dependency.
- The platform prerequisites for Tauri 2, such as Xcode Command Line Tools on macOS or the required WebKitGTK and related packages on Linux. See the Tauri prerequisites for the platform-specific list.
On macOS, Planar requires macOS 13.3 or newer and an SDK 13.3 or newer. Check the active SDK with xcrun --show-sdk-version.
Install the JavaScript dependencies from the repository root, then launch the Tauri shell:
sh
npm install
npm run tauri:devThe first Tauri launch compiles the Rust crates in src-tauri and planar-core and their dependencies from Cargo.lock, so it can take longer than subsequent launches. npm install does not install Rust or native dependencies.
npm run dev starts the web UI by itself. It is useful for inspecting layout, but native file, model, and generation commands need the Tauri shell.
First image
- Open Settings → Models and configure a model root, or use the model manager to download a model.
- Return to the generator and select a checkpoint.
- Choose a resolution and sampler.
- Write a prompt in the prompt column.
- Press Generate. The new result appears in the output gallery and becomes available on the canvas.
The default sampler is Euler A. For repeatable results, set a seed instead of leaving it random.
Before you start
Model files are not bundled with Planar. You need a compatible local checkpoint or a configured Diffusers model before generation can run. Memory use depends heavily on the model, resolution, and backend.
Keep model files on a fast local disk. Generation can be substantially slower when a model is loaded from external or network-backed storage.