From 2217a0c81c146219bb4bdb2aa6e2f2f9d7ac5eaf Mon Sep 17 00:00:00 2001
From: Oprea Alexandru <oprea_alexandrum@yahoo.com>
Date: Tue, 18 Jul 2023 16:59:55 +0300
Subject: [PATCH] feat: Documentation for the Unreal Engine integration 
 (#1742)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Martin Chrástek <chrastek12@gmail.com>
---
 webapp/public/images/technologies/unreal.svg  |  1 +
 .../src/views/projects/integrate/guides.tsx   |  8 ++++
 .../projects/integrate/guides/Unreal.mdx      | 41 +++++++++++++++++++
 3 files changed, 50 insertions(+)
 create mode 100644 webapp/public/images/technologies/unreal.svg
 create mode 100644 webapp/src/views/projects/integrate/guides/Unreal.mdx

diff --git a/webapp/public/images/technologies/unreal.svg b/webapp/public/images/technologies/unreal.svg
new file mode 100644
index 0000000000..ddef15af7f
--- /dev/null
+++ b/webapp/public/images/technologies/unreal.svg
@@ -0,0 +1 @@
+<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 336 336"><defs><style>.cls-1{fill-rule:evenodd;}</style></defs><path class="cls-1" d="M264.11,191.3h0c-2.79,13.44-15.19,47.94-54.74,66.62l-15.88-17.86L166.69,267a98.9,98.9,0,0,1-78.22-40.12,38.53,38.53,0,0,0,8.76,1.65c4.39.08,9.14-1.53,9.14-8.9v-72.7a12,12,0,0,0-15.05-12C78.91,137.79,69,168.75,69,168.75a98.44,98.44,0,0,1,34.07-75.44,99.85,99.85,0,0,1,50.27-23.19c-13.55,7.72-21.16,20.31-21.16,30.87,0,17,10.24,14.94,13.27,12.44v98.12a15.6,15.6,0,0,0,2,3.45,14.49,14.49,0,0,0,11.85,6c10.25,0,23.55-11.7,23.55-11.7V129.88c0-8.08-6.09-17.84-12.19-21.19,0,0,11.29-2,20,4.67h0a74.63,74.63,0,0,1,5.21-5.73C216.2,87.68,235.35,82,251.3,79.16h0s-29,22.79-29,53.37c0,22.74.59,78.2.59,78.2C233.65,221.12,249.65,206.11,264.11,191.3Z"/><path class="cls-1" d="M168,6.26A161.74,161.74,0,1,0,329.74,168,161.74,161.74,0,0,0,168,6.26Zm0,317A155.27,155.27,0,1,1,323.27,168,155.27,155.27,0,0,1,168,323.27Z"/></svg>
\ No newline at end of file
diff --git a/webapp/src/views/projects/integrate/guides.tsx b/webapp/src/views/projects/integrate/guides.tsx
index b282c93897..dd5664daf1 100644
--- a/webapp/src/views/projects/integrate/guides.tsx
+++ b/webapp/src/views/projects/integrate/guides.tsx
@@ -95,4 +95,12 @@ export const guides = [
       () => import('!babel-loader!@mdx-js/loader!./guides/Figma.mdx')
     ),
   },
+  {
+    name: 'Unreal',
+    icon: getTechnologyImgComponent('unreal'),
+    guide: React.lazy(
+      // @ts-ignore
+      () => import('!babel-loader!@mdx-js/loader!./guides/Unreal.mdx')
+    ),
+  },
 ] as Guide[];
diff --git a/webapp/src/views/projects/integrate/guides/Unreal.mdx b/webapp/src/views/projects/integrate/guides/Unreal.mdx
new file mode 100644
index 0000000000..06cc8ab287
--- /dev/null
+++ b/webapp/src/views/projects/integrate/guides/Unreal.mdx
@@ -0,0 +1,41 @@
+import { GoToDocsButton } from '../component/GoToDocsButton';
+
+<GoToDocsButton
+  href="https://tolgee.io/platform/unreal-plugin/usage"
+  style={{ float: 'right' }}
+/>
+
+To read full documentation about the Tolgee Unreal plugin, visit [docs](https://tolgee.io/platform/unreal-plugin/usage).
+
+## Installing the plugin
+
+First, you need to install the plugin from the [Unreal Marketplace](https://www.unrealengine.com/marketplace/en-US/product/2757e202f8f3408bbf66f65d26223398) and add it to your project/engine.
+
+Alternatively, you can clone the plugin from [GitHub](https://github.com/tolgee/tolgee-unreal) and compile it locally.
+
+## Enabling the plugin
+
+To enable the Tolgee plugin inside Unreal, perform the following steps:
+
+1. Navigate to the Toolbar `Edit` menu
+1. Open the `Plugins` windows
+1. Find the Tolgee plugin and tick the checkbox next to it
+1. Press `Restart now` or restart your project manually.
+
+## Setting up the plugin
+
+After installing the plugin, you need to enable it and set the following properties in the Project Settings → Localization → Tolgee section:
+
+API key:
+```
+{{{apiKey}}}
+```
+
+If you are using the self-hosted version, you can change the URL to your instance.
+
+API URL:
+```
+{{{apiUrl}}}
+```
+
+Then you are now ready to start translating using the plugin!