Getting Started

Obtaining Skybolt

Skybolt can be obtained using one of the following methods:

• Download a pre-built version on supported operating systems
• Build from source

Running the GUI Application

The main Skybolt GUI application can be started by running the SkyboltQtApp executable from the bin folder.

To explore example scenarios, navigate to the /Scenarios folder, where you will find pre-configured scenarios that demonstrate use cases of the application.

Writing Plugins

Skybolt supports Python and C++ plugins as follows:

Python

Skybolt allows users to implement new Entity Component types in Python. These components are initialized when the entity is added to the scene, updated each time step, and destroyed when the entity is removed.

The ReplaySource is an example of a component implemented in Python. This component is responsible for replaying simulation data from a CSV file. See Assets/Core/Scripts/replay_source.py.

At runtime, Skybolt searches for python plugin modules inside asset packages under <AssetPackage>/Scripts.

C++

Skybolt allows develpers to add new engine functionality by writing C++ plugins. Please refer to src/Skybolt/SkyboltEnginePlugins/ for examples.

At runtime, Skybolt searches for plugins under the bin/plugins folder.

Using Python API without the GUI

Skybolt has a python API which allows the engine to be used outside the SkyboltQtApp application. Refer to src/SkyboltExamples/MinimalPython/MinimalPython.py as an example. See also Python API documentation.