# Lyra Sample

Explore how to host Unreal Engine projects on Edgegap using techniques from the [Lyra Sample](https://dev.epicgames.com/documentation/en-us/unreal-engine/lyra-sample-game-in-unreal-engine).

## ✔️ Preparation

Before we start, you will need:

* Unreal Engine 5.5 - [download using Epic Games Launcher](https://www.unrealengine.com/en-US/download),
* Lyra Starter Game - [download from Fab](https://www.fab.com/listings/93faede1-4434-47c0-85f1-bf27c0820ad0).

Open your Epic Games launcher and navigate to Unreal Engine / Library / Fab Library.

Search for "lyra", then Create Project. We recommend using SSD for faster builds.

## ⚡ Deploy and Connect

### 1. Deploy a Server on Edgegap

☑️ To get started, you'll need to [create a free account with Edgegap](https://app.edgegap.com/auth/register). No credit card required.

☑️ [Create a new app version for your application](https://app.edgegap.com/application-management/applications/lyra-sample/versions/create), choose Lyra Sample.

☑️ [Deploy a server with your Lyra Sample app version](https://app.edgegap.com/deployment-management/deployments/list).

☑️ [Open your new deployment's details](https://app.edgegap.com/deployment-management/deployments/list).

☑️ Find your deployment's unique, one-time connection details:

* **Host URL** in format `780aa4260e83.pr.edgegap.net` ,
* **External Port** in format `30854`  (5 digits).

✅ You may now proceed to the next step.

### 2. Play In Editor (PIE)

☑️ Navigate to your new Lyra Starter Game project root folder on your drive.

☑️ Edit file Config / DefaultEngine.ini with a text editor (such as notepad).

☑️ For each `[section]`  below, add the following contents if it exists or create the section.

```
[ConsoleVariables]
net.IgnoreNetworkChecksumMismatch=1
net.CurrentHandshakeVersion=2
net.MinHandshakeVersion=2
net.VerifyNetSessionID=0
net.VerifyNetClientID=0

[/Script/Engine.GameEngine]
!NetDriverDefinitions=ClearArray
+NetDriverDefinitions(DefName="GameNetDriver",DriverClassName="OnlineSubsystemUtils.IpNetDriver",DriverClassNameFallback="OnlineSubsystemUtils.IpNetDriver")

[/Script/OnlineSubsystemUtils.IpNetDriver]
MaxClientRate=1000000000 
MaxInternetClientRate=1000000000
InitialConnectTimeout=120.0

[/Script/BuildSettings.BuildSettings]
DefaultServerTarget=LyraServer
```

☑️ Open your new project in Unreal Engine.

☑️ Press the ▶️ Play button to start your game client.

☑️ Press tilde `~`  and input `open {host}:{port}`  with connection details from previous step. 

🙌 Congratulations on your first Deployment on Edgegap!

## ✏️ Customize Server Build

{% hint style="success" %}
See [unreal-engine](https://docs.edgegap.com/unreal-engine "mention") for Unreal Engine to **learn how to build and customize servers**.
{% endhint %}