Web Analytics Made Easy - Statcounter
Skip to content

Installation of SDK#

Download SAMSON SDK#

Any user can become a developer. You can start right away by downloading the SDK from the Download page on SAMSON Connect - click Download the SAMSON SDK after signing in. The SAMSON SDK key required to install the SAMSON SDK is shown on the download page, and you can also access your keys in your account on SAMSON Connect.

Requirements#

A 64-bit architecture with a 64-bit operating system:

  • Windows 11, Windows 10.
  • Linux: Ubuntu 22.04 and newer, CentOS, and other similar Linux OS.
  • Mac OS (64-bit Intel and ARM): Sequoia (macOS 15), Sonoma (macOS 14), Ventura (macOS 13), Monterey (macOS 12).

Installation on older operating system versions has not been tested. If you experience any installation problems, please check the SAMSON Connect Forum.

First, you need to install SAMSON. If SAMSON is not installed, please refer to Installing SAMSON first. If you already have SAMSON, follow the steps in this installation guide.

For other versions of the SAMSON SDK, check the requirements here: all versions.

Requirements on Windows#

  • A compatible compiler: Visual Studio 2026 Community or Professional or an older version (VS 2022). SAMSON and SAMSON Extensions distributed on SAMSON Connect are built with Visual Studio 2022 for compatibility reasons.
  • IDE: Visual Studio 2026 Community or Professional or an older version (VS 2022).
  • CMake (v4.0 or newer). The SAMSON SDK uses CMake to easily and portably generate projects for development environments. During CMake installation, make sure CMake is added to the Path environment variable. If you did not add it during installation, you can provide the path to cmake.exe when using it - by default, this should be C:\Program Files\CMake\bin\cmake.exe.

  • Qt 6.10.2 for 64-bit architecture. Download the Qt installer from https://www.qt.io/get-started and choose to install Qt 6.10.2 and Qt Creator.

    You can add a path to your Qt6 dir in your environment variables (e.g.: QT6_DIR=C:/Qt/6.10.2/msvc2022_64), or provide it when generating a project for Visual Studio.

Requirements on Linux#

  • A compatible compiler: gcc/g++ v.5.4+
  • CMake (v4.0 or newer). The SAMSON SDK uses CMake to easily and portably generate projects for development environments. If you installed CMake not via the repository but from sources you will need to add the path to your CMake installation to your PATH environment variable.
  • Qt 6.10.2 for 64-bit architecture. Download the Qt installer from https://www.qt.io/get-started and choose to install Qt 6.10.2 and Qt Creator.
  • IDE: Qt Creator (should be available when you install Qt) or any IDE you prefer.

Requirements on macOS#

  • A compatible compiler: CLang compiler (available when you install XCode)
  • CMake (v4.0 or newer). The SAMSON SDK uses CMake to easily and portably generate projects for development environments. If you installed CMake not via the repository but from sources you will need to add the path to your CMake installation to your PATH environment variable.

  • Qt 6.10.2 for 64-bit architecture. Download the Qt installer from https://www.qt.io/get-started and choose to install Qt 6.10.2 and Qt Creator.

    Add the path to the macos/lib folder in your Qt installation to the DYLD_FRAMEWORK_PATH environment variable. Define an environment variable called QT6_DIR and set it to the path to your Qt/6.10.2/macos folder in your Qt installation. To do this, open the .zprofile file or the .bash_profile file (depending on your macOS version) in your user directory and add the following lines:

    export QT6_DIR=/home/Users/<username>/Qt/6.10.2/macos
export DYLD_FRAMEWORK_PATH=/home/Users/<username>/Qt/6.10.2/macos/lib:$DYLD_FRAMEWORK_PATH

    If the Debug version of the Qt framework is used in the Debug mode, then you might also need to add the following line (see: Debugging Techniques: With Frameworks):

    export DYLD_IMAGE_SUFFIX=_debug

  • IDE: Qt Creator (should be available when you install Qt) or XCode.

Installation steps#

The SAMSON SDK installation procedure consists of the following steps described below.

Step 1: Downloading SAMSON SDK#

Sign in to the SAMSON Connect, go to the Download page, and click on Download the SAMSON SDK.

Developer key#

During the installation of the SDK, you will be asked to provide your personal developer key - you should see it next to the download button and you can always check it on your account page.

