# Installation

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](https://git-scm.com/docs/git-submodule).

### 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 : 

```shell
> git submodule add git@github.com: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 : 

```cmake
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 : 

```cmake
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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://kap35.gitbook.io/kapui/user-manual/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.