Skip to content

Commit

Permalink
feat: Documentation for the Unreal Engine integration (#1742)
Browse files Browse the repository at this point in the history
Co-authored-by: Martin Chrástek <chrastek12@gmail.com>
  • Loading branch information
pasotee and Martin005 authored Jul 18, 2023
1 parent 025f6d2 commit 2217a0c
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
1 change: 1 addition & 0 deletions webapp/public/images/technologies/unreal.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions webapp/src/views/projects/integrate/guides.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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[];
41 changes: 41 additions & 0 deletions webapp/src/views/projects/integrate/guides/Unreal.mdx
Original file line number Diff line number Diff line change
@@ -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!

0 comments on commit 2217a0c

Please sign in to comment.