Skip to content

Sharing Projects

Jump to bottom
Bobby Comet edited this page Jul 31, 2026 · 2 revisions

Sharing Projects & JSON

Conky Studio separates editable source (project JSON) from runnable output (built theme folder). Mixing them up is the most common sharing mistake.

Two artifacts

1. Project JSON

  • Saved via Project → Save Project…
  • Reconstructs the node graph in Studio (nodes, edges, props, canvas settings, groups/labels when present)
  • Not a self-contained runtime theme
  • Best for collaboration and remixing inside Conky Studio

2. Built theme folder

Produced by Build to Folder or Build & Install:

<ThemeName>/
├── theme.json
├── start.sh
├── conky.conf
├── render.lua
├── images/
├── fonts/
├── scripts/
├── .runtime-cache/   # created at runtime
├── preview.png       # when available
└── README.md
  • Runs with Conky only (no Studio required)
  • Standardized start.sh handles startup, optional background pollers, and single-instance locking
  • Themes keep running after you quit Conky Studio

What breaks when you only send JSON

Issue What goes wrong What to do
Image / script paths Props often store absolute paths from the author’s machine Ship assets with the JSON; re-link paths; prefer paths relative to the theme after build
Plugin node types logic.* / visual.plugin.* missing on the other PC Install the same plugin packs; see Plugins
Custom Script / Custom Lua files Graph references files that were only on disk locally Include those .sh / .lua files in the share
Hardware / OS GPU source, iface name, weather keys differ Recipient adjusts sources; non-fatal empty readings are normal
Studio version Newer node types unknown in older Studio Upgrade Studio to a matching or newer build

Practical guidance

Goal Send
Run only Built theme folder (zip of the export is fine)
Edit in Studio Project JSON + images/ / scripts + required plugins
Public / store Built package as the primary download; optional JSON for remixers

Compatibility checklist before you share a graph

  1. Rename the HUD to something unique.
  2. Prefer Build once yourself and confirm Manager can Start it.
  3. List required plugins (or bundle pack names/URLs in the README).
  4. Replace absolute asset paths or include the files.
  5. Note the minimum Studio version if you used very new node types.

theme.json and README

Manager can generate and edit theme.json (name, author, version, description, resolution) and README for installed themes. Useful metadata for humans and for store-style listings, still secondary to a working start.sh + conf + Lua.

Clone this wiki locally