Getting Started

Getting Started

What you need

• A Linux desktop where Conky can run (X11 is the most predictable; Wayland depends on the compositor; see Troubleshooting)
• Conky Studio itself (AppImage, no sudo/no package manager required for Studio)
• Optional but useful: playerctl (music), lm-sensors (temps), a Conky build with Wayland support if you are on Wayland

You must first install Conky, if not already installed. Check Conky's installation guide for your distro's method of installation.

playerctl

(CLI tool to control MPRIS-compatible media players)

Distro	Command
Debian/Ubuntu/Mint/Pop!_OS/MX	sudo apt update && sudo apt install playerctl
Fedora	sudo dnf install playerctl
Arch/Manjaro	sudo pacman -S playerctl
openSUSE	sudo zypper install playerctl
Alpine	sudo apk add playerctl
Gentoo	sudo emerge media-sound/playerctl
Void	sudo xbps-install -S playerctl
Nix	nix profile install nixpkgs#playerctl

lm-sensors

(Hardware monitoring tools for temperatures, voltages, fans, etc.)

Distro	Command
Debian/Ubuntu/Mint/Pop!_OS/MX	sudo apt update && sudo apt install lm-sensors
Fedora/RHEL/CentOS/Rocky/Alma	sudo dnf install lm_sensors
Arch/Manjaro	sudo pacman -S lm_sensors
openSUSE	sudo zypper install sensors
Alpine	sudo apk add lm-sensors
Gentoo	sudo emerge sys-apps/lm-sensors
Void	sudo xbps-install -S lm_sensors
Nix	nix profile install nixpkgs#lm_sensors

Notes:

• Package name is usually lm-sensors on Debian-based systems and lm_sensors (underscore) on Fedora/Arch/etc.
• After installing lm-sensors, run sudo sensors-detect (answer the prompts; usually safe defaults are fine) and then sensors to view readings. You may also need to load kernel modules.
• On very old Ubuntu/Debian versions, playerctl might not be in the default repos (it’s been available since ~Ubuntu 20.04/Debian 10+).

Easiest way to open Conky Studio

• Go to the GitHub page
• Click “Releases” (on the right side of the page)
• Download the file that ends in .AppImage (It will be named something like Conky-Studio-1.0.7.4_x86_64.AppImage)

Then do this: Open a terminal in the folder where you downloaded it and run:

chmod +x Conky-Studio-1.0.7.4_x86_64.AppImage
./Conky-Studio-1.0.7.4_x86x_64.AppImage

That’s it, no install needed; it will just open like a normal app.

Tip (optional, easier way)

If you don’t like using the terminal:

• Right-click the .AppImage file
• Go to Properties, go to Permissions
• Check “Allow executing file as program”
• Double-click (or single-click depending on DE) the file

First launch

1. Open Conky Studio.
2. You may see the Theme Wizard (category, resolution, panels). Create a starter HUD or skip to a blank canvas. You can opt out of showing the wizard on every launch.
3. Switch to the Studio tab if you are not already there.
4. Optional: Help → Learn Studio… for a guided tour of the UI. Help → Getting Started for the in-app text guide.

Rename the HUD early (name field at the top of Studio). That name becomes the folder under ~/.config/conky/ when you Build & Install.

Your first widget (~30 seconds)

1. From the Nodes palette (left), drag a Source (e.g. CPU %).
2. Drag a Visual (e.g., Arc/Ring Gauge or Bar).
3. Drag from the source’s output socket (right side of the node) to the visual’s input (left side of a property row).
4. Select the visual; set position/size/color in Properties.
5. Use Live Preview → Start to run a real Conky process.
6. When happy: Project → Build & Install to Manager, then open the Manager tab and Start the theme.

Data flow is always:

Source  →  (optional Logic)  →  Visual

If a property has no wire, the constant in the property panel is used.

The three tabs

Tab	Role
Manager	Installed themes under ~/.config/conky/ (and related paths). Start/stop, README/ theme.json, drop-in folders
Studio	Node editor: palette, canvas, properties, layers, live preview
Store	Community themes/assets when a source is configured (see Store & Community)

Studio layout

Area	Purpose
HUD name	Project/install folder name
Nodes palette	Sources, Logic, Visuals, plugins; drag or double-click to add
Canvas	Graph editor (not the desktop HUD). Pan empty space; Ctrl+scroll zoom; Shift+drag multi-select; Delete removes selection; right-click for group/label actions
Properties	All fields for the selected node; bindable rows accept wires
Layers	Visual nodes only — draw order, visibility (eye), lock
Live Preview	Start/stop a real Conky using generated files

Canvas size = workable resolution

Select the Canvas node. Width and height are the HUD’s drawable size (e.g., 460×1080 side panel or 1920×1080 overlay). Alignment and gap_x/gap_y place that window on the desktop. Changing size does not auto-rescale existing visuals; reposition after you change resolution.

Build options

Menu	Result
Project → Build to Folder	Writes a theme directory you choose
Project → Build & Install to Manager	Writes under ~/.config/conky/<name>/ and lists it in Manager
Project → New HUD	Theme Wizard starter
Project → New Blank HUD	Empty graph + Canvas node
Project → Import Legacy Theme	See Legacy Import

Suggested learning path

1. Run the wizard once and press Start in preview.
2. Change one color and one position; preview again.
3. Break a wire and reconnect it.
4. Insert a Logic node (e.g., smooth or threshold) between the source and the visual.
5. Build & Install, launch from Manager.
6. Skim Sharing Projects before you send a project to someone else.

More detail: in-app Help → Getting Started… and Help → Learn Studio…. Full capability list: Features.