Skip to content
develop
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Holodeck

Build Status

Holodeck is a simulator for training reinforcement learning agents in Unreal Engine.

This repository contains everything you need to build environments for Holodeck in Unreal Engine. If you want to use pre-built worlds, use the Python client.

We currently support Unreal Engine 4.22. For best results, use Windows.

Contributing

If you're still here, you're probably interested in contributing to Holodeck. Get started by looking at the developer wiki.

Documentation

See https://holodeck.readthedocs.io.

Requirements

  • Unreal Engine 4.22
    • After starting the Epic Games Launcher, click "Unreal Engine", then click "Library"
    • Click the "+" button to add a new version, select version 4.22, and install
  • Git LFS
  • Visual Studio configured for Unreal Engine development (tutorial)

Installation

  • Clone this repository: git clone https://github.com/byu-pccl/holodeck-engine
  • Navigate to the root folder and right click Holodeck.uproject -> Generate Visual Studio project files
  • Right click Holodeck.uproject -> Switch Unreal Engine Version -> 4.22
  • Run Holodeck.uproject (it will ask you to rebuild, click yes)
    • If you get a "ExampleLevel.umap appears to be an asset file" error, you have not configured git-lfs correctly. Try git lfs pull.

Usage

See How to Debug.

Useful wiki guides

Disclaimer

BYU doesn't have a license to distribute assets for Holodeck's default worlds, so we can only provide packaged binaries.

Troubleshooting

Try cleaning your Visual Studio or Clion project.