Offer Products Case Studies Expertises About us Contact Blog
FR EN

Deployment

Embed the keyboard in your app: see the Quick Start guide. Package layout, manual copy steps, dictionary licensing, fonts, and other fine-grained options: Advanced deployment.

What you need

A prebuilt LNVK release (plugin + dictionary data). The deploy helpers copy the QML plugin and share/lnvirtualkeyboard/dictionaries/ next to your executable using the default install-prefix layout (bin/, qml/, share/ under one root).

CMake (recommended)

Point LNVK_DIR at the release's integration/ directory (it contains LNVKConfig.cmake), link your app, and call the deploy helper:

cmake_minimum_required(VERSION 3.16)
project(MyApp LANGUAGES CXX)

find_package(Qt6 REQUIRED COMPONENTS Quick)
set(LNVK_DIR "/path/to/LNVK/integration")  # directory containing LNVKConfig.cmake
find_package(LNVK REQUIRED CONFIG)

add_executable(myapp main.cpp)
target_link_libraries(myapp PRIVATE Qt6::Quick)

set_target_properties(myapp PROPERTIES RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin")
ln_virtual_keyboard_deploy(myapp LANGUAGES en fr)

In main.cpp, add the QML import path before engine.load():

engine.addImportPath(QCoreApplication::applicationDirPath() + QStringLiteral("/../qml"));

Configure and build:

cmake -B build -DLNVK_DIR="/path/to/LNVK/integration"
cmake --build build

After build, your output tree looks like:

build/
├── bin/myapp
├── qml/Ln/VirtualKeyboard/    ← plugin + qmldir
└── share/lnvirtualkeyboard/
    └── dictionaries/          ← layouts, themes, IME/prediction data

Run myapp from build/bin/ (or install the whole tree with the same relative paths).

qmake

Add one line to your .pro file:

include(/path/to/LNVK/integration/lnvirtualkeyboard.pri)

Build as usual. The .pri file copies the plugin and dictionaries into your output directory with the same layout as CMake above.

To ship only the languages your app uses:

LNVK_LANGUAGES = en fr
include(/path/to/LNVK/integration/lnvirtualkeyboard.pri)

Yocto

For Yocto images, add the meta-lnvk layer supplied with your release and install packagegroup-lnvk; it installs the plugin, the dictionaries for LNVK_LANGUAGES and the fonts. See Advanced deployment — Yocto (meta-lnvk).

Debian and Ubuntu (.deb)

For Debian- and Ubuntu-based images, install the .deb packages supplied with your release with apt. Pick the plugin package that matches your Qt major version, then one dictionary package per language you ship:

sudo apt install ./lnvk-qt6_*.deb ./lnvk-dict-en_*.deb ./lnvk-dict-fr_*.deb
PackageContents
lnvk-qt5 / lnvk-qt6QML plugin, layouts, themes and licences for Qt 5.15 or Qt 6. Required.
lnvk-dict-<lang>Dictionaries for one language, named after the layout ids (lnvk-dict-en, lnvk-dict-ja, …)
lnvk-fonts-<script>Optional bundled fonts

The plugin installs into the system QML import path, so a QML application finds Ln.VirtualKeyboard without extra configuration.

Next steps

GoalWhere to look
QML properties, profiles, themesQuick Start, Languages, Theming, Configuration
Smaller installs, custom paths, manual copyAdvanced deployment
Dictionary data licensing when redistributing IME/prediction filesAdvanced deployment — Dictionary data
Optional bundled fonts or your own font filesAdvanced deployment — Fonts
Custom .pred dictionariesConfiguration — Custom prediction dictionaries
Yocto images (BitBake layer)Advanced deployment — Yocto (meta-lnvk)
Debian and Ubuntu imagesDebian and Ubuntu (.deb)

Qt version

Use the release build that matches your Qt major version (Qt 5.15 or Qt 6.x).