> For the complete documentation index, see [llms.txt](https://docs.airship.gg/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.airship.gg/getting-started/installing-airship.md).

# Installing Airship

## Prerequisites 

1. Install the "LTS" version of [Nodejs](https://nodejs.org/en) 
2. Install [Unity Hub](https://unity.com/download)
3. Recommended: install [VSCode](https://code.visualstudio.com/) for script editing

### Download from Github

[Click here to download the Starter Template](https://github.com/easy-games/airship-template/archive/refs/heads/main.zip). 

This project has everything prepared to start building a game on Airship. 

* Make sure to unzip after downloading.
* After unzipping, **rename the airship-template-main folder** to the name of your project.<br>

### Open in Unity Hub

1. Add -> Add project from disk.<br>

   <figure><img src="https://214663474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbaXflSJA8L9N9yOx089%2Fuploads%2FCa7xat4PnMDhAPc6hwke%2FScreenshot%202024-03-12%20at%207.42.06%E2%80%AFAM.png?alt=media&amp;token=58d8d084-3cc8-4bcc-9217-b11e4dbe20f8" alt=""><figcaption></figcaption></figure>
2. Select the unzipped (and renamed!) Starter Template folder.
3. You will be prompted to install a recommended version of Unity for the project. Press yes.

### Opening Unity for the First Time

* You will be prompted to download the Unity Editor. Press yes.&#x20;
  * Make sure to install the required modules:
    * Android Build Support
    * iOS Build Support
    * Linux Build Support (IL2CPP)
    * Windows Build Support (IL2CPP)
    * Mac Build Support (Mono)

<div align="left"><figure><img src="https://214663474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbaXflSJA8L9N9yOx089%2Fuploads%2F1AjTLOgUuXoT0lpaIIgJ%2Fimage.png?alt=media&amp;token=4b2ef47e-67aa-4872-adc6-4a24de947dd7" alt="" width="375"><figcaption></figcaption></figure></div>

{% hint style="info" %}
Airship will start downloading required asset packages. This may take a few minutes.&#x20;
{% endhint %}

If you see an LTS error you may need to restart Unity Hub. Close Unity, and Unity Hub and then reopen Unity Hub and your template project.

<figure><img src="https://214663474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbaXflSJA8L9N9yOx089%2Fuploads%2FR7bUmAMRSPkRof5PaREr%2Fimage.png?alt=media&amp;token=853319f8-1cfe-4be4-9a2c-a4dad62e64df" alt="" width="287"><figcaption></figcaption></figure>

{% hint style="warning" %}
Unity hub may still be open in your system tray. Right click on the unity icon and select "Quit Unity Hub" to fully close it.

<p align="center"><img src="https://214663474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbaXflSJA8L9N9yOx089%2Fuploads%2FoZh6Z0Yhyryj0xcYLTYE%2Fimage.png?alt=media&amp;token=fbe2418b-811f-4bc2-99e3-2277637b6723" alt="" data-size="original"></p>
{% endhint %}

### Play the Game

You're now ready to play the game. Click the play button in Unity.\
You should see a character spawn on an empty floor:

<figure><img src="https://214663474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbaXflSJA8L9N9yOx089%2Fuploads%2Fc823BOcEjiMKkVKm6djs%2FScreenshot%202024-08-16%20at%203.35.32%20PM.png?alt=media&amp;token=c90bf569-d368-4dc3-979e-eb4e0af77df1" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
If your editor is stuck in an "Untitled Scene", search for "DefaultScene" in the project tab and open it.&#x20;
{% endhint %}