Skip to content

Scripting

TaskManSync scripting uses Lua to create dynamic Decorations, interactive TaskManSync-owned windows, and selected file, process, HTTP, system-information, and generated-sound workflows.

For most users, the important distinction is simple:

  • TDML describes how Decoration text looks.
  • Lua provides the logic that decides what the Decoration displays and when it changes.
  • A Scripted Decoration is still a Decoration in the TaskManSync workspace. Its script does not become a second taskbar, task-order system, or general-purpose Plasma/QML scripting environment.

The Scripting documentation is organized as a practical guide first and a reference second. You can read the first few pages to create a script, then use the API tables when you need to look up a particular property or function.

  • Getting Started: create, import, edit, save, reload, and place a script.
  • Scripted Decorations: taskbar TDML, layout, updates, clicks, positioned text, and graphics.
  • Script-Created Windows: interactive content, visibility, callbacks, and lifecycle.
  • Concepts: persistent storage, metadata, scheduling, troubleshooting, and trusted-code boundaries.
  • API Reference: General, Decorations, UI, and Desktop calls and limits.
  • Sound: tones, notes, sequences, ABC scores, and runtime-scoped stopping.
  • Examples: export the catalog and choose a practical starting point.

Only one active applet runs a placed Scripted Decoration; other applets show its shared taskbar result. Scripts are trusted local-user code, not a security sandbox: inspect file, command, and network effects before importing them. They do not receive arbitrary application-task, Qt, QML, Plasma, or database objects.