---
description: Setup your Unreal project
---

# Unreal Library Quickstart

This page introduces the Anything World plugin for Unreal Engine 5 and gives indications on how to install it and start using it. This plugin allows you to browse for static and animated 3D models in Unreal and spawn them directly in your Unreal projects.

{% hint style="danger" %}
The Anything World plugin for Unreal Engine 5 is currently in early access and its features should be considered experimental and may change significantly in later updates. Please take this into account when considering using this plugin in your specific use case.
{% endhint %}

**Requirements:**

* Unreal Engine 5.0, 5.1, 5.2, 5.3 or 5.4.
* Unreal C++ Project
* Visual Studios 2019
* Anything World Account Details
* Anything World SDK

{% hint style="danger" %}
The plugin has been tested in using the Visual Studios IDE and Visual Studio Code however additional testing is required to ensure it is well supported in other platforms.
{% endhint %}

{% hint style="info" %}
If you're completely new to Unreal it might be a good idea to learn a bit about the Unreal interface. The [documentation ](https://docs.unrealengine.com/5.0/en-US/understanding-the-basics-of-unreal-engine/)provided by the Unreal team is a great place to start learning.

Once you've got the basics down, follow this guide and see how to get started with creating 3D content in Unreal!
{% endhint %}

## Create your Anything World Account

