uerl 0.1.0

Modular RL infrastructure platform for Unreal Engine 5 environments

Unreal Engine Deep Reinforcement Learning Library

Library and framework for streamlined development of learning agents in Unreal Engine 5

Table of Contents

1. About The Project
   • Built With
2. Installation
   • Prerequisites
   • Getting Started
3. Usage
4. Contact

About The Project

A deep reinforcement learning framework designed specifically for integration with Unreal Engine.

Made for both developers and non-programmers, the framework supports native code alongside Blueprint visual scripting, enabling users to implement learning agents within their Unreal projects regardless of their programming background.

Features a minimal setup process to get you started fast. The design makes it straightforward to set up training environments and experiment with different reinforcement learning algorithms without hassle.

You can find more information and documentation at the GitHub repository wiki. Below is a library overview video demonstrating an implementation of the framework with a basic example.

Built With

Installation

Follow the instructions below to get started.

Prerequisites

Unreal Engine 5 and above

Getting Started

Open your terminal and clone the repository to your local machine:

git clone https://github.com/kcccr123/ue-reinforcement-learning.git

The repository is split into an external python module and an Unreal Editor project plugin.
Instead of cloning, you can choose to download the Unreal Plugin and Python module seperately from the GitHub releases.

Unreal Setup

1. Copy the entire plugin folder, UnrealPlugin into the Plugins directory of your Unreal project.

If the Plugins folder doesn’t exist, create one in the root of your project. The folder structure of your Unreal project should look like this:

YourUnrealProject/
└── Plugins/
    └── UnrealPlugin/

2. Enable the plugin inside the Unreal Editor.

Open your Unreal project inside the editor. Navigate to Edit > Plugins. Locate your plugin in the list (it might be under a relevant category such as "Other" or "Installed Plugins"). Check the box to enable the plugin. Restart Unreal Engine.

Python Setup

It is generally recommended you create a virtual enviornment to manage dependencies, but it is not strictly required.

1. In your terminal, cd into the PythonEnv directory.

2. Run the commmand pip install -r requirements.txt to install the required Python dependencies.

Contact

Feel free to contact me at:

@Kevin Chen - [e-mail]
@Gary Guo - [e-mail]

(back to top)