Home › Start › Installation

Installation

Getting the framework enabled and the project configured. Takes about ten minutes.

Requirements

Enabling the plugins

Copy the AdvancedFrameworkPro folder into your project's Plugins directory and restart the editor.

Warning

Enable the plugins as a set rather than one at a time. The plugin descriptors do not currently declare their dependencies on each other, so enabling a single plugin without the ones it references produces asset load errors rather than a clear message. The dependency graph is shown on each plugin page under Requires.

The framework plugins in the Unreal plugin browser
setup_plugin_browser.pngThe framework plugins in the Unreal plugin browser
The framework plugins in the Unreal plugin browser

At minimum you need AFS_Libraries, AFM_Abilities, AFS_Core_Pawn and AFS_Core_Loading. Add the UX and UI plugins for the interactions you want.

Settings the plugins change

Five plugins ship a Config/Engine.ini that changes project settings for you. You do not have to apply any of them by hand — but you should know what moved, because two of them fail silently if they do not take.

Why this needs checking at all. Plugin config sits earlier in Unreal's hierarchy than your own. The order is the engine's BasePluginBase.ini, then the plugin's Config/Engine.ini, then your project's Config/DefaultEngine.ini, and later files win. So any of these keys your project already sets overrides the framework's — with no warning and nothing in the log. Config is also read at startup, so none of it applies until you have restarted the editor.

The first two are the ones to confirm after installing. Both fail silently, and in neither case does the symptom point at a config file.

Verifying the install

Open Map_Examples_Lobby from AF_Examples and press Play. You should get the showroom with a working menu. If you have a headset connected, launch in VR Preview and you should get hands.

The Showroom running after a successful install
setup_showroom_running.pngThe Showroom running after a successful install
The Showroom running after a successful install