DockStudio · Quick start

From install to first window — 10 minutes

Four commands, one module class — and an app with docks, tabs and menus is up and running.

Steps

Install and run

1

Installing the SDK

cmake --install build --prefix C:/DockStudio --component SDK
2

Module project from a template

cp -r C:/DockStudio/sdk/template mymodule
3

Building a module

cmake -S mymodule -B build -DCMAKE_PREFIX_PATH="C:/DockStudio/sdk/cmake;<Qt>" && cmake --build build
4

Running

module_mymodule.dll → into the modules/ folder next to DockStudio.exe
documents.cpp
// A module declares everything in one descriptor — the shell builds the UI itself
core::ModuleDescriptor describe()
{
    core::ModuleDescriptor Module;
    Module.Id = QStringLiteral("documents");
    Module.Name = QStringLiteral("Documents");
    Module.Version = QStringLiteral("1.0.0");
    Module.ContractVersion = core::ModuleContractVersion;

    Module.Panels   = { /* document list, viewer */ };
    Module.Commands = { /* "New document", Ctrl+N */ };
    Module.Menus    = { /* menu items */ };
    Module.Themes   = { /* custom themes, if needed */ };

    return Module;
}

REGISTER_MODULE(describe())

// CMakeLists.txt — a single line:
// dockstudio_add_module(documents PLUGIN)

Panels, commands, menus and themes are described in one descriptor. The shell places them in the UI and restores the user's layout on the next launch.

Documentation

What the developer kit includes

API reference

A full description of the core, shell and service interfaces with call examples and common errors.

Project templates

Starters for an app, a module and a plugin: an enterprise workstation app, an engineering tool, a simple viewer.

Debugging tools

A layout inspector, a bus event viewer, a panel profiler and a plugin sandbox.

Learning materials

Step-by-step guides, an SDK video course and walkthroughs of common architectural decisions.

Design kit

Theme tokens, an icon pack, interface density rules and ready-made control styles.

Build and delivery

CI scripts, build signing, installers and an auto-update mechanism for your users.

Video

Tutorial videos

This section is being filled with SDK walkthrough recordings. For now, here is the outline of the upcoming course.

12:30 Coming soon
Development

A module from scratch

From a project template to a working panel in the main window.

7:15 Coming soon
Interface

Workspace layouts

Saving, exporting and distributing layouts to users.

9:40 Coming soon
Appearance

Themes and branding

Restyling the application to match the customer's brand.

All DockStudio videos

Need access to the SDK?

We’ll send the distribution, the documentation and a Community edition key, and run introductory training if needed.