# Exporter The **Exporter** **Module** allows the user to export a **Project** to a chosen location. In addition to exporting the **Project**, the **Exporter** can create a copy of **Incari Player** in the same folder (this is not the case for exporting to *Android*). This makes it possible to save and run a **Project** without the need of **Incari Studio**. There are two tabs in the **Exporter** **Module**: [**Settings**](#settings) and [**Deploy**](#deploy). Furthermore, find below an easy guide on [**Exporting a Project**](#exporting-a-project) with the **Exporter** **Module**, divided between the two possible cases of *Target Platforms*: * [**Host Target**](#host-target) * [**Different Target**](#different-target) ## Settings ![](/files/8dKLUjrmUsNLE1CDWYZl) ### General * `Target`: *Operating System* where the exported **Project** will be played in the corresponding version of **Incari Player**. ### Options * `Only Project`: Whether only the **Project** will be exported or the **Project** alongside a copy of **Incari Player**. This does not apply to *Android* **Projects**, as the **Project** is always exported. * `Only Used Assets`: A user may import more **Assets** than they end up using. When toggled on, this **Attribute** makes sure only the essential **Assets**, which appear in the **Asset Database**, are packaged up for export. ## Deploy ![](/files/8E3pgyjh1wXwJAsZVHuH) * `Export Folder`: The location in the local machine to which the **Project** will be exported. ## Exporting a Project There are two slightly different procedures for exporting a **Project** depending on the `Target` chosen: * [**Host Target**](#host-target) * [**Different Target**](#different-target) * [**Linux**](#linux) * [**Android**](#android) ### Host Target Exporting a **Project** for the *Host* `Target` is very straightforward as this `Target` is already available and selected by default. To export the **Project**, simply click on the `Export` button on the top menu. ![](/files/6eXpgJTpvXK99moigjdB) A pop-up message indicating that the export was successful will appear. ![](/files/gqXrNcFOzUYwrs3kMaQ6) After exporting a **Project**, the export folder will have: * A folder with the exported **Project**. * A `run.bat` file. * A folder with a copy of **Incari Player** (only if `Only Project` was set to *false*). The **Project** can then be started by launching `run.bat`. It is also possible to export a **Project** from the command line. There are two cases, which are equivalent to whether the `Only Project` option is set to *true* or *false* in [**Settings**](#settings), when exporting from **Incari Studio**. For exporting the **Project** alongside a copy of **Incari Player**, run the command: * `IncariCLI.exe /p="" /export /output=""`. For exporting just the **Project**, without a copy of **Incari Player**, run the command: * `IncariCLI.exe /p="" /export /output="" /no-player`. ### Different Target Currently, this is *Linux* and *Android*. Both require setting up *WSL*, which will be explained shortly. Exporting, however, differs between the two `Target` types and have their own corresponding sections: * [**Exporting to Linux**](#linux) * [**Exporting to Android**](#android) Exporting a **Project** for a different *Target* than the *Host* requires a few preparatory steps that will be explained in detail: **Setting up WSL** *WSL* stands for *Windows Subsystem for Linux* and is a tool that allows users to run a *Linux* environment directly on *Windows*. It is needed for building the **Project** for the desired *Target Platform*. Find more information about *WSL* on the links provided in the **External Links** section below. To set up *WSL*, follow these steps: 1. Either on *Windows PowerShell* or *Command Prompt*, run the following *command*: `wsl --install`. This will install *WSL* and the latest *Ubuntu* version. 2. Restart *Windows*. 3. Go to the *Microsoft Store* and install *Ubuntu 22.04* or run on the *PowerShell* or *Command Prompt* the following command: `wsl --install -d Ubuntu-22.04`. 4. Enter your credentials in the pop-up window that appears. If it does not appear, run the command `wsl` on the *PowerShell* or *Command Prompt* and enter your credentials. 5. Set-up *Ubuntu 22.04* as the default *distribution* by running the command `wsl --set-default Ubuntu-22.04` on the *PowerShell* or *Command Prompt*. **Preparing Incari Studio** For exporting to a different *Target Platform* than the *Host*, a *cross-compiled* version of **Incari Player** for the desired *Target* is necessary. * Download **Incari Player** for the desired `Target` *platform* in the [*Applications*](/incari-studio/2023.2/getting-started/first-steps/incari-hub.md#incari-player) section of [**Incari Hub**](/incari-studio/2023.2/getting-started/first-steps/incari-hub.md). #### Linux **Exporting the Project** After following all the previous steps, everything is ready for exporting a **Project** to the desired *Target* *Platform*. For this: 1. Open the **Project** to be exported in **Incari Studio** and go to the **Exporter Module**. 2. Add the desired `Target` by using the plus icon on the top left. ![Adding the Linux Target.](/files/TfQ33o39sGUPKWulFBSX) ![Exporter with Linux x86-64 Target added.](/files/vxVAtxwL38VED2ZDhXU7) 3. Choose the desired `Export Folder` on the [**Deploy**](#deploy) tab. 4. Click on the `Export` button on the top menu. ![](/files/JLIbbBx6YGzUDbOXKasY) A pop-up message indicating that the export was successful will appear. ![](/files/gqXrNcFOzUYwrs3kMaQ6) After exporting a **Project**, the export folder will have: * A folder with the exported **Project**. * A `run.sh` file. * A folder with a copy of **Incari Player** for the desired `Target` (only if `Only Project` was set to *false*). The **Project** can then be started on the *Target Platform* by launching `run.sh`. It is also possible to export a **Project** from the command line. There are two cases, which are equivalent to whether the `Only Project` option is set to *true* or *false* in [**Settings**](#settings), when exporting from **Incari Studio**. For exporting the **Project** alongside a copy of **Incari Player**, run the command: * `IncariCLI.exe /p="" /export /output="" /target=`. For exporting just the **Project**, without a copy of **Incari Player**, run the command: * `IncariCLI.exe /p="" /export /output="" /no-player /target=`. Where `` specifies the *Target Platform*: * Use `x86_64-linux-gnu` for *Linux x86-64*. * Use `aarch64-linux-gnu` for *Linux arm64*. #### Android **Setting up Android SDK and NDK** To deploy the application on an *Android* device, [*AndroidStudio*](https://developer.android.com/studio/install) must be installed. During the *AndroidStudio* installation, a prompt will appear requiring that *Android SDK* be installed as well. This will also install *platform-tools*, which will be required to use [*Android Debug Bridge*](https://developer.android.com/tools/adb) to build and run an app from **IncariStudio**. Please make sure `Android SDK` and `Android API 34` are selected. Next, *Android NDK* must be installed. This will allow one to compile **Incari Projects** for *Android* and compile *Android* projects later on. Simply open *Android Studio* and click `Tools->SDKManager->AndroidSDK->SDKTools`. In the *NDK* section, select `25.1.8937393`. ![Android NDK.](/files/dFW7TvgWszPtRv14D8QM) *Android NDK* can also be downloaded [here](https://github.com/android/ndk/wiki/Unsupported-Downloads#r25c). **Exporting Project** After following all the previous steps, everything is ready for exporting a **Project** to the desired *Target* *Platform*. For this: 1. Open the **Project** to be exported in **Incari Studio** and go to the **Exporter Module**. 2. Add the desired `Target` by using the plus icon on the top left. ![Adding the Android Target.](/files/s0QgnENUfKyJDMUrhwzY) ![Exporter with Android Target added.](/files/EqcewevEvlz28kJdSBlD) 3. Choose the desired `Export Folder` on the [**Deploy**](#deploy) tab. Additionally, when exporting a **Project** for *Android*, it is necessary to specify the *Android Toolchain Path*, besides the target platform and project. *Toolchain* can be found in the installed or downloaded *NDK*. For example: * `/home/user_name/Android/Sdk/ndk/25.1.8937393/toolchains/llvm/prebuilt/linux-x86_64` or * `Downloads/android-ndk-r25c/toolchains/llvm/prebuilt/linux-x86_64/` The toolchain path should be inputted here under `Tools`. Alternatively, it can be provided to the `IncariCLI` as an argument, alongside the **Project** name and desired output directory. 4. Click on the `Export` button on the top menu. ![](/files/DfNEyrjG5kPSIHmjYN52) A pop-up message indicating that the export was successful will appear. ![](/files/gqXrNcFOzUYwrs3kMaQ6) After exporting the **Project**, a folder with the exported **Project** labeled `IncariAndroidApp` will appear in the deployed location. The user can then open this folder in *AndroidStudio* and use it as an *Android* project. **Build and Run** Beyond what has been previously discussed, it is also possible to directly install the **Project** onto a specified device. This can be done by toggling on `Build and Run` under `Deploy > Remote`. Before continuing, it is necessary to make sure *adb* is installed. If the chosen `Android Toolchain` in `Settings > Tools` is from the *NDK* installed by *AndroidStudio*, **Incari Studio** will find the associated *platform-tools* and *adb*. *Java 17* is also required (for [*Gradle*](https://gradle.org/)) and also comes installed by *AndroidStudio*. To double-check, this can usually be located with `C:\Program Files\Android\Android Studio\jbr` on *Windows*, or `/usr/local/android-studio/jbr` on *Linux*. After that, refreshing allows the user to check for connected *Android* devices, appearing in the `Device` dropdown. ![Build and Run Example.](/files/gWvJSNdYFEoCGB0eIQFt) Then the user must simply click `Export` and it will export, build, and install the app on the chosen device. This may take some time, but should eventually result in a success message: ![Successful Build and Run for Android.](/files/F3H6PnA2KxLDv4ysD0ZD) However there are a few instances where an error will occur. These are if there was an installation failure, if the *Java* path was invalid, or if no device has been selected. ## External Links * [*WSL Documentation*](https://learn.microsoft.com/en-gb/windows/wsl/). --- # 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://docs.incari.com/incari-studio/2023.2/modules/exporter.md?ask= ``` 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.