Installation

How install KapUI in your project

KapUI is available on Github. This means that you can use updated version of KapUI for specifics version of KapEngine.

Use gitsubmodules

Git submodules are useful tools to use another repository of github in your github project. You can find gitsubmodules documentation here.

Add KapUI to your project

First of all we have to add KapUI submodules to your project. To do that you have to execute this command in root of your project :

> git submodule add [e-mail]:benji-35/KapUi.git Packages/KapUI

Now the submodule KapUI is added to your project.

Cmake

To explain to your Camke that you have to build KapUI, you have to edit packages.cmake file. This file is located at Packages directory. All you need to do is to add this line in file :

include_directories(Packages/KapUI)

Build your project

To build your project with KapUI, you just have to execute build.sh. This shell file gonna build your game with all submodules that you need.

Use compressed file

With github you can also download the code source of KapUI. This method cannot alow you to update the version of KapUI.

When you downloaded the version that you want, you just have to add all files in a directory call KapUI in Packages directory.

Cmake

To explain to your Camke that you have to build KapUI, you have to edit packages.cmake file. This file is located at Packages directory. All you need to do is to add this line in file :

include(Packages/KapUI/KapUI.cmake)

Build your project

To build your project with KapUI, you just have to execute build.sh. This shell file gonna build your game with all submodules that you need.