Installing and Using the Catapult SDK

Linux installation

Catapult SDK is available as both a DEB package for Ubuntu, and an RPM for CentOS. To install the DEB, use apt:
% sudo apt install catapult-sdk_1.7.1.deb

To install the RPM on CentOS 7, use yum:
% sudo yum localinstall catapult-sdk-1.7.1-1.x86_64.rpm

On CentOS 8 or Fedora 22 and above, use dnf:
% sudo dnf install catapult-sdk-1.7.1-1.x86_64.rpm

To unpack the contents of the RPM to a local directory without needing root privileges, use:
% rpm2cpio catapult-sdk-1.7.1-1.x86_64.rpm | cpio -id

this will extract the SDK into a directory opt/imgtec/catapult-sdk_1.7.1 under the current working directory. Note that this works on Ubuntu as well as CentOS.

Windows installation

To install on Windows, simply double-click the catapult-sdk_setup_win32_x64_1.7.1.exe application and the installer wizard will guide you through the setup process.

You will be given the option to install for all users (that requires administrator privileges) or for just yourself (which does not).

Mac Installation

To allow the install, first go to the Security and Privacy section of System Preferences, General tab, and enable “Allow apps downloaded from Apple and selected developers” (if you haven’t already done that previously). Then simply double-click the installer package and you will be guided through the install process.

The application installs to the /Applications folder by default. Double-clicking the installed application brings up the Catapult Studio IDE. The welcome page contains links to toolkit documentation.

Apple’s XCode command-line developer tools are a requirement for using the toolkit. If you don’t already have these installed on your system, the installer will prompt to offer to install them.

User Documentation

Full details on how to build and debug code using either the command line or the Catapult Studio IDE are to be found in the user documentation which can be accessed in 2 ways:

    • With Catapult Studio, select Help→Get Started, then click the link for the Catapult SDK Documentation.  Alternatively, you can select “Catapult: Open SDK Documentation” from the command palette (CTRL-P, or CMD-P on Mac).
    • Outside of Catapult Studio, on MacOS or Linux click the docs link under catapult-sdk_examples/{version} in your home area.  On windows, click index.html in the docs directory of the toolkit installation.