Setup for C++ Projects

Ready Player Me Unreal SDK for C++ Projects

Ready Player Me Unreal SDK is a free, open-source plugin that is open for contribution.

Set up your project

1. If you don't have a C++ project:

   1. Start Unreal Engine.

   2. Create a C++ project.

   3. Exit Unreal Engine.

2. Follow the instructions below for adding the ReadyPlayerMe and glTFRuntime plugins to the project.

3. In your project directory, you should see two new folders.

   • Plugins/ReadyPlayerMe

   • Plugins/glTFRuntime.

4. Start Unreal Engine and open your project.

5. You should receive the Missing Modules popup, or a New plugins are available notification.

6. If you get the Missing Modules popup, click Yes and wait for the Editor to open with your project. THIS CAN TAKE SEVERAL MINUTES. If you get an error and your project didn't build, see Troubleshooting. From the top toolbar, select Edit > Plugins. -OR- If you get the New plugins are available notification, click Manage plugins...

7. Find the ReadyPlayerMe and glTFRuntime plugins.

8. Check the Enabled option for each plugin.

9. Restart Unreal Engine.

10. In the Content Browser and click Settings (cogwheel icon on the far right)(View Options in UE4). Make sure Show Plugin Content and Show Engine Content are both checked.

11. In the Content Browser, expand Plugins and scroll or use search until you find the gITFRuntime, glTFRuntime C++ Classes, ReadyPlayerMe Content, and ReadyPlayerMe C++ Classes folders.

12. Go to Plugins > Ready Player Me Content > Maps where you can run the RPM_Demo to verify your installation. See also Run the Demo.

Add ReadyPlayerMe and glTFRuntime plugins

You can add the ReadyPlayerMe and the glTFRuntime plugins to your project in three ways.

Option 1: Add as submodules to a Git-managed project (recommended)

To add the plugins to your Git-managed project as submodules, cd into your project folder and run the following git command.

git submodule add --name glTFRuntime -- https://github.com/rdeioris/glTFRuntime.git Plugins/glTFRuntime ; cd Plugins/glTFRuntime ; git checkout $(git describe --tags $(git rev-list --tags --max-count=1)) ; cd ../.. ; git submodule add --name ReadyPlayerMe -- https://github.com/readyplayerme/rpm-unreal-sdk.git Plugins/ReadyPlayerMe ; cd Plugins/ReadyPlayerMe ; git checkout $(git describe --tags $(git rev-list --tags --max-count=1)) ; cd ../..

Option 2: Clone the plugin repositories into your Git managed project

To clone the plugins into your project, cd into your project folder and run the following git command.

git clone https://github.com/rdeioris/glTFRuntime.git Plugins/glTFRuntime ; cd Plugins/glTFRuntime ; git checkout $(git describe --tags $(git rev-list --tags --max-count=1)) ; cd ../.. ; git clone https://github.com/readyplayerme/rpm-unreal-sdk.git Plugins/ReadyPlayerMe ; cd Plugins/ReadyPlayerMe ; git checkout $(git describe --tags $(git rev-list --tags --max-count=1)) ; cd ../..

Option 3: Dowload the plugins as Zip files and paste them into your project

This method does not require Git.

1. Change directory into your project folder.

2. Create a Plugins folder.

3. Download the plugin code as Zip files and unpack them into the Plugins folder.

   • glTFRuntime

   • ReadyPlayerMe

4. Rename the extracted folders to ReadyPlayerMe and glTFRuntime, respectively

Updating ReadyPlayerMe and glTFRuntime plugins

Projects using Git

To update the plugins, paste the following command from your project folder in the terminal. This will fetch and switch the plugin repositories to the latest stable release.

cd Plugins/glTFRuntime ; git fetch --tags ; git checkout $(git describe --tags $(git rev-list --tags --max-count=1)) ; cd ../..

If you project does not use Git

Follow the steps in Option 3 above to get the latest versions of the plugins.

Legacy Plugins

The previous versions of the ReadyPlayerMe plugin are still available at Old Unreal Engine SDK versions.

If you have trouble creating your project, see Troubleshooting for straightforward solutions.