[Ikarus] Setup article

docs/zengin/scripts/extenders/ikarus/setup.md

@@ -0,0 +1,78 @@
+---
+title: Setup
+---
+
+# Ikarus Setup
+
+## Download
+First you need to download ikarus from the [official github repository](https://github.com/Lehona/Ikarus). We recommend using the master branch as it contains the latest and most up-to-date version of Ikarus. However, you can also download a specific release if needed.
+
+## File location
+Before unpacking the downloaded archive it's needed to create a dedicated folder in `<Gothic-dir>\_work\Data\Scripts\Content` directory. You can name this folder as you wish; in this guide, we'll refer to it as the "MOD" folder. Unpack the downloaded files into this newly created folder. The unarchiver should create a folder named `Ikarus-master` or `Ikarus-X.X.X`. For beter readability change its name to the much simpler `Ikarus`.
+
+!!! Tip
+    It's a good practice to delete any unused files, so delete files for other gothic version than this you are using.
+
+## Parsing
+Ikarus consists of three main parts, [constants](./constants.md), classes and the Ikarus core. It's essential to parse these in a specific order. Additionally, there is a [floats package](floats.md) which isn't essential, but is is highly recommended to parse it, especially if you are working with [LeGo](../lego/index.md) that depends on it.
+
+The Ikarus Core is identical for both Gothic 1 and 2 and is contained in a single file, `Ikarus.d`. However, there are separate files for the constants and classes for each engine, and they must be parsed correctly. Ikarus uses a C_NPC and therefore has to parsed after the C_NPC class (after the `classes.d` file). There are no other dependencies.
+
+Since Ikarus 1.2.1 there is additional `.src` file for each game engine, to simplify adding files to `Gothic.src` 
+
+!!! Warning
+    Following example is for Gothic 2. If you are using Gothic 1 replace the `G2` at the end of the file/directory name with `G1`.
+
+=== "Gothic.src"
+    ```
+    _INTERN\CONSTANTS.D
+    _INTERN\CLASSES.D
+    MOD\IKARUS\Ikarus_Const_G2.d
+    MOD\IKARUS\EngineClasses_G2\*.d
+    MOD\IKARUS\Ikarus.d
+    MOD\IKARUS\float.d
+    ```
+=== "Gothic.src (Ikarus 1.2.1+)"
+    ```
+    _INTERN\CONSTANTS.D
+    _INTERN\CLASSES.D
+    MOD\IKARUS\IKARUS_G2.SRC
+    ```
+
+## Initialization
+Before you can use Ikarus in your scripts, it must be properly initialized. The initialization process differs between Gothic 1 and Gothic 2.
+
+### Gothic 1
+To intialize Ikarus in Gothic 1 you must define your own `INIT_GLOBAL` fuction at the top of the `Startup.d` file. Then the `INIT_GLOBAL` should be called in every `INIT_<location>` function (e.g. `INIT_SURFACE`,`INIT_OLDCAMP` etc.). `INIT_SUB_<location>` functions can be skiped in that process.
+
+Then in your `INIT_GLOBAL` fuction you call `MEM_InitAll()` initialization function.
+
+```dae title="Startup.d"
+FUNC VOID INIT_GLOBAL()
+{
+    // Init Ikarus
+    MEM_InitAll ();
+};
+
+// [...]
+
+func VOID INIT_SURFACE ()
+{
+	Init_Global();
+    INIT_SUB_SURFACE ();
+};
+// [...]
+```
+
+### Gothic 2
+Gothic 2 has its own `INIT_GLOBAL` function, so the initialization proces is much simpler. All you have to do is to call `MEM_InitAll()` in `INIT_GLOBAL` function located in the `Startup.d` file.
+
+```dae title="Startup.d"
+FUNC VOID INIT_GLOBAL()
+{
+    // Init Ikarus
+    MEM_InitAll ();
+};
+
+// [...]
+```