From 7e8fdc9cf33ef33140826434a15a2c67087b85f1 Mon Sep 17 00:00:00 2001 From: katznboyz1 Date: Thu, 14 Apr 2022 17:14:19 -0400 Subject: [PATCH] updated the readme --- README.md | 28 +++++++++++++++++++++++++++- smartphoneremote_ue5_reciever.py | 2 +- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 65cb80e..1db8fae 100644 --- a/README.md +++ b/README.md @@ -1 +1,27 @@ -Will be updated when the code is ready. \ No newline at end of file +# Smartphone Remote UE5 + +*A Python middleman for the Smartphone Remote app, and Unreal Engine 5. This enables remote control of the camera in UE5 using a smartphone.* + +## Setup Instructions: + +1.] `git clone https://github.com/katznboyz1/smartphoneremote_ue5 %% cd smartphoneremote_ue5` + +2.] `python3 -m pip install -r requirements.txt` + +## CLI Args: + +`--bind` / `-b` : The port where the program will listen for incoming connections from the smartphone app. [Not required, default is 8096]. + +`--generate-qr-code` / `-g` : Whether or not the program should generate a QR code that you can scan with your phone to connect to the middleman. [Not required, default is no]. + +`--unreal-engine-api-root` / `-u` : The root point for the Unreal Engine web control API. [Not required, default is http://127.0.0.1:30010]. + +`--unreal-engine-camera-path` / `-c` : The path for the camera in Unreal Engine. [Not required, however this will likely not work if you don't set it manually, as the default is specific to my debug environment]. + +## Running the Program + +1.] Start Unreal Engine with the web control plugin enabled and configured. + +2.] `python3 smartphoneremote_ue5_reciever.py [args]` + +3.] Scan the QR code/enter the information on your phone to connect to the middleman. \ No newline at end of file diff --git a/smartphoneremote_ue5_reciever.py b/smartphoneremote_ue5_reciever.py index bec7bbe..592d78e 100644 --- a/smartphoneremote_ue5_reciever.py +++ b/smartphoneremote_ue5_reciever.py @@ -31,7 +31,7 @@ required = False, type = str, dest = 'recieverCLIArgs_unrealEngineAPIRoot', - help = '(http://a.d.d.r:port) the root point for the unrean engine web control api (default: http://127.0.0.1:30010)' + help = '(http://a.d.d.r:port) the root point for the unreal engine web control api (default: http://127.0.0.1:30010)' ) recieverCLIParser.add_argument( '--unreal-engine-camera-path', '-c',