Below you will find instructions on how to begin using Illumination Engine.

Getting Started

The build system is being reworked and the method of dependency installation will likely change accordingly, so be on the lookout for changes on this website for dependency installation.

Many of the following instructions are incomplete and will be filled in at a later date.

For the best experience using this graphics engine, please make sure that your graphics drivers are up-to-date.

Here is a list of a few packages that you will need to download to use the engine:

- Ubuntu

The packages below need to be installed for Illumination Engine to function. The commands listed need to be copied and pasted into a terminal window.

1. sudo apt install libglu1-mesa-dev mesa-common-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libopengl-dev
2. If your IDE does not have CMake built-in, run the installation command, sudo apt install cmake.
3. sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test; sudo apt update; sudo apt install -y g++-12
4. wget -qO - https://packages.lunarg.com/lunarg-signing-key-pub.asc | sudo apt-key add - ; sudo wget -qO /etc/apt/sources.list.d/lunarg-vulkan-1.3.231-focal.list https://packages.lunarg.com/vulkan/1.3.231/lunarg-vulkan-1.3.231-focal.list ; sudo apt update ; sudo apt install vulkan-sdk
5. If you are using an IDE, follow these instructions:

- Windows

MSVC is the recommended compiler for this project.

To build the project on Windows, you need to download Vulkan and, if you're not using an IDE with CMake built-in, CMake.

MinGW Clang

If you have an IDE with a built-in Clang compiler, skip to step 3.

1. Install MSYS.
2. Follow the instructions on the website to run the command pacman -S mingw-w64-x86_64-clang.

Native Clang

1. Install Visual Studio.
2. In the Visual Studio installer, select Desktop C++ Development.

MinGW GCC

If you have an IDE with a built-in GCC compiler, skip to step 3.

1. Install MSYS.
2. Follow the instructions on the website to run the command pacman -S mingw-w64-x86_64-gcc. 3.

MSVC

1. (Optional) To build the project on multiple cores at the same time, download Jom from QT.
2. Install Visual Studio.
3. In the Visual Studio installer, select Desktop C++ Development.

Building Illumination Engine

IDE Specific Instructions

- CLion

To build Illumination Engine with CLion, load the project folder into the IDE. CLion should automatically import the CMake projects. Make sure that the configuration is set to build the Illumination Engine project, your c++ compiler location is set, and your GCC 11 compatible compiler must be set. Finally, click the run button, and CLion should compile and run the project.

Terminal Instructions

To build Illumination Engine without an IDE on Linux or Windows, make sure that you have the required packages installed. Then, open a Terminal/Windows Powershell window inside the project folder and enter the command mkdir build. This will create the folder that will hold all the files used to build the program. Next, type the command cd build. This moves you into the folder you just created. Next, type the command cmake ... This will generate a makefile that can be used to build the project. After it is generated, type the command make. This will take a moment and should successfully build your project if your computer has all the libraries listed above. Finally, to run what was just built, enter the command ./IlluminationEngine. This will launch the Illumination Engine program that was just built.

Support

If you are having any trouble, check out our documentation or report an issue on GitHub.