Getting started (FULL version)

1. Creating the SAMPLE project

Why do we need to compile the plugin from source ?

In Unreal Engine there is no way to package a project that includes a plugin without it’s c++ source code.  Also it’s not possible to package a blueprint project with code plugins. Fortunately UNREAL4AR comes with full C++ source code, which makes possible to package any project on any platform.

To create the sample project follow the steps below:

a. Windows

  1. Install Visual Studio 2015 – community editions are also working
  2. Launch unreal engine editor
  3. Create a new C++ code project without starter content
  4. Copy all files from SampleProject directory to your new project directory
  5. In UE4 editor File -> Refresh visual studio project (optional)
  6. Exit from unreal engine editor
  7. Launch your new project from epic launcher
  8. Click on rebuild missing DLLs when prompted
  9. Optional: Click on File -> Package project -> Windows -> Windows 64bit

b. MAC OSX

  1. Install xcode from apple app store
  2. Launch unreal engine editor
  3. Create a new C++ code project without starter content
  4. Copy all files from SampleProject directory to your new project directory
  5. In UE4 editor File -> xcode project (optional)
  6. Exit from unreal engine editor
  7. Launch your new project from epic launcher
  8. Click on rebuild missing DLLs when prompted
  9. Optional: Click on File -> Package project -> OSX

c. Android

  1. Setup your Android development enviroment. https://docs.unrealengine.com/latest/INT/Platforms/Android/GettingStarted/
  2. Launch unreal engine editor
  3. Create a new C++ code project without starter content
  4. Copy all files from SampleProject directory to your new project directory
  5. In UE4 editor File -> Refresh visual studio project (optional)
  6. Exit from unreal engine editor
  7. Launch your new project from epic launcher
  8. Click on rebuild missing DLLs when prompted
  9. Optional: Click to Launch on Android device button, or package the project.

IMPORTANT: Make sure to also generate an .OBB file. 

  1. Edit ->Project Settings -> Android -> UNCHECK Package game data inside APK
  2. Use the generated .bat file to install the packaged app to your device.

IMPORTANT: Before uploading to Google Play

In SampleProject\Plugins\ARToolkitPlugin\Source\ARToolkitPlugin\ARToolkitPlugin_APL.xml locate this line:

String obbPath = Environment.getExternalStorageDirectory() + "/obb/"; 

Change it to: 

String obbPath = Environment.getExternalStorageDirectory() + "/Android/obb/";

IMPORTANT: Plugin  version v1.9 , Unreal Engine version 4.17-4.18

On some Android 4.4.2. (KitKat) devices the sample app may crash right after the launch screen.

To FIX that disable the following plugins:

  • OnlineSubsystemNull
  • OnlineSubsystemUtils
  • OnlineSubsystemGooglePlay
  • Android Media Player

d. iOS

  1. You will need a Mac computer to package your code project for IOS devices!
  2. Setup your iOS development enviroment,
    https://docs.unrealengine.com/latest/INT/Platforms/iOS/QuickStart/index.html
  3. Launch unreal engine editor
  4. Create a new C++ code project without starter content
  5. Copy all files from SampleProject directory to your new project directory
  6. In UE4 editor File -> Refresh xcode project (optional)
  7. Exit from unreal engine editor
  8. Launch your new project from epic launcher
  9. Click on rebuild missing DLLs when prompted
  10. Go to edit -> project settings -> iOS and import your mobile provision and certificate files
  11. Optional: Press the “Launch on iOS device” button