Note

The developer key is your personal key and should not be shared with others.

Step 2: Installing SAMSON SDK#

Once you have downloaded the SAMSON SDK and prepared your environment as indicated in the Requirements section, you can launch the installer. You can specify the location where SAMSON SDK will be installed during the installation procedure by choosing the "Advanced mode".

Installing on Windows#

Double-click on the executable file and follow the installation steps.

By default, the SDK is installed into C:\Users\%USERNAME%\OneAngstrom folder. You can change this location during installation by choosing "Advanced mode". Inside this folder, you will find a subfolder corresponding to the version of the SDK (e.g., 11.0.0).

SAMSON SDK Installation

Installing on Linux#

  1. Open the terminal and go to the folder where SAMSON SDK installer was saved:

    cd ~/Downloads/

  2. Make the installer executable:

    chmod +x SAMSON-Developer-Setup.run

  3. Run the installer (do not use sudo here):

    ./SAMSON-Developer-Setup.run

  4. Follow the installation steps.

Installing on macOS#

  1. Double-click the downloaded SAMSON-Developer-Setup.dmg file to make its contents available. A new window opens and shows the contents of the .dmg file, which should include SAMSON-Developer-Setup.app. Double-click SAMSON-Developer-Setup.app. When the security notification appears, press Open.
  2. Follow the installation steps.
  3. After the installation is done you may eject the .dmg by clicking the eject button in the Finder's sidebar.

The SAMSON SDK is installed by default in the $HOME/OneAngstrom/SAMSON-Sdks/ folder.

Step 3: Running SAMSON Debug#

Once the SAMSON SDK installation is finished, there are some final things to do depending on your OS platform. If you experience any problems please check the SAMSON Connect Forum.

Running on Windows#

By default, SAMSON and its SDK are installed in the C:\Users\%USERNAME%\OneAngstrom folder (referred to below as SDK_PATH).

  • Go to SDK_PATH\SAMSON-Sdks\11.0.0\SAMSON-Debug\Binaries.
  • Double-click SAMSON-Core.exe or SAMSON-Core-Console.exe; this should launch the developer version of SAMSON.

Running on Linux#

By default, SAMSON and its SDK are installed in the $HOME/OneAngstrom folder (referred to below as SDK_PATH).

  • Go to SDK_PATH/SAMSON-Sdks/11.0.0/SAMSON-Debug/Binaries.
  • Open and edit the SAMSON-Core.sh file. You need to provide the path to Qt installed on your system; modify the following line:
export LD_LIBRARY_PATH=YourQtPath/Qt/6.10.2/gcc_64/lib:$script_dir:$LD_LIBRARY_PATH

Save the file.

  • To launch the developer version of SAMSON, open a terminal in this folder and execute
./SAMSON-Core.sh

You may also need to make executable the following files placed in SDK_PATH/SAMSON-Sdks/11.0.0/SAMSON-Debug/Binaries: SAMSON-Core.sh and SAMSON-Core:

cd SDK_PATH/SAMSON-Sdks/11.0.0/SAMSON-Debug/Binaries
ls -la | grep "SAMSON-Core"
chmod +x SAMSON-Core*

For an easy launch (in terminal, from any folder), you may create an alias in your .bashrc file:

alias samson-debug='SDK_PATH/SAMSON-Sdks/11.0.0/SAMSON-Debug/Binaries/SAMSON-Core.sh'

Running on macOS#

To launch the developer version of SAMSON, open a terminal and go to the ~/OneAngstrom/SAMSON-Sdks/11.0.0/SAMSON-Debug/Binaries folder

cd ~/OneAngstrom/SAMSON-Sdks/11.0.0/SAMSON-Debug/Binaries
./SAMSON-Core

You may also need to make executable the following files placed in ~/OneAngstrom/SAMSON-Sdks/11.0.0/SAMSON-Debug/Binaries: SAMSON-Core-Console and SAMSON-Core:

cd ~/OneAngstrom/SAMSON-Sdks/11.0.0/SAMSON-Debug/Binaries
ls -la | grep "SAMSON-Core"
chmod +x SAMSON-Core*

What's next?#

After you have installed SAMSON SDK, you can start developing your SAMSON Extensions, in particular thanks to the SAMSON Extension Generator.

Check out the following tutorials: