Skip to content
Update Getting Started authored by Moritz Brückner's avatar Moritz Brückner
......@@ -6,12 +6,19 @@
# Installation
There are two different ways of installing Koui. If you have Git installed, cloning Koui from Git is the preferred way. Otherwise, you can download it as an archive and manually put it into your project's folder.
There are two different ways of installing Koui. If you have Git installed, [cloning Koui from Git is the preferred way](#git-version). Otherwise, you can [download it as an archive](#install-without-git) and manually put it into your project's folder.
## Git Version
- *Kha*: Go into your project's library folder (if it doesn't exist, create one called `Libraries`) and open a command line.
After you installed Koui, the folder structure of your project should look like this:
- *Armory*: Go into your project's subproject folder (if it doesn't exist, create one called `Subprojects` (case dependent)) and open a command line.
```
├── Subprojects/
│ └── Koui/
└── project.blend
```
## Git Version
- Go into your project's subproject folder (if it doesn't exist, create one called `Subprojects` (case dependent)) and open a command line.
Then execute the following command and wait:
......@@ -40,10 +47,10 @@ The above commands require [Git](https://git-scm.com/downloads) in order to work
After installation, open your project's `khafile.js` and add the following line:
```javascript
await project.addProject("Libraries/Koui");
await project.addProject("Subprojects/Koui");
```
If your library folder is called differently, change the name in the `addProject()` call respectively.
If your subprojects folder is called differently, change the name in the above `addProject()` call respectively.
> Adding Koui as a library with `project.addLibrary()` alone will not work because Koui's `khafile.js` has to be loaded too in order to work - `project.addLibrary()` does not do this.
......
......