Open-Source Desktop Client Overview

Open-Source Desktop Client allows developers to create an identical Desktop Client to the official version from Nx Meta or their OEM, modify the UI to satisfy unique project requirements or create an entirely new client experience or even a new product.

Supported Platforms

Open-Source Desktop Client can be built on the following platforms:

HOST	TARGET
Windows 10 (x64)	Windows x64
Ubuntu Linux x64 18.04 and 20.04	Ubuntu Linux x64 ARM 64 (cross-compilation). Proven to work on NVidia® Tegra®
MacOS ARM_64 (M1, M2) 11 (Big Sur) 12 (Monterey)	MacOS ARM_64 MacOS x64 (cross-compilation)
MacOS x64 (older MACs) 11 (Big Sur) 12 (Monterey)	MacOS x64 MacOS ARM_64 (cross-compilation)

It may be possible to build on and for other platforms, but we do not guarantee the result and do not provide support in these cases.

Prerequisites

The following things are required to build and run Open-Source Desktop Client: a customization package and the sources from the repository:

Customization Package that contains all the needed branding information: software name, logos, images, support links, etc. See "Obtaining Customization Package for the Open Source Desktop Client".
Sources can be downloaded using the command:

git clone https://github.com/networkoptix/nx_open

See "Obtaining Sources from Open-Source Repositories" for detailed instructions. To update to the specific branch (see "Open Source Desktop Client Versioning") use:

git checkout <branch>

Compatible Server to connect to. See “Obtaining a correct Server to run with the Open-Source Desktop Client”.