Getting Started

Setting Up Your Development Environment

Welcome!

If you are developing an application that uses Soul Engine and you are not going to build the engine yourself, skip ahead to Developing an Application Without Soul Engine

Compilers

CUDA has specific compilers that it is compatible with. Make sure the compiler you choose is listed in CUDA's documentation.

Windows

• It is highly suggested that you use Visual Studio 2019.

OSX

• TODO - Contributions Welcome

Linux

• TODO - Contributions Welcome

Dependencies

In order to use Soul Engine you will have to download and install some dependencies with the listed minimum versions. See General Installation Workflow for your specific system instructions.

Manual Dependencies

Look for the following dependencies in your OS specific installation instructions:

• CMake 3.13.1
• Python 3.7.2
• Conan 1.14.0
• Vulkan SDK 1.1.106.0
• CUDA 10.1

Automatic Dependencies

The following dependencies are satisfied automatically:

• GLFW
• GLM
• stb_image.h
• Boost

General Installation Workflow

You have three choices when using and developing Soul Engine.

1. You can just develop Soul Engine and use the provided example application to execute it.

2. You can develop an application alongside the engine.

3. You can just develop an application without downloading the engine's source files.

Developing Just Soul Engine

Windows

1. Install the project's dependencies.

   • CMake 3.13.1 Download and install. This is only needed if not using the integrated CMake with Visual Studio 2019.
   • Python 3.7.2 Download and install. Add Python to the system path via the installer option.
   • Conan 1.15.0 Install via Python. pip install conan
   • Vulkan SDK 1.1.106.0 Download and install.
   • CUDA 10.1 Download and install.

2. Run Setup.py

3. You have two options to generate the project via CMake.

   • Open the C:\Projects\Soul Engine directory in Visual Studio 2019 to use the integrated CMake functionality.
   • Generate the project with CMake. The location of the build can be found at C:\Projects\Soul Engine\Build.

4. Build and run Soul Info.

OSX

1. TODO - Contributions Welcome

Linux

1. TODO - Contributions Welcome

Developing an Application With Soul Engine

Windows

1. Install the project's dependencies.

   • CMake 3.13.1 Download and install. This is only needed if not using the integrated CMake with Visual Studio 2019.
   • Python 3.7.2 Download and install. Add Python to the system path via the installer option.
   • Conan 1.14.0 Install via Python. pip install conan
   • Vulkan SDK 1.1.106.0 Download and install.
   • CUDA 10.1 Download and install.

2. Run Setup.py

3. Clone or download an application. For example Soul Editor.

4. You have two options to generate the project via CMake.

   • Open the C:\Projects\Soul Editor directory in Visual Studio 2019 to use the integrated CMake functionality.
   • Generate the application with CMake. The location of the build can be found at C:\Projects\Soul Editor\Build.

5. Build and run Soul Editor.

OSX

1. TODO - Contributions Welcome

Linux

1. TODO - Contributions Welcome

Developing an Application Without Soul Engine

Windows

1. TODO: This Feature Is NOT Completed - Contributions Welcome

2. Install the application's manual dependencies. The minimum requirements are listed here:

   • CMake 3.13.1 Download and install. This is only needed if not using the integrated CMake with Visual Studio 2019.
   • Python 3.7.2 Download and install. Add Python to the system path via the installer option.
   • Conan 1.14.0 Install via Python. pip install conan

3. Clone or download an application. For example Soul Editor.

4. You have two options to generate the project via CMake.

   • Open the C:\Projects\Soul Editor directory in Visual Studio 2019 to use the integrated CMake functionality.
   • Generate the application with CMake. The location of the build can be found at C:\Projects\Soul Editor\Build.

5. Build and run Soul Editor.

OSX

1. TODO - Contributions Welcome

Linux

1. TODO - Contributions Welcome