[ **Create an account through the Anything World website**](https://app.anything.world/) **to get access to the Anything World SDK for Unreal.**

{% hint style="info" %}
**Our REST API requires a unique developer API key for authentication in order to allow make APIs calls.**
{% endhint %}

{% hint style="warning" %}
**The Anything World SDK requires the project to be created or converted to a C++ project in order to compile successfully.**&#x20;



If an existing project containing the AnythingWorld SDK fails to compile on startup, first remove the SDK from plugins folder of the project, open the project, and generate a C++ class. Once the project has been successfully converted, users may install the Anything World SDK within the plugins folder.
{% endhint %}

## **Set up the Anything World SDK**&#x20;

### Step 1:

Download the latest version of the Anything World plugin for Unreal Engine 5 (not the Unity package) from your[ account page](https://app.anything.world/profile) in Anything World’s website.

### Step 2:

In your file browser, extract the “AnythingWorld” plugin folder from the zip file.

### Step 3:

In your file browser, copy the “AnythingWorld” folder and paste it inside the “Plugins” folder of your Unreal project.&#x20;

<figure><img src="https://588284853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_f9MEtTx5q1bKIGvl-%2Fuploads%2FgV5wR4o6vxmmzOgJleli%2Fimage.png?alt=media&#x26;token=92d1a99f-8eed-4861-a5ad-4de92b4b9dda" alt=""><figcaption><p>Create a folder labeled "Plugins" within the Project Folder.</p></figcaption></figure>

{% hint style="info" %}
Example: if your project is called “Example”, it should have a top-level folder called “Example”, with folders like “Content”, “Plugins”, etc., and “AnythingWorld” needs to go inside “Plugins”. If you don't have a “Plugins” folder, create it first.
{% endhint %}

### Step 4:

Open your Unreal project in the Unreal Editor of Unreal Engine 5. In the main menu bar, navigate to “Edit” → “Plugins” to open the plugins available in your project. In a section called “Other”, you should see the Anything World plugin and tick the plugin’s checkbox.&#x20;

<figure><img src="https://588284853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_f9MEtTx5q1bKIGvl-%2Fuploads%2FTEBgwiEz2phKu6o6BGt1%2Fimage.png?alt=media&#x26;token=8afb4ed9-7a29-490e-93f1-5f94cc719de6" alt=""><figcaption><p>Navigate to Edit button in the tool bar and select the Plugins Option.</p></figcaption></figure>

<figure><img src="https://588284853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_f9MEtTx5q1bKIGvl-%2Fuploads%2FFcE99gYCrpLAMyxlySKJ%2Fimage.png?alt=media&#x26;token=85c9d669-97f0-48c6-8027-ccc68861fc15" alt=""><figcaption><p>You can also search for the Anything World Plugin via the search bar within the Plugins window. Once the Anything World Plugin is enabled, you will receive a prompt to restart the Unreal Engine.</p></figcaption></figure>

### Step 5:

You will then see an “AnythingWorld” section in the main menu bar of the Unreal Editor. You can click it to show “Settings” and “Anything Search”. Click “Anything Search”.

<figure><img src="https://588284853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_f9MEtTx5q1bKIGvl-%2Fuploads%2Fi9xhmloHLUlH6mfTgFzb%2FUnrealAWToolbar.png?alt=media&#x26;token=f6e58a23-9f1a-44b3-be09-39d1e00f1726" alt=""><figcaption><p>After restarting the Unreal Engine, the AnythingWorld menu will appear in the tool bar.</p></figcaption></figure>

### Step 6:

Log in to your Anything World account. Internally, this action will grant the plugin access to your Anything World API key, which is necessary to interact with our server.

<figure><img src="https://588284853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_f9MEtTx5q1bKIGvl-%2Fuploads%2Fgcu8PbcbXNUh5b6Jkbhl%2Fimage.png?alt=media&#x26;token=9a47a553-05e7-42d8-b79d-1202180571fd" alt=""><figcaption><p>Input the credentials used to create your Anything World Account or Sign up through the settings panel to create a new account.</p></figcaption></figure>

### Step 7:

Now you should be able to see the landing page of the Anything World browser, which you may want to dock. You can see the featured models on the top, and other relevant sections of models below, such as those with the highest number of likes and the most used models.

<figure><img src="https://588284853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_f9MEtTx5q1bKIGvl-%2Fuploads%2Ffi6K9wAZrUy0gE7RvqS6%2Fimage.png?alt=media&#x26;token=e1c29712-32bc-4d19-8431-b2a6fb8f9d9b" alt=""><figcaption></figcaption></figure>

### Step 8:

You can search for specific models by entering a query in the text bar and pressing enter. After a small time, results will appear, and you may want to filter and sort them with the available options if you want.

<figure><img src="https://588284853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_f9MEtTx5q1bKIGvl-%2Fuploads%2FEPnyhrHlCZehEtmbyrRW%2Fimage.png?alt=media&#x26;token=66d3b7e3-05a8-4567-a74c-568f90182244" alt=""><figcaption><p>Animated models are noted by the Play icon at the top left corner of the model preview box.</p></figcaption></figure>

### Step 9:

Clicking on any model will add it to your current level, where you can manipulate it as any actor. If the model’s thumbnail in the browser had a play icon in the top left corner, it means it is an animated model, so you will be able to see it playing animations when you play in the level.&#x20;

<figure><img src="https://588284853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_f9MEtTx5q1bKIGvl-%2Fuploads%2FZorZHCJCnB0jOvq20L4G%2Fimage.png?alt=media&#x26;token=213553db-9741-4cea-8456-9e2f974c07b1" alt=""><figcaption><p>The model will be placed in the level upon selection of a model within the Anything World Browser.</p></figcaption></figure>

{% hint style="info" %}
You can access the animations, mesh, materials and textures in the “DynamicAssets” folder within the plugin’s content folder, via Unreal’s content drawer.
{% endhint %}

<figure><img src="https://588284853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_f9MEtTx5q1bKIGvl-%2Fuploads%2FrDw1kJUb0EYqGhzyj8U7%2Fimage.png?alt=media&#x26;token=493ea3e0-2a85-486c-9b31-4fc4afb06f16" alt=""><figcaption><p>After importing a model from the Anything Browser a folder will be created containing all the components of the model.</p></figcaption></figure>

{% hint style="warning" %}
If the Plugins Folder does not appear automatically you can enable the Plugin folder to display by selecting the settings option on the Content Drawer and enabling 'Show Plugin Content'
{% endhint %}

<figure><img src="https://588284853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_f9MEtTx5q1bKIGvl-%2Fuploads%2FMfi7T6h8eGL74k07Cyu9%2FUnrealContentPlugin.png?alt=media&#x26;token=a2609fe2-6850-44af-879b-83ea0046cc5c" alt=""><figcaption><p>Select 'Settings' at the top right corner of the Content Drawer then select the 'Show Plugin Content' option.</p></figcaption></figure>

### Step 10:

For the model to be able to move through the world with a simple default random movement behaviour, you need to add a NavMeshBoundsVolume to the level.

<figure><img src="https://588284853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_f9MEtTx5q1bKIGvl-%2Fuploads%2FxtQXNlLtrAEFClddOwM7%2Fimage.png?alt=media&#x26;token=18b041ed-8ce1-4600-bd1e-799411d4532d" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Adjust the location and scale of the volume to cover the walkable surface of the map. You may want to turn on the navigation visualization option pressing “P”.
{% endhint %}

<figure><img src="https://588284853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_f9MEtTx5q1bKIGvl-%2Fuploads%2F9FUuq9Kk4fkKEkIjyTVL%2Fimage.png?alt=media&#x26;token=82c9d304-712a-4ca5-ab17-f8831b747e02" alt=""><figcaption></figcaption></figure>

### Step 11:

If you now press the play button, you will see how the model moves around!

<figure><img src="https://588284853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_f9MEtTx5q1bKIGvl-%2Fuploads%2FbRec9CoAUUqeYWsmyC5g%2Fimage.png?alt=media&#x26;token=2fa1c3c3-d82a-4db4-bb27-a48ea909ab53" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
After you clicked to place the first model, you may notice a “AWMeshManager” was added to the scene. It controls the placement of models in a grid-like fashion, and exposes as editable properties the number of columns and the spacing between rows and columns, that you may edit based on your preferences, as well as the grid origin location.\

{% endhint %}

{% hint style="warning" %}
If you want to include really large models in your project, you will need to add an additional supported agent in your project settings within the Navigation System section. We recommend you this profile to ensure that all large models in our database will work correctly.

One example of  a large model in our data base is `red_dinosaur#0000.`If you try to load and run a large model, you will see the AWCharacter flickering at the spawning point trying to find a path.&#x20;

If you only need static models, you can skip this warning. This topic only affects animated models.

If you need more information about the navigation system in unreal, you can consult it in its documentation. [https://docs.unrealengine.com/5.0/en-US/navigation-system-in-unreal-engine/](https://docs.unrealengine.com/5.0/en-US/navigation-system-in-unreal-engine/)
{% endhint %}

<figure><img src="https://588284853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_f9MEtTx5q1bKIGvl-%2Fuploads%2F5muzzrEXP9tdbQ9Hes9c%2Fadd%20supported%20agents.PNG?alt=media&#x26;token=1bf8a739-3f60-421c-80ee-bdd7bda4ef6d" alt=""><figcaption><p>Project Settings, Navigation System - Agents</p></figcaption></figure>

<figure><img src="https://588284853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_f9MEtTx5q1bKIGvl-%2Fuploads%2FOrZYSpeVrnYdgzMSxzJE%2FlargeModelsAgent.PNG?alt=media&#x26;token=8facf025-1a90-4f38-bae7-5ad705881c3e" alt=""><figcaption><p>Large Models agent profile</p></figcaption></figure>

### Check out the[ Unreal Plugin Codebase: Intro and FAQs](https://anything-world.gitbook.io/anything-world/~/changes/qJerPYmdDjrB4JWorym2/unreal/unreal-plugin-codebase-intro-and-faqs) to learn more!

{% hint style="info" %}


####
{% endhint %}

<figure><img src="https://588284853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_f9MEtTx5q1bKIGvl-%2Fuploads%2FYGRwyE8Yb1McGQASEa6N%2Fadd%20supported%20agents.PNG?alt=media&#x26;token=9255e72a-aa3d-4d28-8c8c-3ecf9fe29efb" alt=""><figcaption><p>Project Settings, Navigation System - Agents</p></figcaption></figure>

<figure><img src="https://588284853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_f9MEtTx5q1bKIGvl-%2Fuploads%2FIWFHyAXRwX2z3hbVize0%2FlargeModelsAgent.PNG?alt=media&#x26;token=50f09c7a-9a79-4f01-bfc7-3286d850a5c3" alt=""><figcaption><p>Large Models Agent profile</p></figcaption></figure>
