Skip to content

An example Unreal Engine project template for the IOSQRCodeReader plugin. Requires installation of the IOSQRCodeReader plugin in the Plugins folder.

License

Notifications You must be signed in to change notification settings

MatthewDZane/UnrealEngineIOSQRCodeReaderExampleProject

Repository files navigation

Unreal Engine iOS QR Code Reader Plugin

An Unreal Engine plugin for QR Code Reading in iOS!

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. License
  5. Contact
  6. Acknowledgments

About The Project

This is an example project template for the IOSQRCodeReader Unreal Engine plugin. Access can be purchased from the Epic Games Store or if you have access to the source repository the latest commit can be pulled from this github repository. Setup instructions are included below.

Please contact matthewdzane@gmail.com for requests for additional functionality and for access to the github repository.

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Please read the official Unreal Engine documentation for iOS Game Development to ensure you meet the prerequisites for developing for iOS Unreal Engine applications.

It is recommended to use a MacOS device to setup and build the project. It is possible to use a Win64 machine, but remote access to a MacOS machine will still be needed. An iOS device is required to build the project, otherwise most of the functionality will not work.

Installation

Below are instructions on how to setup the Unreal Engine IOS QR Code Reader plugin.

  1. Ensure that Unreal Engine 5.1 is installed.
  2. Copy the IOSQRCodeReader plugin into the "Plugins" folder.
  3. In a Finder, right click the .uproject file and Generate XCode Project files.
  4. Open the project in XCode and build it.
  5. Open the project in Unreal Engine 5.
  6. Now the example project is ready to build onto an iOS device.

Note: Make sure you have read and met the iOS Game Development prerequisites. You will have to setup your own BundleIdentifier in the Example Project and your Apple Developer Account. More detailed info is in the official documentation.

(back to top)

Usage

This Example Project's default map is the IOSQRCodeReader plugin's QRCodeReaderExampleMap, which adds the BP_QRCodeReaderOutputWidget to the player viewport. The widgets spawns a QRCodeReaderActor and displays the following data:

  • Scanned QR Code Url
  • Camera On Status
  • Camera Position (Front or Back)
  • Camera Orientation (Left, Right, Portrait, or Portrait Upside Down)
  • Camera Feed Texture

The BP_QRCodeReaderOutputWidget also includes three buttons widget toggle:

  • Camera On Status
  • Camera Position
  • Camera Auto Rotate Enabled Status

The project Platform -> iOS -> Orientation settings are all checked. This may need to be modified to meet your specific needs.

(back to top)

License

Please read the license here.

(back to top)

Contact

If you have any questions, issues, or requests, please contact me via my LinkedIn or the email below.

Matthew Zane

Project Link: https://github.com/MatthewDZane/UnrealEngineIOSQRCodeReaderExampleProject/

Plugin Project Link: https://github.com/MatthewDZane/UnrealEngineIOSQRCodeReader/

(back to top)

Acknowledgments

Thank you to NSYNK { for sponsoring this project!

(back to top)

About

An example Unreal Engine project template for the IOSQRCodeReader plugin. Requires installation of the IOSQRCodeReader plugin in the Plugins folder.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published