Skip to content

Installation

Already installed the module?

Skip to the next article.

Prerequisites

Qbs

Please, check the official guide.

Apple macOS

This is an obvious limitation: the module works only on macOS as Sketch does too.

Sketch

This module relies on existing Sketch installation on your host system. If you have several versions installed, the first found one will be used.

Download

via Git

git clone https://github.com/GooRoo/qbs-sketch.git
git clone git@github.com:GooRoo/qbs-sketch.git

as archive

Download zip

Add to your project

As you would do with any other 3rdParty module, just add the search path to your project's root qbs-file:

import qbs

Project {
    qbsSearchPaths: [
        '<path/to/qbs-sketch/root/folder>'
    ]

    // ...
}

Use in Qbs

Done with installation?

Congrats! Now, you are able to export assets and metadata from your sketch-files during the Qbs build process. Learn how in the next chapter.