====== Requirements ======

   * vulkan (since Unreal Engine 4.25)

====== Installation  ======  
===== Vulkan =====
[[https://linuxconfig.org/install-and-test-vulkan-on-linux/]]

**AMD**
  * sudo add-apt-repository ppa:oibaf/graphics-drivers 
  * sudo apt update 
  * sudo apt upgrade
  * apt install libvulkan1 mesa-vulkan-drivers vulkan-utils
**NVIDIA**
  * sudo add-apt-repository ppa:graphics-drivers/ppa 
  * sudo apt upgrade
  * sudo apt install nvidia-graphics-drivers-396 nvidia-settings vulkan vulkan-utils
===== Unreal Engine 4 =====
[[https://docs.unrealengine.com/4.26/en-US/SharingAndReleasing/Linux/BeginnerLinuxDeveloper/SettingUpAnUnrealWorkflow/]]

====== Docker(Linux)  ====== 
===== Installation =====
  - Follow Step 1 to 5: https://docs.unrealengine.com/4.27/en-US/SharingAndReleasing/Containers/ContainersQuickStart/
  - Install Nvidia container toolkit https://unrealcontainers.com/docs/concepts/nvidia-docker 
     * Required for gpu access
     * Install instruction https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html
  - Configure environment
     * In terminal enter: ''xhost +'' to enable docker access to display 
     * always required if display is used
===== Pre-Build Engine =====
  * Instructions: https://unrealcontainers.com/docs/use-cases/linux-installed-builds
  * Available engine versions: https://github.com/orgs/EpicGames/packages/container/package/unreal-engine
  * JetBrain Rider does not work with this (latest check: 09/2022) 
  * Alternative: ue4cli https://docs.adamrehn.com/ue4cli/overview/introduction-to-ue4cli    

===== Sandbox-Editor =====
  * https://unrealcontainers.com/docs/use-cases/linux-sandboxed-editor
  * Example command:''docker run --rm -ti --net=host --gpus all -v/tmp/.X11-unix:/tmp/.X11-unix:rw --mount type=bind,source=/path/to/project,target=/project -e DISPLAY ghcr.io/epicgames/unreal-engine:dev-4.27 bash''
  * might require permission changes for project

====== Remote ======

[[https://ai.uni-bremen.de/wiki/infrastructure/x11vnc]]

===== Bash script for opening unreal or a project file directly =====
<file>
#!/bin/bash
if [ -z "$1"]
then
	$HOME/work/development/UnrealEngine/Engine/Binaries/Linux/UE4Editor -norelativemousemode
else
    DIR="$( cd "$( dirname "${BASH_SOURCE[0]}"  )" && pwd  )"
	($HOME/work/development/UnrealEngine/Engine/Binaries/Linux/UE4Editor `pwd`/$1 -norelativemousemode)
fi
</file>
**Example**
  * cd /path/to/"project file"
  * ./bashfile project.uproject

====== Unreal Engine 4.27 through ue4cli ======

Build through ue4cli.

  - install [[https://docs.adamrehn.com/ue4cli/overview/introduction-to-ue4cli]]
  - ''ue4 setroot [path to root of your unreal engine]''
  - ''ue4 build'' in the project root
  - ''ue4 run'' in the project root