Language:
Page Info
Tags:
Skill Level:
Engine Version:

1. Required Android Setup

Steps

The first thing we need to do to start developing for Android is to install CodeWorks for Android 1R5, which will ensure that you have all the required programs and code needed to deploy to Android devices. In the following section, we will cover how you can get CodeWorks for Android 1R5 installed on your development PC.

Choose Your Operating System

Windows

Mac OS

Linux

If you already have CodeWorks for Android 1R5 installed, but your environment variables have been lost, you can skip all of this and simply point the editor to the install locations using the Edit Menu > Project Settings > Android SDK properties in the Editor.

It is highly recommended that you install CodeWorks for Android 1R5 while the editor and launcher are both closed to ensure that there are no problems with the install.

  1. To install CodeWorks for Android 1R5, navigate to the Engine > Extras > Android folder.

    The CodeWorks for Android 1R5 installer requires an installation of Visual Studio to complete successfully. Supported versions are 2010, 2012 or 2013 (not 2015).

    Install Type Location
    Binary [EngineInstallLocation]\Unreal Engine[EngineVersion]\Engine\Extras\Android
    GitHub [EngineSyncLocation\UE4\Engine\Extras\Android

    If you downloaded UE4 from Github you will need to perform the following steps before you can run the CodeWorks for Android 1R5 installer. Please note that the following applies to both Windows and Mac based PCs that download the UE4 source code from Github. If you are using the binary build downloaded from the launcher, then you can skip this part and go right into installing CodeWorks for Android 1R5.

    1. Once UE4 has been downloaded from Github and extracted, run the Setup.bat file to download the required files as well as the CodeWorks for Android 1R5 installer.

    2. After the Setup.bat has finished running, locate and run the CodeWorks for Android 1R5 installer, following the instructions below.

  2. Double-click on the CodeWorksforAndroid-1R5-windows.exe file to initiate the install process.

    AndroidWorks_11.png

  3. Click the Next button on the first window to begin the installation process.

    AndroidWorks_00.png

  4. Click the Next button to continue.

    AndroidWorks_01.png

  5. Set a location to download and install CodeWorks for Android 1R5 and then click the Next button.

    AndroidWorks_02.png

    It is perfectly fine to leave this set to the default location.

  6. Make sure that your are installing CodeWorks for Android 1R5 and then click the Next button.

    AndroidWorks_03.png

  7. Click on the check mark box, Accept All if you agree with the license terms and then press the Accept button.

    AndroidWorks_04.png

  8. A new window will be displayed that will show you the download and install progress of the required CodeWorks for Android 1R5 tools.

    You will need an Internet connection to complete this portion. Depending on the speed of your Internet connection, this could take a few minute to a few hours to complete.

    AndroidWorks_06.png

  9. Now press the Next button to continue the CodeWorks for Android 1R5 install.

    AndroidWorks_09.png

  10. Then press the Finish button to complete the install.

    AndroidWorks_10.png

  11. Finally press the Yes button to restart your PC.

    AndroidWorks_12.png

    If you downloaded UE4 from Github, when CodeWorks for Android 1R5 has finished installing, restart your PC or Mac so the environment variables are set and then run the Setup.bat file one more time to download the required Android Development files.

If you already have CodeWorks for Android 1R5 installed, but your environment variables have been lost, you can skip all of this and simply point the editor to the install locations using the Edit Menu > Project Settings > Android SDK properties in the Editor.

It is highly recommended that you install CodeWorks for Android 1R5 while the editor and launcher are both closed to ensure that there are no problems with the install.

Before you can install CodeWorks for Android 1R5 to your Mac you will need to make sure that Java 8 is installed. Use the link provided below to download and install Java 8.

  • Java 8 can be downloaded from here .

  1. To install CodeWorks for Android 1R5 navigate to the Engine > Extras > Android folder.

    Install Type Location
    Binary [EngineInstallLocation]\Unreal Engine[EngineVersion]\Engine\Extras\AndroidWorks\Mac
    GitHub [EngineSyncLocation\UE4\Engine\Extras\AndroidWorks\Mac

    If you downloaded UE4 from Github you will need to perform the following steps before you can run the CodeWorks for Android 1R5 installer. Please note that the follow applies to both Windows and Mac based PCs that download the UE4 source code from Github. If you are using the binary build downloaded from the launcher then you can skip this part and go right into installing CodeWorks for Android 1R5.

    1. Once UE4 has been downloaded from Github and extracted, run the Setup.command file to download the required files as well as the CodeWorks for Android 1R5 installer.

    2. After Setup.command has finished running locate and run the CodeWorks for Android 1R5 installer following the instructions below.

  2. Double-click on the CodeWorks for Android 1R5-osx.dmg to load the CodeWorks for Android 1R5 installer.

    AndroidWorks_Mac_00.png

  3. Double-click the CodeWorks for Android 1R5 installer icon to start the installation process.

    AndroidWorks_Mac_01.png

  4. Click Next.

    AndroidWorks_Mac_02.png

  5. Click Next.

    AndroidWorks_Mac_03.png

  6. Specify a location where CodeWorks for Android 1R5 should be installed, then press the Next button.

    It is perfectly fine to leave this set to the default location.

    AndroidWorks_Mac_04.png

  7. When the CodeWorks for Android 1R5 Component Manager is displayed press the Next button to begin the download and install process.

    AndroidWorks_Mac_05.png

  8. Click on the check mark box, Accept All if you agree with the license terms and then press the Accept button.

    AndroidWorks_Mac_06.png

  9. The CodeWorks for Android 1R5 Component Manager will now begin to download and install the required tools.

    You will need an Internet connection to complete this portion. Depending on the speed of your Internet connection, this could take a few minute to a few hours to complete.

  10. Once everything has been installed, the following window will be displayed. Click on the Next button to continue.

    AndroidWorks_Mac_08.png

  11. Click on the Finish button to complete the CodeWorks for Android 1R5 install.

    AndroidWorks_Mac_09.png

    If you downloaded UE4 from Github, when CodeWorks for Android 1R5 has finished installing, restart your Mac so the environment variables are set and then run the Setup.command file one more time to download the required Android Development files.

Once CodeWorks for Android 1R5 has finished installing, you will need to edit your Bash file by doing the following:

  1. Open up the Mac Terminal.

    JH_01.png

  2. In the Terminal type, nano ~/.bash_profile.

    JH_02.png

  3. Scroll down to the end of the file and add, export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home.

    JH_03.png

    The above is the default path, if you installed somewhere else you need to make sure that your path points to the jdk1.8.0_121.jdk/Contents/Home.

  4. Press CTRL + X to exit the bash and then press Y to save the changes then press Enter to confirm the changes and finally restart your Mac.

  5. When your Mac restart, open up the Terminal and then input Monitor and press enter. If everything has been setup correctly you should see the Android Device Monitor splash screen.

    JH_04.png

We're currently in the process of writing this documentation. Please refer to our New and Updated Resources page to see which documentation is being published at this time.

End Result

When completed you will now have all of the required Android SDK's installed and ready for use in building a UE4 project that can work on Android devices.

Tags