From 4b775b0ecff1b44ca8e2b346cbc10da705e580c2 Mon Sep 17 00:00:00 2001 From: NikolaJov96 Date: Mon, 13 Dec 2021 16:05:23 +0100 Subject: [PATCH 1/3] Marketplace requirements --- EasySynth.uplugin | 2 ++ 1 file changed, 2 insertions(+) diff --git a/EasySynth.uplugin b/EasySynth.uplugin index dfd4f0e..0cc10ba 100644 --- a/EasySynth.uplugin +++ b/EasySynth.uplugin @@ -2,6 +2,8 @@ "FileVersion": 3, "Version": 1, "VersionName": "1.0", + "EngineVersion" : "4.26.0", + "WhitelistPlatforms": [ "Win64", "Win32", "Linux" ], "FriendlyName": "EasySynth", "Description": "An Unreal Engine plugin for easy creation of image datasets", "Category": "Other", From de9610b7c909c9cdbd693b6d00916e2a90726bd1 Mon Sep 17 00:00:00 2001 From: NikolaJov96 Date: Mon, 13 Dec 2021 16:23:33 +0100 Subject: [PATCH 2/3] Expand installation guide --- README.md | 28 ++++++++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3994544..f93b330 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,9 @@ The plugin works by automatically starting the rendering of a user-defined level ## Installation -### Install by adding the plugin source code to your project +IMPORTANT: The plugin was developed using Unreal Engine 4.26 and it appears not to compile successfully with 4.27. Please use the compatible engine versions until the fix is released. + +### Install inside a specific project This method works with both engines installed from the Epic launcher and engines built from source code. @@ -23,10 +25,28 @@ This method works with both engines installed from the Epic launcher and engines - Optional: Use some of the provided Unreal Engine templates that come with a prebuilt level layout - Exit the editor - Create and navigate to the `/Plugins` directory -- Clone this repo inside the `/Plugins` directory +- Clone this repo, or unzip the appropriate release inside the `/Plugins` directory - Reopen your project -IMPORTANT: The plugin was developed using Unreal Engine 4.26 and it appears not to compile successfully with 4.27. Please use the compatible engine versions until the fix is released. +### Install inside the engine using prebuilt binaries + +This method works with both engines installed from the Epic launcher and engines built from source code but requires using appropriate binaries. + +- Navigate to the `/Engine/Plugins` directory +- Unzip the appropriate release +- Restart the engine +- Create a new project and activate the plugin inside the Plugins menu + +### Install inside the engine built from source + +This method only works with engines built from source code. + +- Navigate to the `/Engine/Plugins` directory +- Clone this repo +- Navigate to the `` directory +- Run the `make` command +- Restart the engine +- Create a new project and activate the plugin inside the Plugins menu ## How to use @@ -169,4 +189,4 @@ Our implementation was inspired by the [ProfFan's](https://github.com/ProfFan) [ ## Contributions -This tool was designed to be as general as possible, but also to suit our internal needs. You may find unusual or suboptimal implementations of different plugin functionalities. We encourage you to report those to us, or even contribute your fixes or optimizations. This also applies to the plugin widget Slate UI whose current design is at the minimum acceptable quality. +This tool was designed to be as general as possible, but also to suit our internal needs. You may find unusual or suboptimal implementations of different plugin functionalities. We encourage you to report those to us, or even contribute your fixes or optimizations. This also applies to the plugin widget Slate UI whose current design is at the minimum acceptable quality. Also, if you try to build it on Mac, let us know how it went. From ad445b8fbe7492fa1ca98e509c3f397a04bfa85c Mon Sep 17 00:00:00 2001 From: NikolaJov96 Date: Mon, 13 Dec 2021 16:29:14 +0100 Subject: [PATCH 3/3] Readme typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f93b330..35400d0 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ This method works with both engines installed from the Epic launcher and engines - Restart the engine - Create a new project and activate the plugin inside the Plugins menu -### Install inside the engine built from source +### Install inside the engine by building from source code This method only works with engines built from source code.