Update README.md

Added step 2
Added warning about engine version in .uplugin
This commit is contained in:
Jordon Brooks 2023-06-10 22:52:33 +01:00 committed by GitHub
parent 72349e9177
commit c55821dacc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -22,7 +22,10 @@ This repository contains the Unreal Engine client plugin for the HarmonyLink API
## Usage ## Usage
1. Use the HarmonyLink API functions provided by this plugin in your game's code to access device metrics and docking status. 1. Use the HarmonyLink API functions provided by this plugin in your game's code to access device metrics and docking status.
2. Adjust your game's settings based on these metrics to optimize the gaming experience on handheld devices. 2. Add the included `DataRefreshActor` to your levels for automatic api updates or request data manually from the functions (does not update on tick)
3. Adjust your game's settings based on these metrics to optimize the gaming experience on handheld devices.
If you have not yet made the jump to Unreal Engine 5 you will need to edit the `HarmonyLinkUE.uplugin` and change the engine version to the desired engine.
## Contributing ## Contributing