How to install HAT on Android using a Windows PC

Before you start

These are one-time installs. If you have used PowerShell before, you may have them already — the first step checks.

1. 1

   Install Git

   Run the installer, then reopen PowerShell.

   Open installer ↗

   You know this worked when: Git responds with a version number

2. 2

   Install Node LTS

   Run the LTS installer, then reopen PowerShell.

   Open download ↗

   You know this worked when: Node responds with a version number

Install HAT

1. 3

   Open PowerShell

   Keep it open beside this page.

   You know this worked when: PowerShell is open

2. 4

   Check Git and Node

   Git and the current Node LTS are required.

   Type this into PowerShell, then press Enter.

   git --version
   node --version

   You know this worked when: Git and Node respond with version numbers

3. 5

   Copy HAT to this PC

   Type this into PowerShell, then press Enter.

   cd ~
   if [ ! -d HAT/.git ]; then
   git clone https://github.com/andromedvn/HAT.git
   fi

   You know this worked when: A HAT folder appears

4. 6

   Open the HAT folder

   Type this into PowerShell, then press Enter.

   cd HAT

   You know this worked when: Your terminal prompt is inside the HAT folder

5. 7

   Use the reviewed version

   Type this into PowerShell, then press Enter.

   git checkout b0342d85e0b7f44e63e86f2fd9e47b7cac10c109

   You know this worked when: Git reports the reviewed commit

6. 8

   Build the native project

   This can take a few minutes the first time.

   Type this into PowerShell, then press Enter.

   cargo build --release

   You know this worked when: The command finishes without an error

7. 9

   Install Android Studio

   Accept the standard setup so it installs the SDK.

   Open download ↗

   You know this worked when: Android Studio opens to its welcome screen

8. 10

   Unlock Developer options

   Settings, About phone, tap Build number 7 times.

   You know this worked when: Developer options appears in Settings

9. 11

   Turn on USB debugging

   Settings, System, Developer options, USB debugging.

   You know this worked when: Developer options shows USB debugging on

10. 12

    Open the project

    Choose Open, then pick the android folder inside HAT.

    You know this worked when: Android Studio finishes syncing without an error

11. 13

    Plug in your phone

    Tap Allow on the phone when it asks.

    You know this worked when: Your phone appears in the device menu

12. 14

    Press Run

    The ▶ button. The first build downloads Gradle.

    You know this worked when: The build ends with an install onto your phone

13. 15

    Open HAT on your phone

    You know this worked when: HAT opens on your phone

If something goes wrong

Nothing here can damage your computer, and every step can be run again safely. If a command fails, the usual cause is the step before it not having finished.

Still stuck? Tell us what happened and we will fix the guide. Include the step number and we can usually reproduce it.